The '''ValueUserOverride''' Component allows for the driving of a value for each user listed in <code>_overrides</code>
{{Infobox Component
{{Infobox Component
|Image=ValueUserOverride`1Component.png
|Image=ValueUserOverride`1Component.png
|Name=ValueUserOverride
|Name=ValueUserOverride
}}
}}
== Intoduction ==
The '''ValueUserOverride''' Component allows for the driving of a value for each user listed in <code>_overrides</code>
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv0=true| Target field of the specified type, that gets driven to the override value.
|Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv0=true| Target field of the specified type, that gets driven to the override value.
Line 16:
Line 16:
|_overrides|{{RootFieldType|SyncBag`1|[[#Override|Override]]<T>}}|TypeAdv4=true| A list of Overrides and the corresponding users they apply to.
|_overrides|{{RootFieldType|SyncBag`1|[[#Override|Override]]<T>}}|TypeAdv4=true| A list of Overrides and the corresponding users they apply to.
}}
}}
== Override ==
{{Table TypeFields
|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|'''T'''|TypeAdv1=true| The value that <code>User</code> should see target driven to locally.
}}
== UserRef ==
{{Table TypeFields
|User|User| 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.
}}
== Usage ==
== Behavior ==
== Behavior ==
The <code>_overrides</code> 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 <code>Target</code>. Otherwise, <code>Target</code> is driven to the value in <code>Default</code>
The <code>_overrides</code> 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 <code>Target</code>. Otherwise, <code>Target</code> is driven to the value in <code>Default</code>
Line 22:
Line 39:
Attempting to write to or otherwise cause a discrete entry to a driven field is known as Hooking it. Any Hook to the <code>Target</code> value is intercepted by the '''ValueUserOverride''' Component and will change the modifying user's entry in the <code>_overrides</code> bag. If there is no entry for the user and if <code>CreateOverrideOnWrite</code> is enabled, it will create an entry using the set value.
Attempting to write to or otherwise cause a discrete entry to a driven field is known as Hooking it. Any Hook to the <code>Target</code> value is intercepted by the '''ValueUserOverride''' Component and will change the modifying user's entry in the <code>_overrides</code> bag. If there is no entry for the user and if <code>CreateOverrideOnWrite</code> is enabled, it will create an entry using the set value.
== Examples ==
== Examples ==
* [https://www.youtube.com/watch?v=aER4oQ9FwSE ValueUserOverride for Local World State] by [[User:ProbablePrime|ProbablePrime]]
* [https://www.youtube.com/watch?v=aER4oQ9FwSE ValueUserOverride for Local World State] by [[User:ProbablePrime|ProbablePrime]]
Revision as of 15:43, 1 May 2024
The ValueUserOverride Component allows for the driving of a value for each user listed in _overrides
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.
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.
