Class PlayerSession

Constructors

constructor

new PlayerSession(
    server: Server,
    connection: ClientConnection,
    player: Player,
): PlayerSession
Parameters
- server: Server
- connection: ClientConnection
- player: Player
Returns PlayerSession
- Defined in packages/prismarine/src/network/PlayerSession.ts:61

Methods

addToPlayerList

addToPlayerList(): Promise<void>
Adds the client to the player list of every player inside the server and also to the player itself.

Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:533

broadcastMove

broadcastMove(player: Player, mode?: MovementType): Promise<void>
Broadcast the movement to a defined player
Parameters
- player: Player
- mode: MovementType = MovementType.Normal
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:505

clearChunks

clearChunks(): Promise<void>
Clear the currently loaded and loading chunks.

Returns Promise<void>
Remarks
Usually used for changing dimension, world, etc.
- Defined in packages/prismarine/src/network/PlayerSession.ts:229

getConnection

getConnection(): ClientConnection
Returns ClientConnection
- Defined in packages/prismarine/src/network/PlayerSession.ts:641

getPlayer

getPlayer(): Player
Returns Player
- Defined in packages/prismarine/src/network/PlayerSession.ts:645

kick

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

needNewChunks

needNewChunks(forceResend?: boolean, dist?: number): Promise<void>
Parameters
- forceResend: boolean = false
- Optionaldist: number
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:147

removeFromPlayerList

removeFromPlayerList(): Promise<void>
Removes a player from other players list

Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:557

requestChunk

requestChunk(x: number, z: number): Promise<void>
Parameters
- x: number
- z: number
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:218

send

send(packet: DataPacket): Promise<void>
Parameters
- packet: DataPacket
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:90

sendAbilities

sendAbilities(player?: Player): Promise<void>
Parameters
- Optionalplayer: Player
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:111

sendAttributes

sendAttributes(attributes?: Attributes): Promise<void>
Parameters
- Optionalattributes: Attributes
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:426

sendAvailableCommands

sendAvailableCommands(): Promise<void>
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:320

sendChunk

sendChunk(chunk: Chunk): Promise<void>
Parameters
- chunk: Chunk
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:487

sendCreativeContents

sendCreativeContents(empty?: boolean): Promise<void>
Parameters
- empty: boolean = false
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:245

sendDespawn

sendDespawn(player: Player): Promise<void>
Despawn the player entity from another player
Parameters
- player: Player
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:622

sendGamemode

sendGamemode(gamemode?: Gametype): Promise<void>
Send gamemode to a client.
Parameters
- Optionalgamemode: Gametype
  the numeric gamemode ID.
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:306

sendHandItem

sendHandItem(item: Item): Promise<void>
Sets the item in the player hand.
Parameters
- item: Item
  The entity.
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:282

sendInventory

sendInventory(): Promise<void>
@TODO: Implement this.

Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:237

sendMessage

sendMessage(
    options: {
        message: string;
        needsTranslation?: boolean;
        parameters?: string[];
        platformChatId?: string;
        sourceName?: string;
        type?: TextType;
        xuid?: string;
    },
): Promise<void>
Send a chat message to the client.
Parameters
- options: {
      message: string;
      needsTranslation?: boolean;
      parameters?: string[];
      platformChatId?: string;
      sourceName?: string;
      type?: TextType;
      xuid?: string;
  }
  The options for the message.
  - message: string
    The message to send.
  - OptionalneedsTranslation?: boolean
    Whether the message needs translation.
  - Optionalparameters?: string[]
    The parameters for the message.
  - OptionalplatformChatId?: string
    The platform chat ID.
  - OptionalsourceName?: string
    The source of the message.
  - Optionaltype?: TextType
    The type of the message.
  - Optionalxuid?: string
    The XUID of the player.
Returns Promise<void>
A promise that resolves when the message is sent.
- Defined in packages/prismarine/src/network/PlayerSession.ts:456

sendMetadata

sendMetadata(metadata?: Metadata): Promise<void>
Parameters
- Optionalmetadata: Metadata
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:436

sendNetworkChunkPublisher

sendNetworkChunkPublisher(
distance: number,
savedChunks: ChunkCoord[],
): Promise<void>
Parameters
- distance: number
- savedChunks: ChunkCoord[]
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:312

sendPlayerList

sendPlayerList(): Promise<void>
Sends the full player list to the player.

Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:573

sendPlayStatus

sendPlayStatus(status: number): Promise<void>
Parameters
- status: number
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:628

sendSettings

sendSettings(player?: Player): Promise<void>
Notify a client about change(s) to the adventure settings.
Parameters
- Optionalplayer: Player
  The client-controlled entity
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:99

sendSpawn

sendSpawn(player: Player): Promise<void>
Spawn the player for another player
Parameters
- player: Player
  the player to send the AddPlayerPacket to
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:585

sendTime

sendTime(tick: number): Promise<void>
Send the current tick to a client.
Parameters
- tick: number
  The tick
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:296

setViewDistance

setViewDistance(distance: number): Promise<void>
Set the client's maximum view distance.
Parameters
- distance: number
  The view distance
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:420

update

update(_tick: number): Promise<void>
Parameters
- _tick: number
Returns Promise<void>
- Defined in packages/prismarine/src/network/PlayerSession.ts:67

Class PlayerSession

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PlayerSession

Methods

addToPlayerList

Returns Promise<void>

broadcastMove

Parameters

Returns Promise<void>

clearChunks

Returns Promise<void>

Remarks

getConnection

Returns ClientConnection

getPlayer

Returns Player

kick

Parameters

Returns Promise<void>

needNewChunks

Parameters

Returns Promise<void>

removeFromPlayerList

Returns Promise<void>

requestChunk

Parameters

Returns Promise<void>

send

Parameters

Returns Promise<void>

sendAbilities

Parameters

Returns Promise<void>

sendAttributes

Parameters

Returns Promise<void>

sendAvailableCommands

Returns Promise<void>

sendChunk

Parameters

Returns Promise<void>

sendCreativeContents

Parameters

Returns Promise<void>

sendDespawn

Parameters

Returns Promise<void>

sendGamemode

Parameters

Returns Promise<void>

sendHandItem

Parameters

Returns Promise<void>

sendInventory

Returns Promise<void>

sendMessage

Parameters

message: string

OptionalneedsTranslation?: boolean

Optionalparameters?: string[]

OptionalplatformChatId?: string

OptionalsourceName?: string

Optionaltype?: TextType

Optionalxuid?: string

Returns Promise<void>

sendMetadata

Parameters

Returns Promise<void>

sendNetworkChunkPublisher

Parameters

Returns Promise<void>

sendPlayerList

Returns Promise<void>

sendPlayStatus

Parameters

`Optional`needsTranslation?: boolean

`Optional`parameters?: string[]

`Optional`platformChatId?: string

`Optional`sourceName?: string

`Optional`type?: TextType

`Optional`xuid?: string