Component:AutoLookAtUser: Difference between revisions

Latest revision as of 22:30, 13 October 2024

Component image

**Auto Look At User** component as seen in the Scene Inspector

The AutoLookAtUser component can be used to make a slot rotate towards a given user or some user that is close to it.

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.
`RetargetDistance`	Float	The distance that the current target needs to be from the slot for it to pick a new target.
`LerpSpeed`	Float	The speed at which the slot rotates towards its target.
`TargetedUser`	User	The user that the slot is currently looking at.
`AutoTarget`	Bool	Whether or not the component should pick its own target.
`ExcludeActiveUser`	Bool	If this is true and the slot with this component is parented to a user, it won't look at that user.
`SwingReference`	Float3	The first axis in which to restrict rotation essentially.
`TwistReference`	Float3	The second axis in which to restrict rotation essentially, for best results, make this axis perpendicular to `SwingReference`.
`MaxSwing`	Float	How much this can rotate on the `SwingReference` axis.
`MaxTwist`	Float	How much this can rotate on the `TwistReference` axis.
`_rotation`	field drive of FloatQ	The rotation field to drive with this component's calculations. Usually this is the slot that this component is on.

Examples

This can be used to make guards that look at the user when they get close. This can also be used to make UI or nametags that look at the user, or automated turrets.

In Reality, Swing and Twist are a more complicated subject, and is best to just change the MaxSwing and MaxTwist values only until you are comfortable or learn how the reference axis's work.

Related Issues

None right now.

Related Components

@@ Line 1: / Line 1: @@
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AutoLookAtUserComponent.png
@@ Line 16: / Line 15: @@
 |AutoTarget|Bool| Whether or not the component should pick its own target.
 |ExcludeActiveUser|Bool| If this is true and the slot with this component is parented to a user, it won't look at that user.
-|SwingReference|Float3|
+|SwingReference|Float3| The first axis in which to restrict rotation essentially.
-|TwistReference|Float3|
+|TwistReference|Float3| The second axis in which to restrict rotation essentially, for best results, make this axis perpendicular to <code>SwingReference</code>.
-|MaxSwing|Float|
+|MaxSwing|Float| How much this can rotate on the <code>SwingReference</code> axis.
-|MaxTwist|Float|
+|MaxTwist|Float| How much this can rotate on the <code>TwistReference</code> axis.
-|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv9=true|
+|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv9=true| The rotation field to drive with this component's calculations. Usually this is the slot that this component is on.
 }}
-<!--T:3-->
-== Usage ==
-{{stub}}
 <!--T:4-->
 == Examples ==
-{{stub}}
+This can be used to make guards that look at the user when they get close. This can also be used to make UI or nametags that look at the user, or automated turrets.
+In Reality, Swing and Twist are a more complicated subject, and is best to just change the <code>MaxSwing</code> and <code>MaxTwist</code> values only until you are comfortable or learn how the reference axis's work.
 <!--T:5-->
 == Related Issues ==
-{{stub}}
+None right now.
 <!--T:6-->
 == Related Components ==
-[[Category:ComponentStubs]]
 [[Category:Components:Transform:Drivers{{#translation:}}|Auto Look At User]]
 [[Category:Components{{#translation:}}|Auto Look At User]]