Component:AvatarUserPositioner: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page AvatarUserPositioner (Component) to Component:AvatarUserPositioner: Creating component Namespace
Automated: update Fields
 
(One intermediate revision by one other user not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AvatarUserPositionerComponent.png
|Image=AvatarUserPositionerComponent.png
|Name=Avatar User Positioner
|Name=Avatar User Positioner
}}
}}
The '''AvatarUserPositioner''' component is used to position a user to the avatar upon equipping the avatar.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|PositionNode|UserNode|
|PositionNode|'''[[Component:UserRoot#UserNode|UserRoot.UserNode]]'''|TypeAdv0=true| What node to use to match the position of the user.
|RotationNode|UserNode|
|RotationNode|'''[[Component:UserRoot#UserNode|UserRoot.UserNode]]'''|TypeAdv1=true| What node to use to match the rotation of the user.
|PositionReference|Slot|
|PositionReference|Slot| The slot to position the user to instead of the slot this component is on when they equip the user.
|RotationReference|Slot|
|RotationReference|Slot| The slot to rotate the user to instead of the slot this component is on when they equip the user.
|PreserveUp|Bool|
|PreserveUp|Bool| Whether to upright the user when they equip the avatar, or set them to the rotation this avatar is in when equipping.
|OnManualEquipOnly|Bool|
|OnManualEquipOnly|Bool| Whether to trigger this positioner only when the user clicks on the avatar to equip it rather than also triggering when the avatar is equipped through flux.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{stub}}


<!--T:4-->
<!--T:4-->
Line 26: Line 27:


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Avatar User Positioner]]
[[Category:Components{{#translation:}}|Avatar User Positioner]]
[[Category:Components:Uncategorized{{#translation:}}|Avatar User Positioner]]
[[Category:Components:Uncategorized{{#translation:}}|Avatar User Positioner]]

Latest revision as of 22:38, 17 March 2025

Component image 
Avatar User Positioner component as seen in the Scene Inspector

The AvatarUserPositioner component is used to position a user to the avatar upon equipping the avatar.

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.
PositionNode UserRoot.UserNode What node to use to match the position of the user.
RotationNode UserRoot.UserNode What node to use to match the rotation of the user.
PositionReference Slot The slot to position the user to instead of the slot this component is on when they equip the user.
RotationReference Slot The slot to rotate the user to instead of the slot this component is on when they equip the user.
PreserveUp Bool Whether to upright the user when they equip the avatar, or set them to the rotation this avatar is in when equipping.
OnManualEquipOnly Bool Whether to trigger this positioner only when the user clicks on the avatar to equip it rather than also triggering when the avatar is equipped through flux.

Usage

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


Examples

See Also