Interface: ModState¶

In-game state container for mods. Changes are automatically synced to clients.

Table of contents¶

Methods¶

clearPlayerColor¶

▸ clearPlayerColor(playerId): void

Parameters¶

Name	Type
`playerId`	`string`

Returns¶

void

clearPlayerSkinGridColor¶

▸ clearPlayerSkinGridColor(playerId): void

Parameters¶

Name	Type
`playerId`	`string`

Returns¶

void

delete¶

▸ delete(key): boolean

Parameters¶

Name	Type
`key`	`string`

Returns¶

boolean

get¶

▸ get\<T>(key): undefined | T

Type parameters¶

Name	Type
`T`	`unknown`

Parameters¶

Name	Type
`key`	`string`

Returns¶

undefined | T

getPlayerColor¶

▸ getPlayerColor(playerId): null | PlayerColorOverride

Parameters¶

Name	Type
`playerId`	`string`

Returns¶

null | PlayerColorOverride

getPlayerSkinGridColor¶

▸ getPlayerSkinGridColor(playerId): null | PlayerSkinGridColorOverride

Parameters¶

Name	Type
`playerId`	`string`

Returns¶

null | PlayerSkinGridColorOverride

has¶

▸ has(key): boolean

Parameters¶

Name	Type
`key`	`string`

Returns¶

boolean

set¶

▸ set(key, value): void

Parameters¶

Name	Type
`key`	`string`
`value`	`unknown`

Returns¶

void

setPlayerColor¶

▸ setPlayerColor(playerId, fill, border): void

Parameters¶

Name	Type
`playerId`	`string`
`fill`	`string`
`border`	`string`

Returns¶

void

setPlayerSkinGridColor¶

▸ setPlayerSkinGridColor(playerId, color): void

Parameters¶

Name	Type
`playerId`	`string`
`color`	`SkinGridColor`

Returns¶

void

Source Code¶

View full implementation

/**
 * In-game state container for mods.
 * Changes are automatically synced to clients.
 */
export interface ModState {
  set(key: string, value: unknown): void;
  get<T = unknown>(key: string): T | undefined;
  has(key: string): boolean;
  delete(key: string): boolean;

  // Player colors
  setPlayerColor(playerId: string, fill: string, border: string): void;
  getPlayerColor(playerId: string): PlayerColorOverride | null;
  clearPlayerColor(playerId: string): void;

  // Skin grid overlay colors
  setPlayerSkinGridColor(playerId: string, color: SkinGridColor): void;
  getPlayerSkinGridColor(playerId: string): PlayerSkinGridColorOverride | null;
  clearPlayerSkinGridColor(playerId: string): void;
}