Class EntityLike`Internal`

Entity-like class.

Hierarchy (View Summary)

Position
- EntityLike
  - Entity
  - Console

Index

Constructors

Properties

headYaw pitch runtimeId server uuid x y yaw z

Accessors

Methods

equals floor getNearestEntity getPosition getRuntimeId getServer getWorld getX getY getZ setWorld setX setY setZ toString trunc fromObject fromVector3

Constructors

constructor

new EntityLike(
    options: {
        headYaw?: number;
        pitch?: number;
        runtimeId: bigint;
        server: Server;
        uuid?: string;
        world: World;
        yaw?: number;
    },
): EntityLike
EntityLike constructor.
Parameters
- options: {
      headYaw?: number;
      pitch?: number;
      runtimeId: bigint;
      server: Server;
      uuid?: string;
      world: World;
      yaw?: number;
  }
  The entity-like options.
  - OptionalheadYaw?: number
    The head yaw.
  - Optionalpitch?: number
    The pitch.
  - runtimeId: bigint
    The entity's runtime id.
  - server: Server
    The server instance.
  - Optionaluuid?: string
    The entity's runtime id.
  - world: World
    The world the entity belongs to.
  - Optionalyaw?: number
    The yaw.
Returns EntityLike
The entity-like instance.
Overrides Position.constructor
- Defined in packages/prismarine/src/entity/Entity.ts:40

Properties

headYaw

headYaw: number

pitch

pitch: number

`Protected` `Readonly`runtimeId

runtimeId: bigint

`Protected` `Readonly`server

server: Server

`Protected` `Readonly`uuid

uuid: string

`Protected`x

x: number = 0

The X coordinate.

`Protected`y

y: number

The Y coordinate.

yaw

yaw: number

`Protected`z

z: number = 0

The Z coordinate.

Accessors

`Static`ZERO

get ZERO(): Vector3
Returns a Vector3 with 0 on all axis.

Returns Vector3
Inherited from Position.ZERO
- Defined in packages/math/src/Vector3.ts:10

Methods

equals

equals(vector: EntityLike): boolean
Compare an instance of Vector3 with another.
Parameters
- vector: EntityLike
  The Vector3 to compare to.
Returns boolean
true if they're equal otherwise false.
Inherited from Position.equals
- Defined in packages/math/src/Vector3.ts:86

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.
Inherited from Position.floor
- Defined in packages/math/src/Vector3.ts:69

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);
```
- Defined in packages/prismarine/src/entity/Entity.ts:106

getPosition

getPosition(): Vector3
Get the entity's position.

Returns Vector3
The entity's position.
Example
```
const position = entity.getPosition();
```
- Defined in packages/prismarine/src/entity/Entity.ts:91

getRuntimeId

getRuntimeId(): bigint
Get the entity's runtime id.

Returns bigint
The entity's runtime id.
- Defined in packages/prismarine/src/entity/Entity.ts:71

getServer

getServer(): Server
Get the server instance.

Returns Server
The server instance.
- Defined in packages/prismarine/src/entity/Entity.ts:79

getWorld

getWorld(): World
Get the world of the position.

Returns World
The world of the position.
Inherited from Position.getWorld
- Defined in packages/prismarine/src/world/Position.ts:44

getX

getX(): number
Get the x coordinate.

Returns number
The x coordinate's value.
Inherited from Position.getX
- Defined in packages/math/src/Vector2.ts:67

getY

getY(): number
Get the y coordinate.

Returns number
The y coordinate's value.
Inherited from Position.getY
- Defined in packages/math/src/Vector3.ts:61

getZ

getZ(): number
Get the z coordinate.

Returns number
The z coordinate's value.
Inherited from Position.getZ
- Defined in packages/math/src/Vector2.ts:75

setWorld

setWorld(world: World): void
Set the world of the position.
Parameters
- world: World
  The world to set.
Returns void
Inherited from Position.setWorld
- Defined in packages/prismarine/src/world/Position.ts:57

setX

setX(x: number): void
Set the X coordinate.
Parameters
- x: number
  The X coordinate.
Returns void
Example
```
await entity.setX(10);
```
Inherited from Position.setX
- Defined in packages/math/src/Vector2.ts:47

setY

setY(y: number): void
Set the Y coordinate.
Parameters
- y: number
  The Y coordinate.
Returns void
Example
```
entity.setY(10);
```
Inherited from Position.setY
- Defined in packages/math/src/Vector3.ts:53

setZ

setZ(z: number): void
Set the Z coordinate.
Parameters
- z: number
  The Z coordinate.
Returns void
Example
```
await entity.setZ(10);
```
Inherited from Position.setZ
- Defined in packages/math/src/Vector2.ts:59

toString

toString(): string
Returns string
Inherited from Position.toString
- Defined in packages/prismarine/src/world/Position.ts:26

trunc

trunc(): Vector3
Returns a new Vector3 with each component truncated to the nearest integer.

Returns Vector3
A new Vector3 with truncated axis.
Inherited from Position.trunc
- Defined in packages/math/src/Vector3.ts:77

`Static`fromObject

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.
Inherited from Position.fromObject
- Defined in packages/math/src/Vector3.ts:41

`Static`fromVector3

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.
Inherited from Position.fromVector3
- Defined in packages/prismarine/src/world/Position.ts:36