(2 intermediate revisions by one other user not shown)
Line 2:
Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CloudValueField`1Component.png
|Image=CloudValueField`1Component.png
|Name=Cloud Value Field`1
|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-->
<!--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]].
|Target|IField`1|TypeString4=IField<float>|
|Target|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<T>}}|TypeAdv4=true| The target [[Type:IField`1| field]] to which the variable value will be written.
}}
}}
<!--T:3-->
<!--T:3-->
== Usage ==
== 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-->
<!--T:4-->
Line 25:
Line 31:
<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Cloud Variables]]
* [[Component:CloudValueVariable]]
* [[Component:ActiveUserCloudField]]
* [[Component:ActiveUserCloudValueVariable]]
* [[Component:CloudValueVariableDriver]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Cloud Value Field`1]]
[[Category:Components{{#translation:}}|Cloud Value Field`1]]
[[Category:Generic Components{{#translation:}}|Cloud Value Field`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Field`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Field`1]]
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.
