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.
The '''ActiveUserCloudField`1''' Component binds to the [[Type: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-->
<!--T:2-->
Line 15:
Line 14:
|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.
|UpdateCloudVariable|Bool| Indicates that this variable should update the value in the cloud when it is written or driven to a different value.
|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.
|FallbackValue|'''T'''|TypeAdv3=true| 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.
|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.
}}
}}
Line 27:
Line 26:
** Anyone <sup>2</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:
* 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_unsafe
Line 40:
Line 40:
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.
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>
</sub>
<!--T:4-->
<!--T:5-->
== Examples ==
== Examples ==
Having an item where it changes to the user's color set on the cloud.
<!--T:5-->
<!--T:6-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Active User Cloud Field`1]]
[[Category:Components{{#translation:}}|Active User Cloud Field`1]]
[[Category:Generic Components{{#translation:}}|Active User Cloud Field`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Active User Cloud Field`1]]
[[Category:Components:Cloud:Variables{{#translation:}}|Active User Cloud Field`1]]
Latest revision as of 15:57, 9 March 2024
Component image
Active User Cloud Field`1 component as seen in the Scene Inspector
The ActiveUserCloudField`1 Component binds to the field specified by Target. If IsLinkedToCloud is true, it will write the value of the cloud variable defined by Path for the active user of the slot it is attached to.
The target field to which the variable value will be written.
Usage
For this component to function, the 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 1
Anyone 2
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 3
Anyone 4
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.
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.
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.
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.
Examples
Having an item where it changes to the user's color set on the cloud.
