Class LocalPlayer

constructor

• new LocalPlayer(): LocalPlayer

• Returns LocalPlayer

Readonly runtimeId

attack

• attack(): void

• Makes your player attack the entity. Only works if you have operator

  This function is restricted - meaning it will only work on LocalPlayer or if you have OP

  Returns void

  Throws

getDimensionName

• getDimensionName(): string

• Get the dimension name. for example, "Overworld"

  Returns string

getEntityType

• getEntityType(): number

• Gets the entity type ID.

  https://minecraft.fandom.com/wiki/Bedrock_Edition_data_values#Entity_IDs

  Returns number

getFlag

• getFlag(flag): boolean

• Gets a status flag's state in the current entity.

  Parameters

  • flag: number

  Returns boolean

getHealth

• getHealth(): number

• Gets the health of the entity.

  This function is restricted - meaning it will only work on LocalPlayer or if you have OP

  Returns number

getHoldingItem

• getHoldingItem(): ItemStack

• Gets the item being held.

  Returns ItemStack

getHunger

• getHunger(): number

• Gets the hunger of the entity.

  This function is restricted - meaning it will only work on LocalPlayer or if you have OP

  Returns number

getHurtTime

• getHurtTime(): number

• Gets the number of ticks that the entity is invulnerable (after the entity is hit/hurt), ranges from 0-10

  Returns number

getItem

• getItem(slot): null | ItemStack

• Gets the item at the current inventory slot. Will return null if the specified slot is out of bounds

  Parameters

  • slot: number

    The slot number

  Returns null | ItemStack

getMolangVariable

• getMolangVariable(name): MolangVariable

• Gets the value of a MoLang variable. Returns null if the variable was not found.

  Parameters

  • name: MolangVariables

    The variable name. Example: variable.is_sneaking

  Returns MolangVariable
• getMolangVariable(name): null | MolangVariable

• Gets the value of a MoLang variable. Returns null if the variable was not found.

  Parameters

  • name: string

    The variable name. Example: variable.is_sneaking

  Returns null | MolangVariable

getName

• getName(): string

• Get the player's name (same one as the player list in the pause menu.)

  Returns string

getPosition

• getPosition(): Vector3

• Get the position. Note that this will fail if you dont have permission to get the position

  Returns Vector3

  Throws

getPositionInterpolated

• getPositionInterpolated(): Vector3

• Get the interpolated position. Use this in the context of rendering based on entity position.

  Returns Vector3

getPreviousPosition

• getPreviousPosition(): Vector3

• Get the position the entity was in the last tick.

  Returns Vector3

getRotation

• getRotation(): Vector2

• Get the rotation. Note that this will fail if you dont have permission to get the rotation

  Returns Vector2

  Throws

getSaturation

• getSaturation(): number

• Gets the saturation of the entity.

  This function is restricted - meaning it will only work on LocalPlayer or if you have OP

  Returns number

getSelectedSlot

• getSelectedSlot(): number

• Gets the slot of the item being held.

  Returns number

getVelocity

• getVelocity(): Vector3

• Gets the entity's movement velocity.

  Returns Vector3

getXUID

• getXUID(): string

• Gets the player's Xbox User ID.

  Returns string

isLocalPlayer

• isLocalPlayer(): boolean

• Whether the entity is the local player (yourself) or not.

  Returns boolean

isPlayer

• isPlayer(): boolean

• Whether the entity is a player or not.

  Returns boolean

isValid

• isValid(): boolean

• Check if the entity is still valid. In some cases, Latite may invalidate an entity outside of an event listener. This is to prevent the scripting engine from being used as a cheat.

  Returns boolean

setFlag

• setFlag(flag, value): void

• Sets a status flag's state in the current entity.

  Parameters

  • flag: number

  • value: boolean

    The new status flag value.

  Returns void

setMolangVariable

• setMolangVariable(name, value): null | number

• [Experimental] sets a MoLang variable's value. Returns null if unsuccessful and the number that was set if it was successful.

  Parameters

  • name: string

    The variable name. Example: variable.is_sneaking

  • value: number

    The variable's new value.

  Returns null | number

setVelocity

• setVelocity(vector): void

• Sets the entity's movement velocity.

  This function is restricted - it only works if you have operator.

  Parameters

  • vector: Vector3

    The new velocity

  Returns void