Class Item

Readonlyattributes

headYaw

Readonlymetadata

pitch

yaw

Static InternalruntimeIdCount

[toStringTag]

• get "[toStringTag]"(): string

  Returns string

StaticZERO

• get ZERO(): Vector3

  Returns a Vector3 with 0 on all axis.

  Returns Vector3

equals

• equals(vector: Entities.Item): boolean

  Compare an instance of Vector3 with another.

  Parameters

  • vector: Entities.Item

    The Vector3 to compare to.

  Returns boolean

  true if they're equal otherwise false.

floor

• floor(): Vector3

  Returns a new Vector3 with each component rounded down to the nearest integer.

  Returns Vector3

  A new Vector3 with rounded down components.

getFormattedUsername

• getFormattedUsername(): string

  Get the entity's formatted name.

  Returns string

  The entity's formatted name (including prefix & suffix).

  Example

  const formattedName = entity.getFormattedUsername();
  console.log(`Entity formatted name: ${formattedName}`); // Entity formatted name: Sheep
  Copy

getName

• getName(): string

  Get the entity's (potentially custom) name.

  Returns string

  The entity's name without formatting (usually prefix & suffix).

  Example

  const name = entity.getName();
  console.log(`Entity name: ${name}`);
  Copy

getNearestEntity

• getNearestEntity(entities?: Entity[]): Entity[]

  Returns the nearest entity from the current entity.

  Parameters

  • Optionalentities: Entity[] = ...

    The entities to compare the distance between.

  Returns Entity[]

  The nearest entity.

  Todo

  Customizable radius

  Example

  const nearestEntity = entity.getNearestEntity();
  console.log('Nearest entity:', nearestEntity);
  Copy

getPosition

• getPosition(): Vector3

  Get the entity's position.

  Returns Vector3

  The entity's position.

  Example

  const position = entity.getPosition();
  Copy

getRuntimeId

• getRuntimeId(): bigint

  Get the entity's runtime id.

  Returns bigint

  The entity's runtime id.

  Example

  const entityId = entity.getRuntimeId();
  console.log(entityId); // Ex. Output: 1n
  Copy

getServer

• getServer(): Server

  Get the server instance.

  Returns Server

  The server instance.

  Example

  const server = entity.getServer();
  // Do things with the server.
  Copy

getType

• getType(): string

  Get the entity type.

  Returns string

  The entity's namespace ID.

  Example

  const entityType = entity.getType();
  console.log(`Entity type: ${entityType}`);
  Copy

getUUID

• getUUID(): string

  Get the entity's UUID.

  Returns string

  The entity's UUID.

  console.log(entity.getUUID());
  Copy

getWorld

• getWorld(): World

  Get the world of the position.

  Returns World

  The world of the position.

getX

• getX(): number

  Get the x coordinate.

  Returns number

  The x coordinate's value.

getY

• getY(): number

  Get the y coordinate.

  Returns number

  The y coordinate's value.

getZ

• getZ(): number

  Get the z coordinate.

  Returns number

  The z coordinate's value.

isConsole

• isConsole(): boolean

  Check if the entity is a console instance.

  Returns boolean

  true if the entity is console-controlled, otherwise false.

  Example

  if (entity.isConsole()) {
      console.log('Entity is a console');
  } else {
      console.log('Entity is not a console');
  }
  Copy

isPlayer

• isPlayer(): boolean

  Check if the entity is a player.

  Returns boolean

  true if the entity is player-controlled, otherwise false.

  Example

  if (entity.isPlayer()) {
      console.log('Entity is a player');
  } else {
      console.log('Entity is not a player');
  }
  Copy

sendDespawn

• sendDespawn(player?: Player): Promise<void>

  Despawn the entity.

  Parameters

  • Optionalplayer: Player

    The player to send the packet to, if not specified, all players in the world will receive the packet.

  Returns Promise<void>

  A promise that resolves when the entity is despawned.

sendMessage

• sendMessage(message: string, type?: TextType): void

  Send a message to an entity.

  Parameters

  • message: string

    The message.
  • Optionaltype: TextType = TextType.Raw

    The text type.

  Returns void

  Remarks

  This will silently fail on non-client-controlled entities.

  Example: Send "Hello World!" to a client:

  entity.sendMessage('Hello World!');
  Copy

sendPosition

• sendPosition(): Promise<void>

  Send the position to all the players in the same world.

  Returns Promise<void>

  A promise that resolves when the position is sent.

setName

• setName(name: string): void

  Set the entity's name.

  Parameters

  • name: string

    The name.

  Returns void

  Example

  entity.setName('Mr. Sheep');
  Copy

setPosition

• setPosition(
      options: {
          headYaw?: number;
          pitch?: number;
          position: Vector3;
          yaw?: number;
      },
  ): Promise<void>

  Set the entity's position and notify the clients.

  Parameters

  • options: { headYaw?: number; pitch?: number; position: Vector3; yaw?: number }

    The position options.

    • OptionalheadYaw?: number

      The head yaw.

    • Optionalpitch?: number

      The pitch.

    • position: Vector3

      The position.

    • Optionalyaw?: number

      The yaw.

  Returns Promise<void>

  A promise that resolves when the position is set.

setWorld

• setWorld(world: World): void

  Set the world of the position.

  Parameters

  • world: World

    The world to set.

  Returns void

setX

• setX(x: number, suppress?: boolean): Promise<void>

  Set the x position.

  Parameters

  • x: number

    The x coordinate.
  • Optionalsuppress: boolean = false

    If true, the client won't be notified about the position change.

  Returns Promise<void>

  A promise that resolves when the x position is set.

  Example

  await entity.setX(10);
  Copy

  Remarks

  This method will also send the position update to the client if suppress is false.

setY

• setY(y: number, suppress?: boolean): Promise<void>

  Set the y position.

  Parameters

  • y: number

    The y coordinate.
  • Optionalsuppress: boolean = false

    If true, the client won't be notified about the position change.

  Returns Promise<void>

  A promise that resolves when the y position is set.

  Example

  await entity.setY(10);
  Copy

  Remarks

  This method will also send the position update to the client if suppress is false.

setZ

• setZ(z: number, suppress?: boolean): Promise<void>

  Set the z position.

  Parameters

  • z: number

    The z coordinate.
  • Optionalsuppress: boolean = false

    If true, the client won't be notified about the position change.

  Returns Promise<void>

  A promise that resolves when the z position is set.

  Example

  await entity.setZ(10);
  Copy

  Remarks

  This method will also send the position update to the client if suppress is false.

toString

• toString(): string

  Convert to a string representation.

  Returns string

  The string.

  console.log(entity.toString());
  Copy

trunc

• trunc(): Vector3

  Returns a new Vector3 with each component truncated to the nearest integer.

  Returns Vector3

  A new Vector3 with truncated axis.

StaticfromObject

• fromObject(obj: { x: number; y: number; z: number }): Vector3

  Creates a new Vector3 instance from an object with x, y, and z properties.

  Parameters

  • obj: { x: number; y: number; z: number }

    The object containing x, y, and z properties.

  Returns Vector3

  A new Vector3 instance.

StaticfromVector3

• fromVector3(vector: Vector3, world: World): Position

  Creates a Position from a Vector3 and a World.

  Parameters

  • vector: Vector3

    The vector to create the position from.
  • world: World

    The world of the position.

  Returns Position

  The new position.