Component:UserInterfacePositioner: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
Automated: update Fields, Categories
add remaining info
 
Line 1: Line 1:
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=UserInterfacePositionerComponent.png
|Image=UserInterfacePositionerComponent.png
|Name=User Interface Positioner
|Name=User Interface Positioner
}}
}}
 
The '''UserInterfacePositioner''' component causes the slot to which it is attached to track the user's position and rotation (optionally head). This is a somewhat nicer and cleaner alternative than parenting a slot directly to a user's [[Avatar|avatar node]].
The '''UserInterfacePositioner''' causes the slot to which it is attached to track the user's head position and rotation. This is a somewhat nicer and cleaner alternative than parenting a slot directly to a user's [[Avatar|avatar node]].


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetUser|{{RootFieldType|UserRef}}|TypeAdv0=true|
|TargetUser|{{RootFieldType|UserRef}}|TypeAdv0=true| The user to track.
|UseHead|Bool|
|UseHead|Bool| Whether to track to the user's head.
|RotateVerticalOnly|Bool| {{stub}}
|RotateVerticalOnly|Bool| Whether to act like the freeform dash or not.
|PositionSpeed|Float| The speed at which the object will track the user's position.
|PositionSpeed|Float| The speed at which the object will track the user's position.
|RotationSpeed|Float| The speed at which the object will track the user's rotation.
|RotationSpeed|Float| The speed at which the object will track the user's rotation.
|ActivationDistance|Float| The distance from the user to the object at which the object will start tracking the user's position and rotation.  Zero means "always track".
|ActivationDistance|Float| The distance from the user to the object at which the object will start tracking the user's position and rotation.  Zero means "always track".
|ActivationAngle|Float| The angle between the user and the object at which the object will start tracking the user's position and rotation. Zero means "always track".
|ActivationAngle|Float| The angle between the user and the object at which the object will start tracking the user's position and rotation. Zero means "always track".
|DeactivationDistance|Float| {{stub}}
|DeactivationDistance|Float| How far away the user has to be from the component for it to to stop following.
|DeactivationAngle|Float| {{stub}}
|DeactivationAngle|Float| How much of an angle deviation it has to be for it to stop following.
|TargetPosition|Float3| {{stub}}
|TargetPosition|Float3| The target position this UI is lerping to.
|TargetRotation|FloatQ| {{stub}}
|TargetRotation|FloatQ| The target rotation this UI is lerping to.
|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv11=true| {{stub}}
|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv11=true| The field to drive to set the position of this UI.
|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv12=true| {{stub}}
|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv12=true| The field to drive to set the rotation of this UI.
}}
}}


Line 34: Line 32:
{{stub}}
{{stub}}


[[Category:ComponentStubs]]
== See Also ==
 
[[Category:Components:Transform:Drivers{{#translation:}}|User Interface Positioner]]
[[Category:Components:Transform:Drivers{{#translation:}}|User Interface Positioner]]
[[Category:Components{{#translation:}}|User Interface Positioner]]
[[Category:Components{{#translation:}}|User Interface Positioner]]

Latest revision as of 17:43, 6 February 2025

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

The UserInterfacePositioner component causes the slot to which it is attached to track the user's position and rotation (optionally head). This is a somewhat nicer and cleaner alternative than parenting a slot directly to a user's avatar node.

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.
TargetUser direct UserRef The user to track.
UseHead Bool Whether to track to the user's head.
RotateVerticalOnly Bool Whether to act like the freeform dash or not.
PositionSpeed Float The speed at which the object will track the user's position.
RotationSpeed Float The speed at which the object will track the user's rotation.
ActivationDistance Float The distance from the user to the object at which the object will start tracking the user's position and rotation. Zero means "always track".
ActivationAngle Float The angle between the user and the object at which the object will start tracking the user's position and rotation. Zero means "always track".
DeactivationDistance Float How far away the user has to be from the component for it to to stop following.
DeactivationAngle Float How much of an angle deviation it has to be for it to stop following.
TargetPosition Float3 The target position this UI is lerping to.
TargetRotation FloatQ The target rotation this UI is lerping to.
_position field drive of Float3 The field to drive to set the position of this UI.
_rotation field drive of FloatQ The field to drive to set the rotation of this UI.

Usage

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

Examples

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

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:UserInterfacePositioner&oldid=95827"