SharedState

Source: state.ts:195

For managing shared data between classes

Constructors

`new SharedState(clientOptions: ClientOption): SharedState`

Parameters

clientOptions (ClientOption)

Returns

SharedState

Properties

`authClient: AuthClient | undefined`

state.ts:205

Default: undefined

`cache: CacheImplementation<Uint16Array<ArrayBufferLike>> | undefined`

state.ts:230

Default: undefined

`chunkBatchCalculator: ChunkBatchCalculator`

state.ts:226

`cipher: Cipheriv | undefined`

state.ts:214

Default: undefined

`clientOptions: ClientOption`

state.ts:241

`compressionThreshold: number`

state.ts:202

Default: 0

`decipher: Decipheriv | undefined`

state.ts:215

Default: undefined

`lastPing: number`

state.ts:228

Default: -1

`messageCount: number`

state.ts:224

Default: 0

`messageLinks: Record<string, MessageLink> | undefined`

state.ts:237

For maintaining message order.

A UUID map to a MessageLink.

Default: undefined

`messageSignatureCache: SignatureCache | undefined`

state.ts:238

Default: undefined

`openingContainer: Container | undefined`

state.ts:225

Default: undefined

`player: ClientPlayer | null`

state.ts:223

Default: null

`playerUUID: string | undefined`

state.ts:206

Default: undefined

`publicKey: Buffer<ArrayBufferLike> | undefined`

state.ts:207

Default: undefined

`registry: Record<string, ServerRegistryEntry[]> | undefined`

state.ts:221

Default: undefined

`sequence: number`

state.ts:218

Default: 0

`server: Server | undefined`

state.ts:220

Default: undefined

`sessionID: Buffer<ArrayBufferLike> | undefined`

state.ts:217

Default: undefined

`sharedSecret: Buffer<ArrayBufferLike> | undefined`

state.ts:213

Default: undefined

`signature: Buffer<ArrayBufferLike> | undefined`

state.ts:208

Default: undefined

`signatureExpireTime: number | undefined`

state.ts:209

Default: undefined

`state: ConnectionState`

state.ts:200

Default: ConnectionState.Disconnected

`status: ClientStatus`

state.ts:201

Default: ClientStatus.Disconnected

`tickCalculator: TickCalculator`

state.ts:227

`useEncryption: boolean`

state.ts:216

Default: false

`world: ServerWorld | null`

state.ts:222

Default: null

Methods

`checkReady(): void`

state.ts:257

Returns

void

`drainEvent(consumer: (event: EmittedEvent) => void): void`

state.ts:380

Parameters

consumer ((event: EmittedEvent) => void)

Returns

void

`drainMutation(): void`

state.ts:371

Returns

void

`drainPacket(consumer: (packet: SendingPacket) => void): void`

state.ts:389

Parameters

consumer ((packet: SendingPacket) => void)

Returns

void

`enqueueEvent`

state.ts:359

enqueueEvent<
K extends keyof ClientEvents,
>(
event: K,
...args: ClientEvents[K],
): void

Type Parameters

K extends keyof ClientEvents

Parameters

event (K)
args (ClientEvents[K])

Returns

void

enqueueEvent(event: EmittedEvent): void

Parameters

event (EmittedEvent)

Returns

void

`enqueueMutation(mutation: MutateState): void`

state.ts:345

Parameters

mutation (MutateState)

Returns

void

`enqueuePacket`

state.ts:347

enqueuePacket(packet: string, data: object): void

Parameters

packet (string)
data (object)

Returns

void

enqueuePacket(packet: SendingPacket): void

Parameters

packet (SendingPacket)

Returns

void

`getProtocolId(): number`

state.ts:310

Returns

number

`getSignature( ): { publicKey: Buffer<ArrayBufferLike>; signature: Buffer<ArrayBufferLike> }`

state.ts:314

Returns

{ publicKey: Buffer<ArrayBufferLike>; signature: Buffer<ArrayBufferLike> }

`isReady(): boolean`

state.ts:253

Returns

boolean

`nextSequence(): number`

state.ts:322

Returns

number

`pruneStates(): void`

state.ts:262

Returns

void

`startSignatureLoop(): Promise<void>`

state.ts:334

Returns

Promise<void>

`stopSignatureLoop(): void`

state.ts:341

Returns

void