Component:CloudValueField`1: Difference between revisions

From Resonite Wiki
change and add info
mistake sorry. fixed it.
Line 16: Line 16:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Path|String| The [[Cloud_Variables#Cloud_Variable_Definition| path]] of the variable this component will read. Needs to start with a UserID.
|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.
|IsLinkedToCloud|Bool| ''(Read Only)'' Indicates whether this field was successfully bound to the target variable.
|VariableOwnerId|String| The UserID of the user that created the 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]].
|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.
|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.

Revision as of 18:53, 15 October 2024

Component image 
Cloud Value Field`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 contents of the field specified by Target to the value of the specified cloud variable.

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. For how to get a valid path and id, see Cloud Variables. when given a Target, the contents of the field given to Target will auto update with the cloud variable value.

Examples

Related Components