The '''ActiveUserCloudValueVariable''' component provides a field that is synced to a cloud variable, with the user it is parented under being the owner of the value. This node follows the same rules as [[Cloud Variables]] except that it caches the quickly made changes and then updates the cloud variable with the cached changes as soon as possible using the cloud.
<!--T:2-->
== Fields ==
{{Table ComponentFields
|Path|String| The [[Cloud_Variables#Cloud_Variable_Definition| path]] of the variable this component will read, for the current [[Active_User|active user]]
|IsLinkedToCloud|Bool| ''(Read Only)'' Indicates whether this field was successfully bound to the target variable.
|UpdateCloudVariable|Bool| Indicates that this variable should update the value in the cloud when it is written or driven to a different value.
|FallbackValue|'''T'''|TypeAdv3=true| Default value if there is no current active user. If the active user's value isn't set, the definition default will be used instead.
|Value|'''T'''|TypeAdv4=true| The value from the cloud variable.
}}
<!--T:3-->
== Usage ==
To use this component, simply add it to a slot underneath a user's hierarchy and set the <code>Path</code> to the path of a cloud variable. (make sure that the variable and component are of the same type!)
The component's <code>Value</code> field will then be filled with the value from the cloud variable.
<!--T:4-->
== Examples ==
Having an item where it changes to the user's color set on the cloud.
<!--T:5-->
== See Also ==
* [[Component:ActiveUserCloudField]]
</translate>
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Active User Cloud Value Variable`1]]
[[Category:Generic Components{{#translation:}}|Active User Cloud Value Variable`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Active User Cloud Value Variable`1]]
Latest revision as of 11:25, 11 November 2024
Component image
Active User Cloud Value Variable<T> component as seen in the Scene Inspector
The ActiveUserCloudValueVariable component provides a field that is synced to a cloud variable, with the user it is parented under being the owner of the value. This node follows the same rules as Cloud Variables except that it caches the quickly made changes and then updates the cloud variable with the cached changes as soon as possible using the cloud.
Indicates that this variable should update the value in the cloud when it is written or driven to a different value.
FallbackValue
T
Default value if there is no current active user. If the active user's value isn't set, the definition default will be used instead.
Value
T
The value from the cloud variable.
Usage
To use this component, simply add it to a slot underneath a user's hierarchy and set the Path to the path of a cloud variable. (make sure that the variable and component are of the same type!)
The component's Value field will then be filled with the value from the cloud variable.
Examples
Having an item where it changes to the user's color set on the cloud.
