|
|
| (3 intermediate revisions by 2 users not shown) |
| Line 1: |
Line 1: |
| <languages></languages>
| | #REDIRECT [[Component:ActiveUserCloudField]] |
| <translate>
| |
| <!--T:1-->
| |
| {{Infobox Component
| |
| |Image=ActiveUserCloudField`1Component.png
| |
| |Name=Active User Cloud Field`1
| |
| }}
| |
| The '''ActiveUserCloudField`1''' Component binds to the [[IField`1|field]] specified by <code>Target</code>. If <code>IsLinkedToCloud</code> is true, it will write the value of the [[Cloud_Variables| cloud variable]] defined by <code>Path</code> for the [[Active_User|active user]] of the slot it is attached to.
| |
| | |
| <!--T:2-->
| |
| == Fields ==
| |
| {{Table ComponentFields
| |
| |Path|String| The [[Cloud_Variables#Cloud_Variable_Definition| path]] of the variable this component will read, for the current [[Active_User|active user]]
| |
| |IsLinkedToCloud|Bool| ''(Read Only))'' Indicates whether this field was successfully bound to the target variable.
| |
| |UpdateCloudVariable|Bool| Indicates that this variable should update the value in the cloud when it is written or driven to a different value.
| |
| |FallbackValue|Float| Default value if there is no current active user. If the active user's value isn't set, the definition default will be used instead.
| |
| |Target|IField`1|TypeString4=IField<float>| The target [[IField`1| field]] to which the variable value will be written.
| |
| }}
| |
| | |
| <!--T:3-->
| |
| == Usage ==
| |
| For this component to function, the [[Cloud_Variables#Permissions| cloud variable permissions]] must be set to something suitably permissive for it to function properly.
| |
| * If the variable should update on the cloud when a user interacts with the object in some way, '''Write Permissions''' should be set to one of the following:
| |
| ** variable_owner_unsafe
| |
| ** variable_owner_only_contacts_unsafe <sup>1</sup>
| |
| ** Anyone <sup>2</sup>
| |
| | |
| <!--T:4-->
| |
| * If the variable should update on the cloud when a user interacts with the object in some way, '''Read Permissions''' should be set to one of the following:
| |
| ** variable_owner_unsafe
| |
| ** variable_owner_only_contacts_unsafe <sup>3</sup>
| |
| ** Anyone <sup>4</sup>
| |
| <sub>
| |
| 1. This permission results in only contacts of the variable owner being able to change a value. It also allows contacts to change each others values, which may not be desired.
| |
| <br>
| |
| 2. This permission is only valid for group variable definitions, and allows anyone to write the value of anyone else, which might have unintended consequences.
| |
| <br>
| |
| 3. This permission results in only contacts of the variable owner being able to read a value, however the value is read by the active user and synced normally to everyone else in a session, making this detail irrelevant.
| |
| <br>
| |
| 4. This permission is only valid for group variable definitions, and allows anyone to read the value of anyone else, however the value is read by the active user and synced normally to everyone else in a session, making this detail irrelevant.
| |
| </sub>
| |
| | |
| <!--T:5-->
| |
| == Examples ==
| |
| Having an item where it changes to the user's color set on the cloud.
| |
| | |
| <!--T:6-->
| |
| == Related Components ==
| |
| </translate>
| |
| [[Category:Generics{{#translation:}}]]
| |
| [[Category:Components{{#translation:}}|Active User Cloud Field`1]]
| |
| [[Category:Components:Cloud:Variables{{#translation:}}|Active User Cloud Field`1]]
| |
