Component:AvatarManager: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
Add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarManagerComponent.png
|Image=AvatarManagerComponent.png
|Name=AvatarManager
|Name=AvatarManager
}}
}}
 
The '''AvatarManager''' component is found on User root slots and is used to manage avatars equipped to a particular user. It also keeps track of and sets the equipped parameters of [[Component:AvatarObjectSlot]]s under an avatar, It manages the setting of fields on the [[Component:AvatarRoot]] and [[Component:AvatarGroup]] components.
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_objectGroups|{{RootFieldType|SyncList`1|[[#EquippedGroup|EquippedGroup]]}}|TypeAdv0=true|
|_objectGroups|{{RootFieldType|SyncList`1|[[#EquippedGroup|EquippedGroup]]}}|TypeAdv0=true| A list of objects currently equipped by the user as part of an avatar.
|_currentAnchor|{{RootFieldType|LinkRef`1|[[Component:AvatarAnchor|AvatarAnchor]]}}|TypeAdv1=true|
|_currentAnchor|{{RootFieldType|LinkRef`1|[[Component:AvatarAnchor|AvatarAnchor]]}}|TypeAdv1=true| The anchor the user associated with this component is currently sitting in.
|AutoAddNameBadge|Bool|
|AutoAddNameBadge|Bool| Whether to auto add the name badge component if it doesn't exist on an avatar when equipping it. Usually managed by the world through the [[Component:CommonAvatarBuilder]]
|AutoAddIconBadge|Bool|
|AutoAddIconBadge|Bool| Whet
|AutoAddLiveIndicator|Bool|
|AutoAddLiveIndicator|Bool|
|EmptySlotHandler|IEmptyAvatarSlotHandler|
|EmptySlotHandler|IEmptyAvatarSlotHandler| The object to handle empty avatar slots. Usually defined by the world through the [[Component:CommonAvatarBuilder]].
|DefaultScale|Float|
|DefaultScale|Float| The default scale multiplier of the avatar currently equipped
|NameTagText|String|
|NameTagText|String| The text that should be assigned to the avatar nametag's text field list
|NameTagColor|ColorX|
|NameTagColor|ColorX| The color that should be assigned to the avatar nametag's color list.
|NameTagOutline|ColorX|
|NameTagOutline|ColorX| The color that should be assigned to the avatar nametag's color1 list.
|NameTagBackground|ColorX|
|NameTagBackground|ColorX| The color.that should be assigned to the avatar nametag's color background list.
|_badgeTemplates|Slot|
|_badgeTemplates|Slot| the slot that was made for the user for storage of their badges.
|_autoNameBadge|Slot|
|_autoNameBadge|Slot| the slot that was made for the user for their name badge.
|_autoIconBadge|Slot|
|_autoIconBadge|Slot| the slot that was made for the user for their Icon.
|_autoLiveIndicator|Slot|
|_autoLiveIndicator|Slot| The slot that was made for the user for their live indicator
|_updateVersion|Int|
|_updateVersion|Int| Internal.
}}
 
== EquippedGroup ==
Equipped group is internally handled as a type to hold data from a Dictionary&lt;[[Component:AvatarRoot]], {{RootFieldType|SyncList`1|[[Component:AvatarObjectSlot]]}}&gt;
 
{{Table TypeFields
|Root|[[Component:AvatarRoot|AvatarRoot]]|TypeAdv0=true| The avatar root associated with the currently equipped avatar.
|ObjectSlots|{{RootFieldType|SyncList`1|[[Component:AvatarObjectSlot]]}}|TypeAdv1=true| The list of currently equipped object nodes associated with <code>Root</code>.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
Should not be used directly by the player, since this is used by the game instead to manage avatars on a user.


<!--T:5-->
<!--T:5-->
Line 39: Line 45:


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

Latest revision as of 14:45, 11 November 2024

Component image 
AvatarManager component as seen in the Scene Inspector

The AvatarManager component is found on User root slots and is used to manage avatars equipped to a particular user. It also keeps track of and sets the equipped parameters of Component:AvatarObjectSlots under an avatar, It manages the setting of fields on the Component:AvatarRoot and Component:AvatarGroup components.

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.
_objectGroups list of EquippedGroup A list of objects currently equipped by the user as part of an avatar.
_currentAnchor direct LinkRef`1<AvatarAnchor> The anchor the user associated with this component is currently sitting in.
AutoAddNameBadge Bool Whether to auto add the name badge component if it doesn't exist on an avatar when equipping it. Usually managed by the world through the Component:CommonAvatarBuilder
AutoAddIconBadge Bool Whet
AutoAddLiveIndicator Bool
EmptySlotHandler IEmptyAvatarSlotHandler The object to handle empty avatar slots. Usually defined by the world through the Component:CommonAvatarBuilder.
DefaultScale Float The default scale multiplier of the avatar currently equipped
NameTagText String The text that should be assigned to the avatar nametag's text field list
NameTagColor ColorX The color that should be assigned to the avatar nametag's color list.
NameTagOutline ColorX The color that should be assigned to the avatar nametag's color1 list.
NameTagBackground ColorX The color.that should be assigned to the avatar nametag's color background list.
_badgeTemplates Slot the slot that was made for the user for storage of their badges.
_autoNameBadge Slot the slot that was made for the user for their name badge.
_autoIconBadge Slot the slot that was made for the user for their Icon.
_autoLiveIndicator Slot The slot that was made for the user for their live indicator
_updateVersion Int Internal.

EquippedGroup

Equipped group is internally handled as a type to hold data from a Dictionary<Component:AvatarRoot, list of Component:AvatarObjectSlot>

Fields
Name Type Description
Root AvatarRoot The avatar root associated with the currently equipped avatar.
ObjectSlots list of Component:AvatarObjectSlot The list of currently equipped object nodes associated with Root.


Usage

Should not be used directly by the player, since this is used by the game instead to manage avatars on a user.

Examples

See Also