Interface GetPacket

Sent by the client to request a single or multiple values from the server's data storage, see the SetPacket for how to write values to the data storage. A GetPacket will be answered with a RetrievedPacket.

Additional properties sent in this package will also be added to the RetrievedPacket it triggers.

Some special read-only keys exist with specific return data:

  • _read_hints_{team}_{slot}: NetworkHint[] - All hinted NetworkHint items relevant to the requested player.
  • _read_slot_data_{slot}: JSONSerializable - slot_data belonging to the requested slot.
  • _read_item_name_groups_{game}: Record<string, string[]> - An object of item groups and their members.
  • _read_location_name_groups_{game}: Record<string, string[]> - An object of location groups and their members.
  • _read_client_status_{team}_{slot}: number - The current status for the requested player. See clientStatuses for all known client statues.
  • _read_race_mode: number - Returns 0 if race mode is disabled, 1 if it's enabled.
interface GetPacket {
    cmd: "Get";
    keys: string[];
    [p: string]: JSONSerializable;
}

Indexable

Properties

Properties

cmd
keys: string[]

Keys to retrieve the values for.