The PhysicalLocomotion component is a versatile Locomotion Module that can be used for walking, climbing, flying, and Zero-G.
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. |
Icon
|
IAssetProvider`1<ITexture2D> | The icon image visual for this locomotion in the context menu. |
Color
|
ColorX | The color of this locomotion's icon in the context menu. |
_currentController
|
LocomotionController | The current Locomotion controller which would be from a user controlling this locmotion. |
_lastDefaultIcon
|
Uri | The last URI used for the default context menu icon for this locomotion. |
_lastDefaultColor
|
Nullable`1<ColorX> | The last color used for the default version of this locomotion for the context menu. |
Turn
|
direct TurnSubmodule | How turning should be handled for this locomotion. |
MinInitializationDelay
|
Float | The minimum time to wait for the locomotion to allow initalization. |
MaxInitializationDelay
|
Float | If the amount of time passed after this component was created is past this value, the locomotion is forced to initialize anyways. |
InitializationColliderRoot
|
Slot | The slot which a collider in its hiearchy has to be raycastable (From the user's feet downward) in order for this locomotion to initalize. |
UseSpeedFromUserSettings
|
Bool | Whether to allow the speed in the user settings to influence this locomotion's speed. |
Description
|
String | The description of this locomotion in the context menu. |
Mode
|
MovementMode | How the enviroment/user influences how this locomotion can move. |
Gripping
|
EnvironmentGripping | See #Gripping for more information |
GripOnHold
|
Bool | See #Gripping for more information |
GripRadius
|
Float | See #Gripping for more information |
GripVelocityMultiplier
|
Float | See #Gripping for more information |
GripHandRotationMode
|
GripRotation | See #Gripping for more information |
GripObjectRotationMode
|
GripRotation | See #Gripping for more information |
HandGripRotationSmoothSpeed
|
Nullable`1<Float> | See #Gripping for more information |
FallRespawnPosition
|
Float | How far down in global space the user needs to be to respawn. |
MakeGravityCharacterLocal
|
Bool | Whether the gravity should be based on the user's parent space orientation (true) or global (false) |
AutoAlignVerticalWithGravitySpeed
|
Float | How fast to rotate the player to orient them to the direction of gravity. |
ManualAlignVerticalWithGravitySpeed
|
Float | How fast the user aligns with gravity if 3 axis rotation is enabled and they're pressing the manual align button. |
AirDecelerationSpeed
|
Float | How fast the user is slowed down while in air. |
GripScaleDelay
|
Float | How long the user has to wait after gripping a surface in order to be able to scale with both hands in VR. |
AllowCrouch
|
Bool | Whether this locomotion allows the user to crouch down. |
MaximumNormalizedSpeed
|
Float | The fastest speed this locomotion is allowed to travel. |
_defaultIcon
|
Uri | The default icon url for this kind of locomotion. |
_defaultColor
|
ColorX | The default color for this kind of locomotion. |
_characterController
|
CharacterController | The character controller associated with this locomotion component. |
__legacyName
|
String | Internal. |
Usage
MovementMode
| Name | Value | Description |
|---|---|---|
GroundTraction
|
0 | Only move when making contact with ground. |
DirectionalForce
|
1 | Move in the direction of the controller (VR) or head (Desktop). |
Gripping
PhysicalLocomotion has a feature which is unique to it, called Gripping. This feature allows you to grip other objects in the world in order to use them to climb or traverse the world. A good analogy is rock climbing as this is exactly how this feature feels to use. Gripping, only works when allowed by the world author.
This feature is commonly called "Climbing" or "Physical Grab/Climbing" or even "Player Climbing", the official name "Gripping" will be used throughout this page.
Additionally, this feature is often confused with "Grabbables" which refer to any object in that you can move around in the world by grabbing it. These features are independent, for a quick way to remember the difference:
- Grabbing involves 'moving an object which you are "Grabbing"
- Gripping involves moving you using an object which you are "Gripping"
Or if that doesn't work, its the difference between climbing a ladder and moving that ladder.
World authors can configure this feature by changing the properties on the PhysicalLocomotion component. The main property here is "Gripping" which has the following settings and meanings:
EnviromentGripping
| Name | Value | Description |
|---|---|---|
Disabled
|
0 | Fully prevents any gripping in this world when using this locomotion module. |
GrippableObjects
|
1 | Allows gripping on objects that are explicitly tagged with a Component that indicates that a Slot or Object can be gripped. These components are: Component:LocomotionGrip - The most common. Used to explicitly signal the grippable state of an object.
Gizmo - These are also tagged as "GrippableObjects" but cannot be gripped, see #Gripping Process below for more info. Character type Colliders Allows gripping on objects that contain colliders who's "CharacterCollider" property is enabled. |
AnyObjects
|
2 | Allows gripping on anything, including players. |
GripRotation
| Name | Value | Description |
|---|---|---|
None
|
0 | The rotation of the gripping hand does not affect user rotation/position. |
VerticalOnly
|
1 | The rotation of the gripping hand only affects user rotation in the vertical axis and rotates the position of the user by that offset. |
Any
|
2 | The rotation of the gripping hand allows the user to tilt and rotate their body using the wrist as the rotation anchor point, keeping their hand at the same position and rotation relative to the collider it is grabbing. |
Gripping Process
When a user attempts to grip in a world, the following steps occur to determine if there is a successful grip or not.
- If gripping is set to Disabled, stop. You can't grip ever.
- If there is already a grip in progress, as in is this user already holding onto another object. Stop. You can only have one active grip.
- Run a physics operation to get any colliders within the "GripRadius" of the user's actively gripping hand.
- Filter the returned colliders:
- If the collider's active user is the same as the active user of the collider, remove it from the results.
- If gripping is set to AnyObjects, all colliders in the "GripRadius" are included.
- If gripping is set to CharacterColliders, colliders who do NOT have the "CharacterCollider" checkbox enabled are removed from the results.
- If gripping is set to GrippableObjects, colliders who do NOT have a "LocomotionGrip" component on them or within their parents are removed from the results.
- From the filtered list the first collider which passes ALL the following rules is then "Gripped":
- If the collider has a "LocomotionGrip" component on them or within their parents, it must be Enabled.
- The collider must NOT be a part of a Gizmo
Gripping Users
Gripping users is treated the same way as the "Gripping Process" above. So keep the following items in mind:
- You cannot manually opt in to be grippable by editing your avatar unless the Gripping property on the locomotion is set to "GrippableObjects", if this is the case add a "LocomotionGrip" component to your avatar root and enable it.
- If you want to opt out of being grippable then regardless of the world settings, you will need to add a "LocomotionGrip" component to your avatar root AND User Root and uncheck their Enabled properties.
Examples
Is part of the default world locomotion set using the walk locomotion.