Component:ActiveUserCloudValueVariable`1: Difference between revisions

From Resonite Wiki
imported>Psychpsyo
Wrote usage and description.
 
move to without `1
Tag: New redirect
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages></languages>
#REDIRECT[[Component:ActiveUserCloudValueVariable]]
<translate>
<!--T:1-->
{{stub}}
{{Infobox Component
|Image=ActiveUserCloudValueVariable`1Component.png
|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-->
== 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|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.
}}
 
<!--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 ==
 
<!--T:5-->
== Related Components ==
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Active User Cloud Value Variable`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Active User Cloud Value Variable`1]]

Latest revision as of 11:26, 11 November 2024