player

The local player. Every getter returns nil when there is no world.

Functions

19 functions. Signatures are generated from the client, so they describe the build you are running.

player.pos() -> x:number, y:number, z:number

player.lastPos() -> x:number, y:number, z:number

Position at the start of the tick, for interpolation.

player.velocity() -> x:number, y:number, z:number

player.rotation() -> yaw:number, pitch:number

player.eyeHeight() -> number

player.health() -> number

player.absorption() -> number

Yellow hearts, on top of health.

player.hunger() -> number

0 to 20.

player.isOnGround() -> boolean

player.isSprinting() -> boolean

player.isSneaking() -> boolean

player.isInWater() -> boolean

player.isUsingItem() -> boolean

Eating, drawing a bow, blocking.

player.name() -> string

player.sendChat(message:string)

Sends as if typed. A leading '/' runs a command.

player.swingHand([offhand:boolean])

player.setSprinting(state:boolean)

player.setSneaking(state:boolean)

player.jump()

No-op when not on the ground.