Interface ConnectionOptions
items?: number;
password?: string;
slotData?: boolean;
tags?: string[];
uuid?: string;
version?: {
build: number;
major: number;
minor: number;
};
}
Properties
Optionalitems
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.
Optional Readonlypassword
The room password, if the server requires a password to join. Otherwise, optional.
Optional ReadonlyslotData
Request this slot's data during connection. If false, server will respond with an empty object ({}) instead.
Optionaltags
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.
Optional Readonlyuuid
A unique identifier for this client.
Not currently used for anything server side, but may change or be deprecated in a future Archipelago update.
Optional Readonlyversion
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: numberThe build version component.
Readonlymajor: numberThe major version component.
Readonlyminor: numberThe minor version component.
An interface of additional connection arguments when authenticating to an Archipelago server.