Component:LocomotionAnimationHandMetrics: Difference between revisions

Revision as of 23:02, 23 January 2025

Component image

**Locomotion Animation Hand Metrics** component as seen in the Scene Inspector

The LocomotionAnimationHandMetrics component can be used to adjust the settings on the hands for an avatar for its rest state.

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.
`ShoulderSeparation`	Nullable`1<Float>	An optional value to specify how apart the shoulders are in local space meters.
`HandOffset`	Nullable`1<Float>	An optional value to specify how far the hands should be offseted from the avatar center in local space meters.
`ShoulderHeight`	Nullable`1<Float>	An optional value to specify how far the shoulders are from the ground in local space meters.
`ArmLength`	Nullable`1<Float>	An optional value to specify how long the arms are in local space meters.
`HandPalmDistance`	Nullable`1<Float>	An optional value to specify how long the palms are in local space meters.

Usage

Can be used to adjust the arms rest state so they don't collide with the legs or hips too much.

Examples

Found on the root of avatars set up with the Avatar Creator.

@@ Line 3: / Line 3: @@
 |Name=Locomotion Animation Hand Metrics
 }}
-{{stub}}
+The '''LocomotionAnimationHandMetrics''' component can be used to adjust the settings on the hands for an avatar for its rest state.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|ShoulderSeparation|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv0=true|
+|ShoulderSeparation|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv0=true| An optional value to specify how apart the shoulders are in local space meters.
-|HandOffset|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv1=true|
+|HandOffset|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv1=true| An optional value to specify how far the hands should be offseted from the avatar center in local space meters.
-|ShoulderHeight|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv2=true|
+|ShoulderHeight|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv2=true| An optional value to specify how far the shoulders are from the ground in local space meters.
-|ArmLength|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv3=true|
+|ArmLength|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv3=true| An optional value to specify how long the arms are in local space meters.
-|HandPalmDistance|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv4=true|
+|HandPalmDistance|'''[[Type:Nullable`1|Nullable`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv4=true| An optional value to specify how long the palms are in local space meters.
 }}
-== Behavior ==
+== Usage ==
+Can be used to adjust the arms rest state so they don't collide with the legs or hips too much.
 == Examples ==
+Found on the root of avatars set up with the [[Avatar Creator]].
 == See Also ==
+* [[Component:LocomotionAnimationFeetMetrics|Component:Locomotion Animation Feet Metrics]]
 [[Category:Components:Users:Common Avatar System:Animation{{#translation:}}|Locomotion Animation Hand Metrics]]
 [[Category:Components{{#translation:}}|Locomotion Animation Hand Metrics]]
-[[Category:ComponentStubs]]