Interface ConnectPacket

Sent by the client to authenticate a connection to an Archipelago session.

interface ConnectPacket {
    cmd: "Connect";
    game: string;
    items_handling: number;
    name: string;
    password: string;
    slot_data: boolean;
    tags: string[];
    uuid: string;
    version: NetworkVersion;
}

Properties

cmd game items_handling name password slot_data tags uuid version

Properties

Readonlycmd

cmd

Readonlygame

game: string

The name of the game the client is playing.

Readonlyitems_handling

items_handling: number

Bit flags configuring which items should be sent by the server. See itemsHandlingFlags for information on individual flags.

Readonlyname

name: string

The slot name for this client.

Readonlypassword

password: string

If the game session requires a password, it should be passed here.

Readonlyslot_data

slot_data: boolean

If true, the ConnectedPacket will contain slot data.

Readonlytags

tags: string[]

Denotes special features or capabilities that the sender is currently capable of.

Readonlyuuid

uuid: string

Unique identifier for player client.

Readonlyversion

version: NetworkVersion

An object representing the minimum Archipelago server version this client supports.

Settings

Member Visibility

On This Page

Properties