Component:ActiveUserCloudValueVariable`1

From Resonite Wiki
Revision as of 10:35, 1 March 2024 by PJB (talk | contribs) (Automated: update component fields)
Component image 
Active User Cloud Value Variable`1 component as seen in the Scene Inspector


The ActiveUserCloudValueVariable 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.

Fields

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, for the current 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 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.

Related Components