59 docs tagged with "Locomotion"

Request that the local player perform a clamber or a mantle. Custom Locomotion must be enabled in the active Player Definition Board.

Request that the local player crouch.

This chip requires beta content to be enabled in the room. You can access the setting in "This Room -> Settings".

This chip requires beta content to be enabled in the room. You can access the setting in "This Room -> Settings".

Request that the local player jumps.

Request that the local player's jump is cancelled or shortened.

Request that the local player becomes prone.

Used for custom locomotion in order to request starting a slide.

Used for custom locomotion in order to request starting a sprint.

Request that the local player's sprint stops.

Requests that the local player stand.

Request that the local player is steered in the given direction, at the given speed.

Request that the local player begin to wall run. Not affected by CanWallRun directly. If you want that property to impact this request you should check it yourself.

Request that the local player stop wall running. Not affected by CanWallRun directly. If you want that property to impact this request you should check it yourself.

Returns whether a given player is allowed to teleport.

Returns whether crouch input is enabled for a given player

Returns the crouch speed for a given player.

Returns whether manual sprint is required for a given player

Returns whether Virtual Height Mode is required for a given player

Returns whether the given player will be forced to use walk mode if they are playing in VR.

Whether or not the player is currently clambering or mantling up a ledge

Returns whether the given player is crouching

Returns whether the given player is flying.

Returns whether the given player is grounded, a.k.a. not jumping, flying, wall-running, clambering, or falling. Also returns the time (in seconds) since they were last grounded, or 0 if currently grounded. Surface Object returns the Room Object that the player is standing on if they are grounded, or Invalid Object if the player is not grounded or standing on a non-Rec Room Object. Surface Normal returns the normal of the surface if the player is grounded and (0, 1, 0) if they're not.

InputsOutputsplayer | Playerbool | Is Jumping Or Fallingrec room object | Contact Surface

Returns whether the given player is prone.

Returns whether the given player is sliding.

Returns whether the given player is sprinting.

Returns whether the given player is wall running.

Returns the jump height for a given player

Returns whether jump input is enabled for a given player

(DEPRECATED: Use PlayerGetSteeringSpeed / GetWalkSpeed) Returns the steering speed requested by the player, squared, and normalized by the square of the default walk speed.

Returns the prone speed for a given player.

Returns the slide speed for a given player.

Returns whether sprint input is enabled for a given player

Returns the sprint speed for a given player

Player Get Steering Direction

Returns the steering speed requested by the player. This value represents how fast a player is wanting to move in world units.

Returns the teleport delay for a given player

Returns the max teleport distance for a given player

Returns the walk speed for a given player

Gets the whether the player can Wall Run. Enforced via circuits.

Sets whether a given player is allowed to teleport.

Sets whether crouch input is enabled for a given player. Setting this to false will remove crouch button prompts / UI elements on supported platforms.

Sets the crouch speed for a given player

Sets whether manual sprint is required for a given player.

Sets whether Virtual Height Mode is required for a given player.

Forces the given player to use walk rather than teleport mode if they are playing in VR. This is useful when you need access to their walk inputs which won't fire if they are in teleport mode. You should consider adding a warning to your room so teleport players are aware that you're going to change their movement mode.

Sets the jump height for a given player

Sets whether jump input is enabled for a given player. Setting this to false will remove jump button prompts / UI elements on supported platforms.

Sets the prone speed for a given player

Sets the slide speed for a given player

Sets whether sprint input is enabled for a given player. Setting this to false will remove sprint button prompts / UI elements on supported platforms.

Sets the sprint speed for a given player

Sets whether walk input is enabled for a given player. Setting this to false will stop Steering Input events from firing, and will remove walk-related button prompts / UI elements on supported platforms.

Sets the teleport delay for a given player

Sets the max teleport distance for a given player

Sets the walk speed for a given player

Sets the whether the player can Wall Run. Enforced via circuits.