The ValueUserOverride Component allows for the driving of a value for each user listed in _overrides
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. |
Target
|
field drive of T | Target field of the specified type, that gets driven to the override value. |
Default
|
T | The default value given to Target if no suitable override exists in _overrides
|
CreateOverrideOnWrite
|
Bool | Creates an entry in _overrides when Target is written back.
|
PersistentOverrides
|
Bool | Values in _overrides are stored with the object when it is saved
|
_overrides
|
direct SyncBag`1<Override<T>> | A list of Overrides and the corresponding users they apply to. |
Override
| Name | Type | Description |
|---|---|---|
User
|
UserRef | The User that should see Value's content inside of Target locally instead of Default's content
|
Value
|
T | The value that User should see target driven to locally.
|
UserRef
| Name | Type | Description |
|---|---|---|
User
|
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
Behavior
The _overrides bag contains a list of users and their associated values - whenever the local user matches a user entry in the bag, the associated value is driven to Target. Otherwise, Target is driven to the value in Default
CreateOverrideOnWrite allows for new users and values to be added to the bag when the driven value in Target is directly or indirectly changed by that user. If it is not enabled, the value in Target is not changeable.
Attempting to write to or otherwise cause a discrete entry to a driven field is known as Hooking it. Any Hook to the Target value is intercepted by the ValueUserOverride Component and will change the modifying user's entry in the _overrides bag. If there is no entry for the user and if CreateOverrideOnWrite is enabled, it will create an entry using the set value.