Component:AvatarUserReferenceAssigner: Difference between revisions

From Resonite Wiki
Updated link.
add needed info
 
Line 5: Line 5:
{{Infobox Component
{{Infobox Component
|Image=AvatarUserReferenceAssignerComponent.png
|Image=AvatarUserReferenceAssignerComponent.png
|Name=AvatarUserReferenceAssigner
|Name=Avatar User Reference Assigner
}}
}}


Line 12: Line 12:


<!--T:3-->
<!--T:3-->
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|AssignMode|'''[[#Mode|Mode]]'''|TypeAdv0=true|
|AssignMode|'''[[#Mode|Mode]]'''|TypeAdv0=true| How to use the list when assigning users to User storage fields.
|References|{{RootFieldType|SyncRefList`1|[[Type:SyncRef`1|SyncRef`1]]&lt;[[Type:User|User]]&gt;}}|TypeAdv1=true|
|References|{{RootFieldType|SyncRefList`1|[[Type:SyncRef`1|SyncRef`1]]&lt;[[Type:User|User]]&gt;}}|TypeAdv1=true| The references to scan through when assigning.
}}
 
== Mode ==
{{Table EnumValues
|WhiteList|0| Assign and unassign the values of only the User storage fields specified in <code>References</code>
|AutoscanWithBlacklist|1| Assign and Unassign the values of every User storage field in the avatar hierarchy except for the ones specified in <code>References</code>
}}
}}


Line 25: Line 32:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:Components{{#translation:}}|Avatar User Reference Assigner]]
[[Category:Components{{#translation:}}|Avatar User Reference Assigner]]
[[Category:ComponentStubs]]
[[Category:Components With Nested Enums{{#translation:}}|Avatar User Reference Assigner]]
[[Category:Components With Nested Enums{{#translation:}}|Avatar User Reference Assigner]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar User Reference Assigner]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar User Reference Assigner]]

Latest revision as of 22:59, 31 December 2024


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
Avatar User Reference Assigner component as seen in the Scene Inspector


The AvatarUserReferenceAssigner component is used to assign the user reference to a list of targets (depending on the AssignMode). This component activates only when in the slot hierarchy of an Avatar and when a user equips it.

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.
AssignMode Mode How to use the list when assigning users to User storage fields.
References list of SyncRef`1<User> The references to scan through when assigning.

Mode

Values
Name Value Description
WhiteList 0 Assign and unassign the values of only the User storage fields specified in References
AutoscanWithBlacklist 1 Assign and Unassign the values of every User storage field in the avatar hierarchy except for the ones specified in References


Usage

This is often used with assigning the user reference to nameplates, and the components within.

Examples

See Also