Component:CloudValueField

CollapseComponent image 

CloudValueField<T> component as seen in the Scene Inspector

The CloudValueField<T> component links a field of type T to a cloud variable.

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

Fields

Fields Collapse

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. Some components stop their functionality when this field is disabled, but some don't.
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.
Target	direct RelayRef`1<IField`1<T>>	The target field to which the variable value will be written.

Usage

Put this component on a slot, and give it a valid cloud variable Path and VariableOwnerId. When given a Target, the contents of the field given to Target will auto update with the cloud variable value. Depending on the value of ChangeHandling and VariableOwnerId, the cloud variable may be updated through this component 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.

See Also

• Cloud Variables
• Component:CloudValueVariable
• Component:ActiveUserCloudField
• Component:ActiveUserCloudValueVariable
• Component:CloudValueVariableDriver