Component:CloudValueField: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page CloudValueField (Component) to Component:CloudValueField: Creating component Namespace
add info
Line 7: Line 7:
|Name=Cloud Value Field`1
|Name=Cloud Value Field`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 contents of the field specified by <code>Target</code> to the value of the specified cloud variable.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Path|String|
|Path|String| The cloud variable path to read from, this needs to start with a UserID.
|IsLinkedToCloud|Bool|
|IsLinkedToCloud|Bool| Whether the variable exists or not.
|VariableOwnerId|String|
|VariableOwnerId|String| The UserID of the user that created the variable.
|ChangeHandling|CloudVariableChangeMode|
|ChangeHandling|CloudVariableChangeMode| See [[Type:CloudVariableChangeMode|Cloud Variable Change Mode]].
|Target|IField`1|TypeString4=IField<float>|
|Target|IField`1|TypeString4=IField<float>| The field which to change the contents of to the value of the cloud variable.
}}
}}


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


<!--T:4-->
<!--T:4-->
Line 27: Line 33:
== Related Components ==
== Related Components ==
</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:Components:Cloud:Variables{{#translation:}}|Cloud Value Field`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Field`1]]

Revision as of 18:43, 15 October 2024


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


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 cloud variable path to read from, this needs to start with a UserID.
IsLinkedToCloud Bool Whether the variable exists or not.
VariableOwnerId String The UserID of the user that created the variable.
ChangeHandling CloudVariableChangeMode See Cloud Variable Change Mode.
Target IField<float> The field which to change the contents of to the value of the cloud variable.

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