Component:SingleShapeCharacterControllerManager: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Single Shape Character Controller Manager
|Name=Single Shape Character Controller Manager
}}
}}
{{stub}}
The '''SingleShapeCharacterControllerManager''' component is used by locomotions to change the shape of a [[Component:CapsuleCollider|Capsule Collider]] based on a user's standing height and current height.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|UseUserHeadHeightWhenAvailable|Bool|
|UseUserHeadHeightWhenAvailable|Bool| Whether to use the user's head height to do calculations when possible.
|HeadHeightOffset|Float|
|HeadHeightOffset|Float| How much to add/subtract from the user's head to make the top of the capsule.
|CrouchTargetWidth|Float|
|CrouchTargetWidth|Float| How wide the capsule should become when crouching.
|CrouchStart|Float|
|CrouchStart|Float| The maximum height the user's head has to be for them to be crouching.
|CrouchEnd|Float|
|CrouchEnd|Float| The minimum height the user's head has to be for them to be crouching.
|DefaultHeight|Float|
|DefaultHeight|Float| The user's default head height.
|DefaultWidth|Float|
|DefaultWidth|Float| The collider's width when standing.
|RootAtBottom|Bool|
|RootAtBottom|Bool| Whether the bottom end of the capsule should be at the slot rather than the slot being at the middle.
|TargetHeight|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv8=true|
|TargetHeight|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv8=true| The slot to drive to influence the capsule collider's height.
|TargetWidth|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv9=true|
|TargetWidth|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv9=true| The slot to drive to influence the capsule collider's radius.
|TargetOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv10=true|
|TargetOffset|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv10=true| The slot to drive to influence the capsule collider's center offset.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
Used in the default locomotions and is needed for a locomotion to adjust the character collider for a user properly.


== See Also ==
== See Also ==
* [[Type:ILocomotionModule]]


[[Category:Components:Physics:Utility{{#translation:}}|Single Shape Character Controller Manager]]
[[Category:Components:Physics:Utility{{#translation:}}|Single Shape Character Controller Manager]]
[[Category:Components{{#translation:}}|Single Shape Character Controller Manager]]
[[Category:Components{{#translation:}}|Single Shape Character Controller Manager]]
[[Category:ComponentStubs]]

Latest revision as of 20:46, 2 February 2025

Component image 
Single Shape Character Controller Manager component as seen in the Scene Inspector

The SingleShapeCharacterControllerManager component is used by locomotions to change the shape of a Capsule Collider based on a user's standing height and current height.

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.
UseUserHeadHeightWhenAvailable Bool Whether to use the user's head height to do calculations when possible.
HeadHeightOffset Float How much to add/subtract from the user's head to make the top of the capsule.
CrouchTargetWidth Float How wide the capsule should become when crouching.
CrouchStart Float The maximum height the user's head has to be for them to be crouching.
CrouchEnd Float The minimum height the user's head has to be for them to be crouching.
DefaultHeight Float The user's default head height.
DefaultWidth Float The collider's width when standing.
RootAtBottom Bool Whether the bottom end of the capsule should be at the slot rather than the slot being at the middle.
TargetHeight field drive of Float The slot to drive to influence the capsule collider's height.
TargetWidth field drive of Float The slot to drive to influence the capsule collider's radius.
TargetOffset field drive of Float3 The slot to drive to influence the capsule collider's center offset.

Usage

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

Examples

Used in the default locomotions and is needed for a locomotion to adjust the character collider for a user properly.

See Also