Automated: create new component page  | 
				 add info  | 
				||
| Line 3: | Line 3: | ||
|Name=User Pose Controller  | |Name=User Pose Controller  | ||
}}  | }}  | ||
The '''UserPoseController''' component is used to control the posing of the user.  | |||
==   | == Fields ==  | ||
{{Table ComponentFields  | {{Table ComponentFields  | ||
|ScreenController|'''[[Component:ScreenController|ScreenController]]'''|TypeAdv0=true|  | |ScreenController|'''[[Component:ScreenController|ScreenController]]'''|TypeAdv0=true| the currently used screen controller.  | ||
|BodyHorizontalAngle|Float|  | |BodyHorizontalAngle|Float| The current user body angle.  | ||
|RenderDebugVisuals|Bool|  | |RenderDebugVisuals|Bool| Whether or not to render the debug visuals.  | ||
|PauseLocomotionAnimation|Bool|  | |PauseLocomotionAnimation|Bool| Whether or not to pause the current locomotion animation.  | ||
|OverrideLocomotionVelocity|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float3|Float3]]>'''|TypeAdv4=true|  | |OverrideLocomotionVelocity|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float3|Float3]]>'''|TypeAdv4=true| What to override the current locomotion animation with.  | ||
|OverrideLocomotionAngularVelocity|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv5=true|  | |OverrideLocomotionAngularVelocity|'''[[Type:Nullable`1|Nullable`1]]<[[Type:Float|Float]]>'''|TypeAdv5=true| What to override the current locomotion animation angular velocity with.  | ||
|SimulationSpeedRatio|Float|  | |SimulationSpeedRatio|Float| The specified simulation speed ratio.  | ||
|_defaultConfig|'''[[Component:LocomotionAnimationConfiguration|LocomotionAnimationConfiguration]]'''|TypeAdv7=true|  | |_defaultConfig|'''[[Component:LocomotionAnimationConfiguration|LocomotionAnimationConfiguration]]'''|TypeAdv7=true| What the default locomotion animation for all avatars that don't specify it should be.  | ||
}}  | }}  | ||
==   | == Usage ==  | ||
== Examples ==  | == Examples ==  | ||
| Line 25: | Line 25: | ||
[[Category:Components:Uncategorized{{#translation:}}|User Pose Controller]]  | [[Category:Components:Uncategorized{{#translation:}}|User Pose Controller]]  | ||
[[Category:Components{{#translation:}}|User Pose Controller]]  | [[Category:Components{{#translation:}}|User Pose Controller]]  | ||
Latest revision as of 12:36, 3 August 2025
Component image File:UserPoseControllerComponent.pngUser Pose Controller component as seen in the Scene Inspector  
The UserPoseController component is used to control the posing of the user.
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. | 
ScreenController
 | 
ScreenController | the currently used screen controller. | 
BodyHorizontalAngle
 | 
Float | The current user body angle. | 
RenderDebugVisuals
 | 
Bool | Whether or not to render the debug visuals. | 
PauseLocomotionAnimation
 | 
Bool | Whether or not to pause the current locomotion animation. | 
OverrideLocomotionVelocity
 | 
Nullable`1<Float3> | What to override the current locomotion animation with. | 
OverrideLocomotionAngularVelocity
 | 
Nullable`1<Float> | What to override the current locomotion animation angular velocity with. | 
SimulationSpeedRatio
 | 
Float | The specified simulation speed ratio. | 
_defaultConfig
 | 
LocomotionAnimationConfiguration | What the default locomotion animation for all avatars that don't specify it should be. |