namespace ML.SDK
Class | Sealed
PlayerLocomotion
namespace ML.SDK
{
sealed class PlayerLocomotion
}
Summary
A type which manages the locomotion values of a player. Can be used to set or get the various value regarding player control.
Methods
| Method | Description |
|---|---|
| GetDashingMultiplier() | Gets the dashing multiplier. |
| GetJumpSpeed() | Gets the current jump speed. |
| GetWalkingSpeed() | Gets the current walking speed. |
| IsClimbEnabled() | Is the player allowed to climb on the walls? |
| IsDashingEnabled() | Checks if the dashing is enabled. Returns true if the dashing is enabled. |
| IsHoloTeleportModeEnabled() | Checks if the Holo-Teleport mode is enabled. Returns true if the Holo-Teleport mode is enabled. Holo-Teleport is a VR only locomotion mode. |
| IsJumpEnabled() | Checks if the jumping is enabled. Returns true if the jumping is enabled. |
| IsLocomotionEnabled() | Checks if the locomotion is enabled for the player. Returns true if the locomotion is enabled. |
| IsTeleportModeEnabled() | Checks if the Teleport mode is enabled. Returns true if the Teleport mode is enabled. Teleport is a VR only locomotion mode. |
| IsTurnEnabled() | Checks if the turning is enabled. Returns true if the turning is enabled. |
| IsWalkingEnabled() | Checks if the walking is enabled. Returns true if the walking is enabled. |
| IsWalkModeEnabled() | Checks if the walk mode is enabled. Returns true if the walk mode is enabled. Walk mode is related to VR mode.In desktop mode, player is alway in walk mode. |
| RevertLocomotionType() | Reverts the user’s locomotion type to their preferred locomotion. |
| SetDashingMultiplier(float) | Sets the dashing multiplier. |
| SetDefault() | Sets the values of the locomotion to global default. The global default values are defined by Massive Loop System. |
| SetJumpSpeed(float) | Sets the jump speed. |
| SetWalkingSpeed(float) | Sets the walking speed of the player. |
| SetWorldDefault() | Sets the values of the locomotion to the world default. The world default values are defined in World Descriptor. |
| ToggleClimb(bool) | Toggle if the player can climb the walls or not. |
| ToggleDashing(bool) | Enables or disables dashing for the player. This has no effect on walking. |
| ToggleHoloTeleportMode(bool) | Enables or disables the Holo-Teleport Mode. Holo-Teleport is VR only feature. |
| ToggleJump(bool) | Enables or disables jumping for the player. |
| ToggleLocomotion(bool) | Enables or disables all the locomotion for player. Disabling and enabling does not override previously set individual values. |
| ToggleTeleportMode(bool) | Enables or disables the Teleport Mode. Teleport if a VR only feature. |
| ToggleTurn(bool) | Enables or disables turning for the player. |
| ToggleWalking(bool) | Enables or disables the walking of the player. The dashing is also disables when the walking is disabled. |
| ToggleWalkMode(bool) | Enables or disables the walk mode. Walk mode is related to VR mode.In desktop mode, player is alway in walk mode. |