Component:AvatarUserRootOverrideAssigner: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page AvatarUserRootOverrideAssigner (Component) to Component:AvatarUserRootOverrideAssigner: Creating component Namespace
Add info
 
(One intermediate revision by one other user not shown)
Line 7: Line 7:
|Name=AvatarUserRootOverrideAssigner
|Name=AvatarUserRootOverrideAssigner
}}
}}
 
Avatar User Root Override Assigner is a component that allows for changing the user's viewpoint, the user's first person standing location, or the user's ears location. This component works if parented under a user, for that user.
<!--T:2-->
== Intoduction ==


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Override|Slot|  
|Override|Slot| The slot to relocate the user's eyes or ears to.
|Node|OverrideNode|  
|Node|'''[[#OverrideNode|OverrideNode]]'''|TypeAdv1=true| Whether to make the user's eyes, Standing position, or ears located at <code>Slot</code> without changing any slot transforms.
|_equippingSlot|'''[[Component:AvatarObjectSlot|AvatarObjectSlot]]'''|TypeAdv2=true| an Avatar Object Slot to use for handling this node.
}}
 
== OverrideNode ==
{{Table EnumValues
|Eyes|0| Make the user's view see from <code>Override</code> rather than the original position it usually is at. This however prevents looking around unless the slot is driven by the user's head rotation.
|Ears|1| make the the user gear from <code>Override</code> position and rotation (not scale) rather than from their head.
|AvatarRoot|2| Visually relocates the user's head and ears position to <code>Override</code> this makes it seem as if they were parented to the slot but without their Avatar. This is purely visual, and does not restrict looking around.
}}
}}


<!--T:4-->
<!--T:4-->
== Behavior ==
== Behavior ==
Needs to be parented under a user to work, and applies to the parent user. The component requires a slot, and an [[Component:AvatarObjectSlot|AvatarObjectSlot]]. The Avatar Object slot does not need an existing one, so best practice is to add a new Avatar Object Slot to the same Slot as this component, then put it into the <code>_equippingSlot</code> field. Also, adding the slot this component is on to <code>Override</code> allows for a self contained settup in one slot that fully works when parented to a user.


<!--T:5-->
<!--T:5-->
== Examples ==
== Examples ==
* [[User:GearBell|GearBell's]] purple pill. (Overrides viewpoint to pill when held)
* [[User:989onan|989onan's]] Camera Override masked Protogen (allows for switching to the viewpoints of previously equipped visors)


<!--T:6-->
<!--T:6-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:Components{{#translation:}}|AvatarUserRootOverrideAssigner (Component){{#translation:}}]]
[[Category:Components{{#translation:}}|Avatar User Root Override Assigner]]
[[Category:ComponentStubs]]
[[Category:Components With Nested Enums{{#translation:}}|Avatar User Root Override Assigner]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|AvatarUserRootOverrideAssigner (Component){{#translation:}}]]
[[Category:Components:Users:Common Avatar System{{#translation:}}|Avatar User Root Override Assigner]]

Latest revision as of 18:31, 7 November 2024


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


Component image 
AvatarUserRootOverrideAssigner component as seen in the Scene Inspector

Avatar User Root Override Assigner is a component that allows for changing the user's viewpoint, the user's first person standing location, or the user's ears location. This component works if parented under a user, for that user.

Usage

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.
Override Slot The slot to relocate the user's eyes or ears to.
Node OverrideNode Whether to make the user's eyes, Standing position, or ears located at Slot without changing any slot transforms.
_equippingSlot AvatarObjectSlot an Avatar Object Slot to use for handling this node.

OverrideNode

Values
Name Value Description
Eyes 0 Make the user's view see from Override rather than the original position it usually is at. This however prevents looking around unless the slot is driven by the user's head rotation.
Ears 1 make the the user gear from Override position and rotation (not scale) rather than from their head.
AvatarRoot 2 Visually relocates the user's head and ears position to Override this makes it seem as if they were parented to the slot but without their Avatar. This is purely visual, and does not restrict looking around.


Behavior

Needs to be parented under a user to work, and applies to the parent user. The component requires a slot, and an AvatarObjectSlot. The Avatar Object slot does not need an existing one, so best practice is to add a new Avatar Object Slot to the same Slot as this component, then put it into the _equippingSlot field. Also, adding the slot this component is on to Override allows for a self contained settup in one slot that fully works when parented to a user.

Examples

  • GearBell's purple pill. (Overrides viewpoint to pill when held)
  • 989onan's Camera Override masked Protogen (allows for switching to the viewpoints of previously equipped visors)


Related Components