Component:ActiveUserCloudField

Component image 

Active User Cloud Field<T> component as seen in the Scene Inspector

The ActiveUserCloudField 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.

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 path of the variable this component will read, for the current 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	T	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	direct RelayRef`1<IField`1<T>>	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 ¹
  • Anyone ²

• 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 ³
  • Anyone ⁴

<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.
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.</sub>

Examples

Having an item where it changes to the user's color set on the cloud.

See Also

• Component:ActiveUserCloudValueVariable