Class Player`Internal`

Represents a Player entity.

Hierarchy (View Summary)

Entities.Player
- Player

Constructors

constructor

new Player(
    __namedParameters: {
        connection: ClientConnection;
        server: Server;
        uuid?: string;
        world: World;
    },
): Player
Player's constructor.
Parameters
- __namedParameters: { connection: ClientConnection; server: Server; uuid?: string; world: World }
Returns Player
Overrides Player.constructor
- Defined in packages/prismarine/src/Player.ts:62

Properties

`Readonly`attributes

attributes: Attributes = ...

Entity attributes.

`Readonly`chunkSendQueue

chunkSendQueue: Set<Chunk> = ...

device

device: null | Device = null

gamemode

gamemode: Gametype = Gametype.WORLD_DEFAULT

headYaw

headYaw: number

`Protected`inventory

inventory: HumanInventory = ...

locale

locale: string = ''

`Readonly`metadata

metadata: Metadata = ...

Entity metadata.

pitch

pitch: number

platformChatId

platformChatId: string = ''

randomId

randomId: number = 0

`Protected` `Readonly`runtimeId

runtimeId: bigint

`Protected` `Readonly`server

server: Server

skin

skin: null | Skin = null

`Protected` `Readonly`uuid

uuid: string

viewDistance

viewDistance: number = 0

`Protected`x

x: number = 0

The X coordinate.

xuid

xuid: string = ''

`Protected`y

y: number

The Y coordinate.

yaw

yaw: number

`Protected`z

z: number = 0

The Z coordinate.

`Static`MOB_ID

MOB_ID: string = 'minecraft:player'

The entity's namespace ID.

`Static` `Internal`runtimeIdCount

runtimeIdCount: bigint = 0n

The global runtime id counter.

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Inherited from Human.[toStringTag]
- Defined in packages/prismarine/src/entity/Entity.ts:193

`Static`ZERO

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

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

Methods

equals

equals(vector: Player): boolean
Compare an instance of Vector3 with another.
Parameters
- vector: Player
  The Vector3 to compare to.
Returns boolean
true if they're equal otherwise false.
Inherited from Player.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 Player.floor
- Defined in packages/math/src/Vector3.ts:69

getAddress

getAddress(): InetAddress
Returns InetAddress
- Defined in packages/prismarine/src/Player.ts:351

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
```
Overrides Player.getFormattedUsername
- Defined in packages/prismarine/src/Player.ts:359

getInventory

getInventory(): HumanInventory
Returns HumanInventory
Inherited from Player.getInventory
- Defined in packages/prismarine/src/entity/Human.ts:12

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}`);
```
Overrides Player.getName
- Defined in packages/prismarine/src/Player.ts:355

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

getNetworkSession

getNetworkSession(): PlayerSession
Returns PlayerSession
- Defined in packages/prismarine/src/Player.ts:347

getPermissions

getPermissions(): string[]
Returns string[]
- Defined in packages/prismarine/src/Player.ts:363

getPosition

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

Returns Vector3
The entity's position.
Example
```
const position = entity.getPosition();
```
Inherited from Player.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.
Example
```
const entityId = entity.getRuntimeId();
console.log(entityId); // Ex. Output: 1n
```
Inherited from Player.getRuntimeId
- Defined in packages/prismarine/src/entity/Entity.ts:217

getServer

getServer(): Server
Get the server instance.

Returns Server
The server instance.
Example
```
const server = entity.getServer();
// Do things with the server.
```
Inherited from Player.getServer
- Defined in packages/prismarine/src/entity/Entity.ts:252

getType

getType(): string
Get the entity type.

Returns string
The entity's namespace ID.
Example
```
const entityType = entity.getType();
console.log(`Entity type: ${entityType}`);
```
Inherited from Player.getType
- Defined in packages/prismarine/src/entity/Entity.ts:152

getUUID

getUUID(): string
Get the entity's UUID.

Returns string
The entity's UUID.
```
console.log(entity.getUUID());
```
Inherited from Player.getUUID
- Defined in packages/prismarine/src/entity/Entity.ts:228

getWorld

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

Returns World
The world of the position.
Inherited from Player.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 Player.getX
- Defined in packages/math/src/Vector2.ts:67

getXUID

getXUID(): null | string
Get the XUID of the player.

Returns null | string
XUID of the player or null if not available
- Defined in packages/prismarine/src/Player.ts:371

getY

getY(): number
Get the y coordinate.

Returns number
The y coordinate's value.
Inherited from Player.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 Player.getZ
- Defined in packages/math/src/Vector2.ts:75

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');
}
```
Inherited from Player.isConsole
- Defined in packages/prismarine/src/entity/Entity.ts:428

isFlying

isFlying(): boolean
Returns boolean
- Defined in packages/prismarine/src/Player.ts:398

isOnGround

isOnGround(): boolean
Returns boolean
- Defined in packages/prismarine/src/Player.ts:426

isOnline

isOnline(): boolean
Returns boolean
- Defined in packages/prismarine/src/Player.ts:252

isOp

isOp(): boolean
Check if the Player is an operator.

Returns boolean
true if this player is an operator otherwise false.
- Defined in packages/prismarine/src/Player.ts:383

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');
}
```
Overrides Player.isPlayer
- Defined in packages/prismarine/src/Player.ts:375

isSneaking

isSneaking(): boolean
Returns boolean
- Defined in packages/prismarine/src/Player.ts:418

kick

kick(reason?: string): Promise<void>
Parameters
- reason: string = 'unknown reason'
Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:274

sendDespawn

sendDespawn(): Promise<void>
Despawn the entity.

Returns Promise<void>
A promise that resolves when the entity is despawned.
Overrides Player.sendDespawn
- Defined in packages/prismarine/src/Player.ts:303

sendInitialSpawnChunks

sendInitialSpawnChunks(): Promise<void>
Used to match vanilla behavior, will send chunks with an initial view radius of VANILLA_DEFAULT_SPAWN_RADIUS.

Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:174

sendMessage

sendMessage(
    message: string,
    type?: TextType,
    parameters?: string[],
    needsTranslation?: boolean,
): Promise<void>
Send a chat message to the client.
Parameters
- message: string
  the message
- type: TextType = TextType.Raw
- parameters: string[] = []
- needsTranslation: boolean = false
Returns Promise<void>
Overrides Player.sendMessage
- Defined in packages/prismarine/src/Player.ts:309

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.
Overrides Player.sendPosition
- Defined in packages/prismarine/src/Player.ts:473

sendSettings

sendSettings(): Promise<void>
Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:280

sendSpawn

sendSpawn(): Promise<void>
Player spawning logic.

Returns Promise<void>
Overrides Player.sendSpawn
- Defined in packages/prismarine/src/Player.ts:297

setFlying

setFlying(flying: boolean): Promise<void>
Parameters
- flying: boolean
Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:401

setGamemode

setGamemode(mode?: Gametype): Promise<void>
Parameters
- Optionalmode: Gametype
Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:325

setName

setName(name: string): void
Set the entity's name.
Parameters
- name: string
  The name.
Returns void
Example
```
entity.setName('Mr. Sheep');
```
Inherited from Player.setName
- Defined in packages/prismarine/src/entity/Entity.ts:453

setOnGround

setOnGround(val: boolean): Promise<void>
Parameters
- val: boolean
Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:429

setPosition

setPosition(
    options: {
        headYaw?: number;
        pitch?: number;
        position: Vector3;
        type?: MovementType;
        yaw?: number;
    },
    broadcast?: boolean,
): Promise<void>
Set the position.
Parameters
- options: {
      headYaw?: number;
      pitch?: number;
      position: Vector3;
      type?: MovementType;
      yaw?: number;
  }
  The options to set the position.
  - OptionalheadYaw?: number
    The new head yaw.
  - Optionalpitch?: number
    The new pitch.
  - position: Vector3
    The new position.
  - Optionaltype?: MovementType
    The movement type.
  - Optionalyaw?: number
    The new yaw.
- Optionalbroadcast: boolean = true
  Whether to broadcast the position change.
Returns Promise<void>
Remarks
This will notify the player's client about the position change.
Overrides Player.setPosition
- Defined in packages/prismarine/src/Player.ts:445

setSneaking

setSneaking(val: boolean): Promise<void>
Parameters
- val: boolean
Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:421

setSprinting

setSprinting(sprinting: boolean): Promise<void>
Parameters
- sprinting: boolean
Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:387

setWorld

setWorld(world: World): Promise<void>
Change the player's current world.
Parameters
- world: World
  the new world
Returns Promise<void>
Overrides Player.setWorld
- Defined in packages/prismarine/src/Player.ts:218

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);
```
Remarks
This method will also send the position update to the client if suppress is false.
Inherited from Player.setX
- Defined in packages/prismarine/src/entity/Entity.ts:332

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);
```
Remarks
This method will also send the position update to the client if suppress is false.
Inherited from Player.setY
- Defined in packages/prismarine/src/entity/Entity.ts:348

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);
```
Remarks
This method will also send the position update to the client if suppress is false.
Inherited from Player.setZ
- Defined in packages/prismarine/src/entity/Entity.ts:364

toString

toString(): string
Convert to a string representation.

Returns string
The string.
```
console.log(entity.toString());
```
Inherited from Player.toString
- Defined in packages/prismarine/src/entity/Entity.ts:204

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 Player.trunc
- Defined in packages/math/src/Vector3.ts:77

update

update(tick: number): Promise<void>
Fired every tick from the event subscription in the constructor.
Parameters
- tick: number
Returns Promise<void>
A promise that resolves when the update is complete.
Example
```
entity.update(10);
```
Overrides Player.update
- Defined in packages/prismarine/src/Player.ts:256

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

Lifecycle

disable

disable(): Promise<void>
On disable hook.

Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:127

enable

enable(): Promise<void>
On enable hook.

Returns Promise<void>
- Defined in packages/prismarine/src/Player.ts:92

Class PlayerInternal

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Lifecycle

Constructors

constructor

Parameters

Returns Player

Properties

Readonlyattributes

ReadonlychunkSendQueue

device

gamemode

headYaw

Protectedinventory

locale

Readonlymetadata

pitch

platformChatId

randomId

Protected ReadonlyruntimeId

Protected Readonlyserver

skin

Protected Readonlyuuid

viewDistance

Protectedx

xuid

Protectedy

yaw

Protectedz

StaticMOB_ID

Static InternalruntimeIdCount

Accessors

[toStringTag]

Returns string

StaticZERO

Returns Vector3

Methods

equals

Parameters

Returns boolean

floor

Returns Vector3

getAddress

Returns InetAddress

getFormattedUsername

Returns string

Example

getInventory

Returns HumanInventory

getName

Returns string

Example

getNearestEntity

Parameters

Returns Entity[]

Todo

Example

getNetworkSession

Returns PlayerSession

getPermissions

Returns string[]

getPosition

Returns Vector3

Example

getRuntimeId

Returns bigint

Example

getServer

Returns Server

Example

getType

Returns string

Example

getUUID

Returns string

Class Player`Internal`

`Readonly`attributes

`Readonly`chunkSendQueue

`Protected`inventory

`Readonly`metadata

`Protected` `Readonly`runtimeId

`Protected` `Readonly`server

`Protected` `Readonly`uuid

`Protected`x

`Protected`y

`Protected`z

`Static`MOB_ID

`Static` `Internal`runtimeIdCount

`Static`ZERO

`Optional`headYaw?: number

`Optional`pitch?: number

`Optional`type?: MovementType

`Optional`yaw?: number