Interface ConnectedPacket

Sent to clients when the connection handshake is successfully completed.

interface ConnectedPacket {
    checked_locations: number[];
    cmd: "Connected";
    hint_points: number;
    missing_locations: number[];
    players: NetworkPlayer[];
    slot: number;
    slot_data: JSONSerializable;
    slot_info: Record<string, NetworkSlot>;
    team: number;
}

Properties

checked_locations: number[]

Contains integer ids of all locations that have been checked. Useful for trackers, among other things. Location ids are valid in the range of -2^53^ to +(2^53)-1 (inclusive), with negative values and zero reserved for Archipelago.

cmd
hint_points: number

Number of hint points that the current player has.

missing_locations: number[]

Contains integer ids of remaining locations that need to be checked. Useful for trackers, among other things.

players: NetworkPlayer[]

List denoting other players in the multi-world, whether connected or not.

slot: number

Your slot number on your team. See NetworkPlayer for more info on the slot number.

slot_data: JSONSerializable

Contains an object of slot related data, which differs per slot. If slot data was not requested in the ConnectPacket, this value be an empty object.

slot_info: Record<string, NetworkSlot>

Object of each slot with their NetworkSlot information.

team: number

Your team number. See NetworkPlayer for more info on team number.