(One intermediate revision by one other user not shown)
Line 2:
Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CloudValueVariable`1Component.png
|Image=CloudValueVariable`1Component.png
|Name=Cloud Value Variable`1
|Name=CloudValueVariable<T>
}}
}}
The '''CloudValueVariable<T>''' component links the <code>Value</code> of type '''T''' on the component to a cloud variable.
For more info on how Cloud Variables work in general, see [[Cloud Variables]].
<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Path|String|
|Path|String| The [[Cloud_Variables#Cloud_Variable_Definition| path]] of the variable this component will read.
|IsLinkedToCloud|Bool|
|IsLinkedToCloud|Bool| ''(Read Only)'' Indicates whether this field was successfully bound to the target variable.
|VariableOwnerId|String|
|VariableOwnerId|String| The UserID of the user that made a definition for the variable specified by <code>Path</code>
|ChangeHandling|CloudVariableChangeMode|
|ChangeHandling|CloudVariableChangeMode| See [[Type:CloudVariableChangeMode|Cloud Variable Change Mode]].
|Value|Float|
|Value|'''T'''|TypeAdv4=true| The value of the read cloud variable.
}}
}}
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Upon being given a valid cloud variable <code>Path</code> and <code>VariableOwnerId</code>, the value in the <code>Value</code> field will be updated to reflect the value of the cloud variable. Depending on the value of <code>ChangeHandling</code> and <code>VariableOwnerId</code>, the cloud variable may be updated by writing to the <code>Value</code> 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.
<!--T:4-->
<!--T:4-->
Line 25:
Line 31:
<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Cloud Variables]]
* [[Component:CloudValueField]]
* [[Component:ActiveUserCloudField]]
* [[Component:ActiveUserCloudValueVariable]]
* [[Component:CloudValueVariableDriver]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Cloud Value Variable`1]]
[[Category:Components{{#translation:}}|Cloud Value Variable`1]]
[[Category:Generic Components{{#translation:}}|Cloud Value Variable`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Variable`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Variable`1]]
Latest revision as of 19:17, 11 November 2024
Component image
CloudValueVariable<T> component as seen in the Scene Inspector
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.
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.
