Component:ReferenceUserOverride: Difference between revisions

Revision as of 15:34, 1 May 2024

This is a component that allows you to locally change a reference on a value. Changing the value locally for yourself or others so that an item or world element is different depending on who's viewing it.

Component image

**Reference User Override`1** component as seen in the Scene Inspector

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. Some components stop their functionality when this field is disabled, but some don't.
`Target`	direct RefDrive`1<T>	The value to drive locally for every user
`Default`	T	The content of this value will be inside of `Target` for every user locally unless otherwise specified by an Override inside of the `_overrides` bag.
`CreateOverrideOnWrite`	Bool	When flux or any other means tries to set the value of target from someone's machine, create an Override for them in `_overrides` bag.
`PersistentOverrides`	Bool	whether to save the overrides or not when the component is part of a hierarchy being saved. This is useful to turn on when an item should have overrides
`_overrides`	unordered list of Override<T>	A bag of Overrides that are read to make local changes to the value referenced by `Target`

Override

Fields
Name	Type	Description
`User`	UserRef	The User that should see `Value`'s content inside of `Target` locally instead of `Default`'s content
`Value`	SyncRef`1<T>	The value that `User` should see target driven to locally.

UserRef

Fields
Name	Type	Description
`User`	SyncRef`1<User>	The user that matches the `_machineId` and `_userId`.
`_machineId`	String	The machine id last known for a User. Is used to try to identify the user and fill `User` user ref field the next time they're in a world with this component.
`_userId`	String	The user's account ID last known for a User. Is used to try to identify the user and fill `User` user ref field the next time they're in a world with this component.

Usage

Examples

Related Components

@@ Line 20: / Line 20: @@
 == Override ==
 {{Table TypeFields
-|User|[[#UserRef|UserRef]]|TypeAdv0=true| The user that should see the below value's content inside of <code>Target</code> locally instead of <code>Default</code>'s content
+|User|[[#UserRef|UserRef]]|TypeAdv0=true| The [[Type:User|User]] that should see <code>Value</code>'s content inside of <code>Target</code> locally instead of <code>Default</code>'s content
-|Value|[[Type:SyncRef`1|SyncRef`1]]&lt;T&gt;|TypeAdv1=true| The value that the above user should see target driven to locally.
+|Value|[[Type:SyncRef`1|SyncRef`1]]&lt;T&gt;|TypeAdv1=true| The value that <code>User</code> should see target driven to locally.
 }}
 == UserRef ==
 {{Table TypeFields
-|User|[[Type:SyncRef`1|SyncRef`1]]&lt;[[Type:User|User]]&gt;|TypeAdv0=true| The user that matches the _machineId and _userId.
+|User|[[Type:SyncRef`1|SyncRef`1]]&lt;[[Type:User|User]]&gt;|TypeAdv0=true| The user that matches the <code>_machineId</code> and <code>_userId</code>.
 |_machineId|String| The machine id last known for a [[Type:User|User]]. Is used to try to identify the user and fill <code>User</code> user ref field the next time they're in a world with this component.
 |_userId|String| The user's account ID last known for a [[Type:User|User]]. Is used to try to identify the user and fill <code>User</code> user ref field the next time they're in a world with this component.