IUiVariable

16.9 Interface

Inheritance 17 descendants

IUiVariablecurrent

Class Documentation

A UI variable: an observable value that UI data holds. Each concrete class holds one value of its kind: a bool, an int, a float, a string, an image file, an object of nested variables or a list of such objects.

Variables sit in maps keyed by hash, such as UiComponent.VariableDefaults, the per-instance variable map of a UiElementComponentInstanceData, and the VariableValues of an object or list item. They can also be standalone bin objects that a Variables list links.

Registration. When the client registers a variable from a map, it writes the map key into SchemaFieldId. For an object variable it then registers the nested variables of the object, and for a list variable the nested variables of every item.

Change notification. Each variable keeps a list of listeners and a list of callbacks. When the client copies a new value into a variable, it notifies every listener and runs every callback.

Lookup. A lookup by a path of hashes walks the nested UiVariableObject values, one key per level. A list UI element that is bound to a UiVariableList receives the items of the list.

Properties

SchemaFieldId

Hash

16.17

Documentation Edit documentation

The key of the variable. For a variable in a map, the client writes the map key here when it registers the variable. Lookups of standalone variables compare against this value.

name

String

Removed in 16.17

Documentation Add documentation

No documentation available yet. Click "Add documentation" to contribute!

Referenced by 5 classes · 5 properties

0x38a7923b Variables List2<IUiVariable>
0x3b8d8b3f VariableValues Map<Hash, IUiVariable>
0x4b7b05df Variables List2<IUiVariable>
UiComponent VariableDefaults Map<Hash, IUiVariable>
UiElementComponentInstanceData 0xa9f110a Map<Hash, IUiVariable>