Skip to content

UIBindings

Inherits: Class

Methods

Add

lua
function UIBindings:Add(bindKey, state, stateKey)

Adds a binding.

Parameters:

NameTypeDescription
bindKeystringThe binding key
stateReactiveStateThe state to store the value in
stateKeystringThe state key to store the value at

Clear

lua
function UIBindings:Clear()

Clears all registered bindings.

Process

lua
function UIBindings:Process(bindKey, value)

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

Parameters:

NameTypeDescription
bindKeystringThe binding key to update
valueanyThe value to set

Functions

Create

lua
function UIBindings.Create()
  -> UIBindings

Creates a new UI bindings object.

Returns:

TypeDescription
UIBindings