Function createPlayerAPI

Returns {
    getPos(): Vec3;
    teleport(x: number, y: number, z: number): void;
    getHealth(): number;
    setHealth(hp: number): void;
    getHunger(): number;
    setHunger(h: number): void;
    getOxygen(): number;
    setOxygen(o: number): void;
    isOnGround(): boolean;
    isSneaking(): boolean;
    isDead(): boolean;
    getSpawnPoint(): Vec3;
    setSpawnPoint(x: number, y: number, z: number): void;
    setVelocityY(vy: number): void;
    getVelocityY(): number;
    setLook(yaw: number, pitch: number): void;
    getLook(): LookInfo;
    getLookingAt(): LookingAtResult | null;
    setGravity(g: number): void;
    setSpeed(s: number): void;
    setJumpForce(f: number): void;
    setSprintMultiplier(m: number): void;
    setFlySpeed(s: number): void;
    setFly(on: boolean): void;
    setSensitivity(s: number): void;
}

• getPos: function

  • getPos(): Vec3

    Get the player's current world position.

    Returns Vec3

    Position as {x, y, z}

• teleport: function

  • teleport(x: number, y: number, z: number): void

    Teleport the player to the given world coordinates.

    Parameters

    • x: number

      World X coordinate

    • y: number

      World Y coordinate

    • z: number

      World Z coordinate

    Returns void

• getHealth: function

  • getHealth(): number

    Get the player's current health (0 = dead, 20 = full by default).

    Returns number

    Current health points

• setHealth: function

  • setHealth(hp: number): void

    Set the player's health to an exact value.

    Parameters

    • hp: number

      New health value

    Returns void

• getHunger: function

  • getHunger(): number

    Get the player's current hunger level (0 = starving, 20 = full).

    Returns number

    Current hunger points

• setHunger: function

  • setHunger(h: number): void

    Set the player's hunger to an exact value.

    Parameters

    • h: number

      New hunger value

    Returns void

• getOxygen: function

  • getOxygen(): number

    Get the player's current oxygen level (decreases while underwater).

    Returns number

    Current oxygen level

• setOxygen: function

  • setOxygen(o: number): void

    Set the player's oxygen to an exact value.

    Parameters

    • o: number

      New oxygen value

    Returns void

• isOnGround: function

  • isOnGround(): boolean

    Check whether the player is standing on solid ground.

    Returns boolean

    True if the player is on the ground

• isSneaking: function

  • isSneaking(): boolean

    Check whether the player is currently sneaking (shift held).

    Returns boolean

    True if sneaking

• isDead: function

  • isDead(): boolean

    Check whether the player is dead (health reached 0).

    Returns boolean

    True if dead

• getSpawnPoint: function

  • getSpawnPoint(): Vec3

    Get the player's respawn point.

    Returns Vec3

    Spawn position as {x, y, z}

• setSpawnPoint: function

  • setSpawnPoint(x: number, y: number, z: number): void

    Set the player's respawn point (where they appear after dying).

    Parameters

    • x: number

      World X coordinate

    • y: number

      World Y coordinate

    • z: number

      World Z coordinate

    Returns void

• setVelocityY: function

  • setVelocityY(vy: number): void

    Set the player's vertical velocity (use negative for downward, positive for upward/launch).

    Parameters

    • vy: number

      Vertical velocity in blocks per second

    Returns void

• getVelocityY: function

  • getVelocityY(): number

    Get the player's current vertical velocity.

    Returns number

    Vertical velocity in blocks per second

• setLook: function

  • setLook(yaw: number, pitch: number): void

    Set the player's look direction.

    Parameters

    • yaw: number

      Horizontal rotation in radians

    • pitch: number

      Vertical rotation in radians

    Returns void

• getLook: function

  • getLook(): LookInfo

    Get the player's current look direction (yaw, pitch, and unit direction vector).

    Returns LookInfo

    Look info with yaw, pitch, dx, dy, dz

• getLookingAt: function

  • getLookingAt(): LookingAtResult | null

    Get the block the player is currently looking at (raycast from camera).

    Returns LookingAtResult | null

    Block hit info with position, type, and adjacent empty position, or null if nothing in range

• setGravity: function

  • setGravity(g: number): void

    Set the gravity strength for the player.

    Parameters

    • g: number

      Gravity in blocks/s^2 (default 22)

    Returns void

• setSpeed: function

  • setSpeed(s: number): void

    Set the player's base walking speed.

    Parameters

    • s: number

      Speed in blocks per second (default 7)

    Returns void

• setJumpForce: function

  • setJumpForce(f: number): void

    Set the player's jump force.

    Parameters

    • f: number

      Jump impulse strength (default 8.5)

    Returns void

• setSprintMultiplier: function

  • setSprintMultiplier(m: number): void

    Set the sprint speed multiplier applied when sprinting.

    Parameters

    • m: number

      Multiplier (default 1.6, so sprinting is 60% faster)

    Returns void

• setFlySpeed: function

  • setFlySpeed(s: number): void

    Set the flying speed (used in creative/fly mode).

    Parameters

    • s: number

      Fly speed in blocks per second (default 14)

    Returns void

• setFly: function

  • setFly(on: boolean): void

    Enable or disable fly mode for the player.

    Parameters

    • on: boolean

      True to enable flying, false to restore normal gravity

    Returns void

• setSensitivity: function

  • setSensitivity(s: number): void

    Set mouse look sensitivity.

    Parameters

    • s: number

      Sensitivity value (default 0.003)

    Returns void