Interface ConnectionOptions

An interface of additional connection arguments when authenticating to an Archipelago server.

interface ConnectionOptions {
    items?: number;
    password?: string;
    slotData?: boolean;
    tags?: string[];
    uuid?: string;
    version?: {
        build: number;
        major: number;
        minor: number;
    };
}

Properties

items? password? slotData? tags? uuid? version?

Properties

Optionalitems

items?: number

Determines the kinds of received item events the server will broadcast to this client when locations are checked.

Value is an integer bitflag combination of values that is documented in itemsHandlingFlags.

Default

itemsHandlingFlags.all

Remarks

Defaults to request all received item events, so unless you need local-only functionality this property can usually be omitted.

Optional Readonlypassword

password?: string

The room password, if the server requires a password to join. Otherwise, optional.

Default

""

Optional ReadonlyslotData

slotData?: boolean

Request this slot's data during connection. If false, server will respond with an empty object ({}) instead.

Default

true

Optionaltags

tags?: string[]

A list of strings that denote special features or capabilities this sender is currently capable of. A list of common tags is documented here:

https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/network%20protocol.md#tags.

Default

[]

Optional Readonlyuuid

uuid?: string

A unique identifier for this client.

Not currently used for anything server side, but may change or be deprecated in a future Archipelago update.

Remarks

Defaults to a randomly generated v4 UUID.

Optional Readonlyversion

version?: {
    build: number;
    major: number;
    minor: number;
}

The version of Archipelago this client was designed for. This can be enforced on the server side to force a user to update their client, if a new version was released.

Type declaration

  • Readonlybuild: number

    The build version component.

  • Readonlymajor: number

    The major version component.

  • Readonlyminor: number

    The minor version component.

Default

targetVersion

Settings

Member Visibility

On This Page

Properties