TheAutopilot (talk | contribs) m fixed links to IFIeld`1 |
added some info |
||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=CloudValueVariableDriver`1Component.png | |Image=CloudValueVariableDriver`1Component.png | ||
|Name=Cloud Value Variable Driver`1 | |Name=Cloud Value Variable Driver`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 drives <code>Target</code> to the cloud value read, or drives it to <code>FallbackValue</code> if not found. | |||
<!--T:2--> | <!--T:2--> | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Path|String| The [[Cloud_Variables#Cloud_Variable_Definition| path]] of the variable this component will read | |Path|String| The [[Cloud_Variables#Cloud_Variable_Definition| path]] of the variable this component will read. | ||
|Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv1=true| The target [[Type:IField`1| field]] to which the variable value will be written. | |Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv1=true| The target [[Type:IField`1| field]] to which the variable value will be written. | ||
|IsLinkedToCloud| | |IsLinkedToCloud|Bool| ''(Read Only)'' Indicates whether this field was successfully bound to the target variable. | ||
|WriteBack|Bool| Updates the value in the cloud when the driven field is changed. | |WriteBack|Bool| Updates the value in the cloud when the driven field is changed. | ||
|FallbackValue|'''T'''|TypeAdv4=true| Default value if there is no current active user. If the | |FallbackValue|'''T'''|TypeAdv4=true| Default value if there is no current active user or <code>OverrideOwner</code>. If the user's value isn't set, the definition default will be used instead. | ||
|OverrideOwner|String| | |OverrideOwner|String| The UserID of the user that made a definition for the variable specified by <code>Path</code>, or active user if not specified. | ||
}} | }} | ||
Line 28: | Line 33: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Generics{{#translation:}}]] | [[Category:Generics{{#translation:}}]] | ||
[[Category:Components{{#translation:}}|Cloud Value Variable Driver`1]] | [[Category:Components{{#translation:}}|Cloud Value Variable Driver`1]] | ||
[[Category:Generic Components{{#translation:}}|Cloud Value Variable Driver`1]] | [[Category:Generic Components{{#translation:}}|Cloud Value Variable Driver`1]] | ||
[[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Variable Driver`1]] | [[Category:Components:Cloud:Variables{{#translation:}}|Cloud Value Variable Driver`1]] |
Revision as of 19:00, 15 October 2024
Component image
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 drives Target
to the cloud value read, or drives it to FallbackValue
if not found.
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. |
Target
|
field drive of T | The target field to which the variable value will be written. |
IsLinkedToCloud
|
Bool | (Read Only) Indicates whether this field was successfully bound to the target variable. |
WriteBack
|
Bool | Updates the value in the cloud when the driven field is changed. |
FallbackValue
|
T | Default value if there is no current active user or OverrideOwner . If the user's value isn't set, the definition default will be used instead.
|
OverrideOwner
|
String | The UserID of the user that made a definition for the variable specified by Path , or active user if not specified.
|