(Redirected from Component:CloudValueVariable`1)
Component image
The CloudValueVariable<T> component links the Value
of type T on the component to a cloud variable.
For more info on how Cloud Variables work in general, see Cloud Variables.
Fields
Name | Type | Description |
---|---|---|
persistent
|
Bool | Determines whether or not this item will be saved to the server. |
UpdateOrder
|
Int | Controls the order in which this component is updated. |
Enabled
|
Bool | Controls whether or not this component is enabled. |
Path
|
String | The path of the variable this component will read. |
IsLinkedToCloud
|
Bool | (Read Only) Indicates whether this field was successfully bound to the target variable. |
VariableOwnerId
|
String | The UserID of the user that made a definition for the variable specified by Path
|
ChangeHandling
|
CloudVariableChangeMode | See Cloud Variable Change Mode. |
Value
|
T | The value of the read cloud variable. |
Usage
Upon being given a valid cloud variable Path
and VariableOwnerId
, the value in the Value
field will be updated to reflect the value of the cloud variable. Depending on the value of ChangeHandling
and VariableOwnerId
, the cloud variable may be updated by writing to the Value
field as well.
This updates as fast as reading/writing cloud variables permits. All the restrictions that apply to cloud variables apply to this component, including permissions and world contexts.