SharedState

Source: state.ts:163

For managing shared data between classes

Type Parameters

IsReady extends boolean = boolean

Constructors

`new SharedState< IsReady extends boolean = boolean, >( clientOptions: ClientOption, ): SharedState<IsReady>`

Parameters

clientOptions (ClientOption)

Returns

SharedState<IsReady>

Properties

`authClient: AuthClient | undefined`

state.ts:173

Default: undefined

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

state.ts:193

Default: undefined

`cipher: Cipheriv | undefined`

state.ts:182

Default: undefined

`clientOptions: ClientOption`

state.ts:204

`compressionThreshold: number`

state.ts:170

Default: 0

`decipher: Decipheriv | undefined`

state.ts:183

Default: undefined

`messageCount: number`

state.ts:191

Default: 0

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

state.ts:200

For maintaining message order.

A UUID map to a MessageLink.

Default: undefined

`messageSignatureCache: SignatureCache | undefined`

state.ts:201

Default: undefined

`player: If<IsReady, ClientPlayer>`

state.ts:190

`playerUUID: string | undefined`

state.ts:174

Default: undefined

`publicKey: Buffer<ArrayBufferLike> | undefined`

state.ts:175

Default: undefined

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

state.ts:188

Default: undefined

`server: Server | undefined`

state.ts:187

Default: undefined

`sessionID: Buffer<ArrayBufferLike> | undefined`

state.ts:185

Default: undefined

`sharedSecret: Buffer<ArrayBufferLike> | undefined`

state.ts:181

Default: undefined

`signature: Buffer<ArrayBufferLike> | undefined`

state.ts:176

Default: undefined

`signatureExpireTime: number | undefined`

state.ts:177

Default: undefined

`state: ConnectionState`

state.ts:168

Default: ConnectionState.Disconnected

`status: ClientStatus`

state.ts:169

Default: ClientStatus.Disconnected

`useEncryption: boolean`

state.ts:184

Default: false

`world: If<IsReady, ServerWorld>`

state.ts:189

Methods

`checkReady(): void`

state.ts:218

Returns

void

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

state.ts:330

Parameters

consumer ((event: EmittedEvent) => void)

Returns

void

`drainMutation(): void`

state.ts:321

Returns

void

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

state.ts:339

Parameters

consumer ((packet: SendingPacket) => void)

Returns

void

`enqueueEvent`

state.ts:309

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:295

Parameters

mutation (MutateState)

Returns

void

`enqueuePacket`

state.ts:297

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

Parameters

packet (string)
data (object)

Returns

void

enqueuePacket(packet: SendingPacket): void

Parameters

packet (SendingPacket)

Returns

void

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

state.ts:267

Returns

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

`isReady(): this is SharedState<true>`

state.ts:214

Returns

this is SharedState<true>

`pruneStates(): void`

state.ts:223

Returns

void

`startSignatureLoop(): Promise<void>`

state.ts:284

Returns

Promise<void>

`stopSignatureLoop(): void`

state.ts:291

Returns

void