UIBindings

It’s common to have some lower-level service code which is responding to game events to generate updates to various state values. This service code acts as a single producer of underlying state values and should be completely independent from consumers of them (i.e. different UI windows). The UIBindings class aims to provide a mechanism to allow multiple consuemrs to hook into the values being produced in this paradigm.

Example

The following demonstrates a simple usage of the UIBindings class.

-- PlayerHealthMonitor.lua
local MyModule = select(2, ...).MyModule
local PlayerHealthMonitor = MyModule:Init("PlayerHealthMonitor")
local UIBindings = MyModule:From("LibTSMReactive"):IncludeClassType("UIBindings")

local bindings = UIBindings.Create()

function PlayerHealthMonitor.BindHealthValue(state, key)
   bindings:Add("HEALTH_VAUE", state, key)
end

local function OnHealthUpdateEvent(health)
   bindings:Process("HEALTH_VALUE", health)
end

-- MyUIFile.lua
-- ...
local state = ... -- The local `ReactiveState` object with a "health" key

-- Update our local state's health value based on values from the PlayerHealthMonitor module.
PlayerHealthMonitor.BindHealthValue(state, "health")

Memory Management

The UIBindings objects are intended to never be GC’d and have a static lifecycle (i.e. one that’s equal to the lifecycle of the application), but there is nothing preventing them from being GC’d.

API

class UIBindings: Class
staticmethod Create(): UIBindings

Creates a new UI bindings object.

Add(
    self: UIBindings,
    bindKey: string,
    state: ReactiveState,
    stateKey: string
)

Adds a binding.

Parameters:

  • bindKey (string) – The binding key

  • state (ReactiveState) – The state to store the value in

  • stateKey (string) – The state key to store the value at

Clear(self: UIBindings)

Clears all registered bindings.

Process(self: UIBindings, bindKey: string, value: any)

Processes the binds for an action and updates the bound state keys.

Parameters:

  • bindKey (string) – The binding key to update

  • value (any) – The value to set