Difference between revisions of "ActiveUserCloudValueVariable`1 (Component)"
Jump to navigation
Jump to search
(Wrote usage and description.) |
|||
Line 7: | Line 7: | ||
|Name=Active User Cloud Value Variable`1 | |Name=Active User Cloud Value Variable`1 | ||
}} | }} | ||
+ | |||
+ | 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. | ||
<!--T:2--> | <!--T:2--> | ||
Line 15: | Line 17: | ||
|UpdateCloudVariable|Bool| Indicates that this variable should update the value in the cloud when it is written or driven to a different value. | |UpdateCloudVariable|Bool| Indicates that this variable should update the value in the cloud when it is written or driven to a different value. | ||
|FallbackValue|Float| 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. | |FallbackValue|Float| 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|Float| | + | |Value|Float| The value from the cloud variable. |
}} | }} | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == 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--> | <!--T:4--> |
Latest revision as of 11:38, 27 December 2021
This article or section is a Stub. You can help the Neos Wiki by expanding it.
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.
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
|
Float | 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
|
Float | 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.