player

Player utilities

Functions

set_speed(speed : number)

Sets the player's movement speed

• speed (number) The speed to set

get_speed(): number

Returns the player's current speed

• returns (number) The current speed

get_bps(): number

Returns the player's speed in blocks per second

• returns (number) The speed in BPS

get_base_move_speed(): number

Returns the player's base movement speed

• returns (number) The base movement speed

strafe()

Strafes the player in the direction they are moving

is_moving(): boolean

Returns whether the player is moving or not

• returns (bool) True if moving, false otherwise

is_moving_diagonally(): boolean

Returns whether the player is moving diagonally or not

• returns (bool) True if moving diagonally, false otherwise

path_find(x : number, y : number, z : number, point_distance : number): table<types.vector3>

Computes a path from the player's current position to a target position using A*

• x (number) The target x coordinate
• y (number) The target y coordinate
• z (number) The target z coordinate
• point_distance (number) The distance between points in the path
• returns (table<types.vector3>) A list of points representing the path