Component:AvatarRoot: Difference between revisions

From Resonite Wiki
imported>Chemicalcrux
Creating the page (with a bot!)
 
add info
 
(13 intermediate revisions by 5 users not shown)
Line 5: Line 5:
{{Infobox Component
{{Infobox Component
|Image=AvatarRootComponent.png
|Image=AvatarRootComponent.png
|Name=AvatarRoot
|Name=Avatar Root
}}
}}
For detailed information on how this functions for mix and match body parts. Please also see [[Equipping Multiple Avatars]].


<!--T:2-->
* This is generated by the [[Avatar Creator]] Dialog
== Intoduction ==
* This handles the click to equip [[context menu]] when clicking on avatars
* Appears to effectively equip to the Root [[Type:BodyNode|bodynode]]


<!--T:3-->
<!--T:3-->
== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Scale|Float3|  
|Scale|Float3| What to set the local scale of the slot this component is on to when being equipped by a user.
|_originalParent|Slot|  
|_originalParent|Slot| The slot this avatar was parented to before equipping.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|OnEquipConfirm:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user has confirmed they want to equip the avatar for this component.
|OnEquipHeldAvatar:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user has confirmed they want to equip the avatar for this component while holding it.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==


<!--T:5-->
<!--T:5-->
Line 25: Line 33:


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
* [[Component:ObjectRoot]]
</translate>
</translate>
[[Category:Components{{#translation:}}|AvatarRoot (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Avatar Root]]
[[Category:ComponentStubs]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar Root]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|AvatarRoot (Component){{#translation:}}]]

Latest revision as of 22:33, 18 March 2025


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

Component image 
Avatar Root component as seen in the Scene Inspector

For detailed information on how this functions for mix and match body parts. Please also see Equipping Multiple Avatars.

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.
Scale Float3 What to set the local scale of the slot this component is on to when being equipped by a user.
_originalParent Slot The slot this avatar was parented to before equipping.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnEquipConfirm:ButtonEventHandler ButtonEventHandler Handles when the user has confirmed they want to equip the avatar for this component.
OnEquipHeldAvatar:ButtonEventHandler ButtonEventHandler Handles when the user has confirmed they want to equip the avatar for this component while holding it.

Usage

Examples

See Also