Component:CloudValueField: Difference between revisions

From Resonite Wiki
duplicate
Tag: New redirect
move from `1
Tag: Removed redirect
 
Line 1: Line 1:
#REDIRECT[[Component:CloudValueField`1]]
<languages></languages>
<translate>
<!--T:1-->
{{Infobox Component
|Image=CloudValueField`1Component.png
|Name=CloudValueField<T>
}}
 
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]].
 
<!--T:2-->
== Fields ==
{{Table ComponentFields
|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| The UserID of the user that made a definition for the variable specified by <code>Path</code>
|ChangeHandling|CloudVariableChangeMode| See [[Type:CloudVariableChangeMode|Cloud Variable Change Mode]].
|Target|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv4=true| The target [[Type:IField`1| field]] to which the variable value will be written.
}}
 
<!--T:3-->
== Usage ==
Put this component on a slot, and give it a valid cloud variable <code>Path</code> and <code>VariableOwnerId</code>. When given a <code>Target</code>, the contents of the field given to <code>Target</code> will auto update with the cloud variable value. Depending on the value of <code>ChangeHandling</code> and <code>VariableOwnerId</code>, 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.
 
<!--T:4-->
== Examples ==
 
<!--T:5-->
== See Also ==
* [[Cloud Variables]]
* [[Component:CloudValueVariable]]
* [[Component:ActiveUserCloudField]]
* [[Component:ActiveUserCloudValueVariable]]
* [[Component:CloudValueVariableDriver]]
</translate>
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Cloud Value Field`1]]
[[Category:Generic Components{{#translation:}}|Cloud Value Field`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Field`1]]

Latest revision as of 12:24, 11 November 2024

Component 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
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.
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.

Examples

See Also