Component:CloudValueVariable`1: Difference between revisions

Revision as of 18:55, 15 October 2024

Component image

**Cloud Value Variable`1** component as seen in the Scene Inspector

For more info on how Cloud Variables work in general, see Cloud Variables.

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.

This component constantly writes the value from the cloud to 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.
`IsLinkedToCloud`	Bool	(Read Only) Indicates whether this field was successfully bound to the target variable.
`VariableOwnerId`	String	The UserID of the user that made a definition for the variable specified by `Path`
`ChangeHandling`	CloudVariableChangeMode	See Cloud Variable Change Mode.
`Value`	T	The value of the read cloud variable.

Usage

Examples

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=CloudValueVariable`1Component.png
 |Name=Cloud Value Variable`1
 }}
+For more info on how Cloud Variables work in general, see [[Cloud Variables]].
+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.
+This component constantly writes the value from the cloud to <code>Value</code>.
 <!--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]]
+|Path|String| The [[Cloud_Variables#Cloud_Variable_Definition| path]] of the variable this component will read.
 |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|'''T'''|TypeAdv4=true|
+|Value|'''T'''|TypeAdv4=true| The value of the read cloud variable.
 }}
@@ Line 27: / Line 32: @@
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Generics{{#translation:}}]]
 [[Category:Components{{#translation:}}|Cloud Value Variable`1]]
 [[Category:Generic Components{{#translation:}}|Cloud Value Variable`1]]
 [[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Variable`1]]