Class Item
An abstraction of NetworkItem that exposes additional helper methods and accessors for this item data.
- Index
Accessors
Class Item
An abstraction of NetworkItem that exposes additional helper methods and accessors for this item data.
+ Index
Accessors
Methods
Accessors
filler
- get filler(): boolean
Returns
-trueif this item has no special flags.Returns boolean
flags
- get flags(): number
Returns the item classification bitflags for this item.
-Returns number
game
- get game(): string
Returns the game name for this item.
-Returns string
location
- get locationGame(): string
Returns the game name for the location this item was contained.
-Returns string
location
- get locationId(): number
Returns the id of the location where this item was contained.
-Returns number
location
- get locationName(): string
Returns the name of the location where this item was contained.
-Returns string
name
- get name(): string
Returns the name of this item.
-Returns string
progression
- get progression(): boolean
Returns
-trueif this item is flagged as progression.Returns boolean
receiver
sender
trap
- get trap(): boolean
Returns
-trueif this item is flagged as a trap.Returns boolean
useful
- get useful(): boolean
Returns
-trueif this item is flagged as useful.Returns boolean
Returns boolean
flags
- get flags(): number
Returns the item classification bitflags for this item.
+Returns number
game
- get game(): string
Returns the game name for this item.
+Returns string
id
- get id(): number
Returns the integer id of this item.
+Returns number
location
- get locationGame(): string
Returns the game name for the location this item was contained.
+Returns string
location
- get locationId(): number
Returns the id of the location where this item was contained.
+Returns number
location
- get locationName(): string
Returns the name of the location where this item was contained.
+Returns string
name
- get name(): string
Returns the name of this item.
+Returns string
progression
- get progression(): boolean
Returns
+trueif this item is flagged as progression.Returns boolean
receiver
sender
trap
- get trap(): boolean
Returns
+trueif this item is flagged as a trap.Returns boolean
useful
- get useful(): boolean
Returns
+trueif this item is flagged as useful.Returns boolean
Class ItemsManager
Manages tracking and receiving of all received items and hints.
-Hierarchy (view full)
- EventBasedManager<ItemEvents>
- ItemsManager
Index
Accessors
Class ItemsManager
Manages tracking and receiving of all received items and hints.
+Hierarchy (view full)
- EventBasedManager<ItemEvents>
- ItemsManager
Accessors
count
- get count(): number
Return the number of items received.
-Returns number
hints
- get hints(): Hint[]
Returns a copy of all hints for this player.
+Returns number
hints
- get hints(): Hint[]
Returns a copy of all hints for this player.
Returns Hint[]
Remarks
Hints may take a moment to populate after establishing connection to server, as it needs to wait for data storage to fetch all current hints. If you need hints right after connecting, listen for the ItemEvents.hintsInitialized event.
-
received
Methods
off
- off<Event>(event, listener): this
Removes an existing event listener.
+
received
Methods
off
- off<Event>(event, listener): this
Removes an existing event listener.
Type Parameters
Parameters
- event: Event
The event name associated with this listener to remove.
- listener: ((...args: ItemEvents[Event]) => void)
The callback function to remove.
- (...args): void
Parameters
Rest...args: ItemEvents[Event]
Returns void
Returns this
This object.
-- event: Event
on
- on<Event>(event, listener): this
- +
Add an event listener for a specific event.
+on
- on<Event>(event, listener): this
Add an event listener for a specific event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- listener: ((...args: ItemEvents[Event]) => void)
The callback function to fire when this event is received.
- (...args): void
Parameters
Rest...args: ItemEvents[Event]
Returns void
Returns this
This object.
-- event: Event
wait
- wait<Event>(event, clearPredicate?): Promise<ItemEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments +
wait
- wait<Event>(event, clearPredicate?): Promise<ItemEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments dispatched with the event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- clearPredicate: ((...args: ItemEvents[Event]) => boolean) = ...
An optional predicate to check on incoming events to validate if the correct event has been received. If omitted, will return immediately on next event type received.
-- (...args): boolean
Parameters
Rest...args: ItemEvents[Event]
Returns boolean
Returns Promise<ItemEvents[Event]>
- event: Event
- (...args): boolean
Parameters
Rest...args: ItemEvents[Event]
Returns boolean
Returns Promise<ItemEvents[Event]>
Class MessageManager
Manages and stores PrintJSONPacket messages, notifies subscribers of new messages, and exposes helper methods +
Class MessageManager
Manages and stores PrintJSONPacket messages, notifies subscribers of new messages, and exposes helper methods to interact with the chat system.
-Hierarchy (view full)
- EventBasedManager<MessageEvents>
- MessageManager
Index
Accessors
Hierarchy (view full)
- EventBasedManager<MessageEvents>
- MessageManager
Accessors
messages
- get messages(): {
message: string;
packet: PrintJSONPacket;
}[] Returns all current chat messages that are logged.
If the messages length is greater than ClientOptions.maximumMessages, the oldest messages are spliced out.
-Returns {
message: string;
packet: PrintJSONPacket;
}[]
Methods
chat
- chat(text): Promise<void>
Sends a chat message to the server.
+Returns {
message: string;
packet: PrintJSONPacket;
}[]
Methods
chat
off
- off<Event>(event, listener): this
Removes an existing event listener.
+
off
- off<Event>(event, listener): this
Removes an existing event listener.
Type Parameters
Parameters
- event: Event
The event name associated with this listener to remove.
- listener: ((...args: MessageEvents[Event]) => void)
The callback function to remove.
- (...args): void
Parameters
Rest...args: MessageEvents[Event]
Returns void
Returns this
This object.
-- event: Event
on
- on<Event>(event, listener): this
- +
Add an event listener for a specific event.
+on
- on<Event>(event, listener): this
Add an event listener for a specific event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- listener: ((...args: MessageEvents[Event]) => void)
The callback function to fire when this event is received.
- (...args): void
Parameters
Rest...args: MessageEvents[Event]
Returns void
Returns this
This object.
-- event: Event
wait
- wait<Event>(event, clearPredicate?): Promise<MessageEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments +
wait
- wait<Event>(event, clearPredicate?): Promise<MessageEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments dispatched with the event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- clearPredicate: ((...args: MessageEvents[Event]) => boolean) = ...
An optional predicate to check on incoming events to validate if the correct event has been received. If omitted, will return immediately on next event type received.
-- (...args): boolean
Parameters
Rest...args: MessageEvents[Event]
Returns boolean
Returns Promise<MessageEvents[Event]>
- event: Event
- (...args): boolean
Parameters
Rest...args: MessageEvents[Event]
Returns boolean
Returns Promise<MessageEvents[Event]>
Class Package
An abstraction of a GamePackage object which includes additional helper methods for interacting with a game's +
Class Package
An abstraction of a GamePackage object which includes additional helper methods for interacting with a game's package.
- Index
Properties
Index
Properties
Methods
Properties
Readonlychecksum
The SHA256 hexadecimal string representation of this game package.
-Readonlygame
The name of the game this game package is for.
-Readonlyitem
A record of names to ids for all items in this game package.
-Readonlylocation
A record of names to ids for all locations in this game package.
-Readonlyreverse
A record of ids to names for all items in this game package.
-Readonlyreverse
A record of ids to names for all locations in this game package.
- Methods
export
- export
Package(): GamePackage Returns a network-safe GamePackage that can be cached and preloaded ahead of time to reduce network load.
-Returns GamePackage
Readonlygame
The name of the game this game package is for.
+Readonlyitem
A record of names to ids for all items in this game package.
+Readonlylocation
A record of names to ids for all locations in this game package.
+Readonlyreverse
A record of ids to names for all items in this game package.
+Readonlyreverse
A record of ids to names for all locations in this game package.
+ Methods
export
- export
Package(): GamePackage Returns a network-safe GamePackage that can be cached and preloaded ahead of time to reduce network load.
+Returns GamePackage
Class Player
A collection of metadata and helper methods for interacting with a particular player.
- Index
Accessors
Class Player
A collection of metadata and helper methods for interacting with a particular player.
+ Accessors
alias
- get alias(): string
Returns the current nickname for this player or the slot name if not set.
-Returns string
game
- get game(): string
Returns the game this slot is playing.
-Returns string
groups
members
name
- get name(): string
Returns the slot name for this player slot.
-Returns string
slot
- get slot(): number
Returns this slot's id.
-Returns number
team
- get team(): number
Returns the team id this player is a member of.
-Returns number
type
- get type(): 0 | 1 | 2
Returns the type of slot this player is. See slotTypes for more information.
-Returns 0 | 1 | 2
Methods
fetch
fetch
game
- get game(): string
Returns the game this slot is playing.
+Returns string
groups
members
name
- get name(): string
Returns the slot name for this player slot.
+Returns string
slot
- get slot(): number
Returns this slot's id.
+Returns number
team
- get team(): number
Returns the team id this player is a member of.
+Returns number
type
- get type(): 0 | 1 | 2
Returns the type of slot this player is. See slotTypes for more information.
+Returns 0 | 1 | 2
Methods
fetch
fetch
- fetch
Slot Data<SlotData>(): Promise<SlotData> Fetch this player's slot data over the network.
Type Parameters
- SlotData extends UnknownSlotData
Returns Promise<SlotData>
fetch
- fetch
Status(): Promise<ClientStatus> Returns this slot's current status. See clientStatuses for more information.
-Returns Promise<ClientStatus>
to
fetch
- fetch
Status(): Promise<ClientStatus> Returns this slot's current status. See clientStatuses for more information.
+Returns Promise<ClientStatus>
to
Class PlayersManager
Manages tracking and updating all players in the room session.
-Hierarchy (view full)
- EventBasedManager<PlayerEvents>
- PlayersManager
Index
Accessors
Class PlayersManager
Manages tracking and updating all players in the room session.
+Hierarchy (view full)
- EventBasedManager<PlayerEvents>
- PlayersManager
Accessors
self
slots
- get slots(): Readonly<Record<number, NetworkSlot>>
Returns a record of basic information for each slot.
+Returns Player
slots
- get slots(): Readonly<Record<number, NetworkSlot>>
Returns a record of basic information for each slot.
Returns Readonly<Record<number, NetworkSlot>>
Remarks
Slot information is shared across each team. For accessing player data, see PlayersManager.
-
teams
- get teams(): Player[][]
Returns a 2D array of player metadata ranked by team number, then slot number.
+
teams
Methods
find
- find
Player(team, slot): undefined | Player Attempt to find a player by their team or slot name.
+
Methods
find
- find
Player(team, slot): undefined | Player Attempt to find a player by their team or slot name.
Parameters
- team: number
The team id associated with the searched player.
- slot: number
The slot id associated with the searched player.
Returns undefined | Player
The player's metadata or
-undefinedif not found.- team: number
off
- off<Event>(event, listener): this
Removes an existing event listener.
+off
- off<Event>(event, listener): this
Removes an existing event listener.
Type Parameters
Parameters
- event: Event
The event name associated with this listener to remove.
- listener: ((...args: PlayerEvents[Event]) => void)
The callback function to remove.
- (...args): void
Parameters
Rest...args: PlayerEvents[Event]
Returns void
Returns this
This object.
-- event: Event
on
- on<Event>(event, listener): this
- +
Add an event listener for a specific event.
+on
- on<Event>(event, listener): this
Add an event listener for a specific event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- listener: ((...args: PlayerEvents[Event]) => void)
The callback function to fire when this event is received.
- (...args): void
Parameters
Rest...args: PlayerEvents[Event]
Returns void
Returns this
This object.
-- event: Event
wait
- wait<Event>(event, clearPredicate?): Promise<PlayerEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments +
wait
- wait<Event>(event, clearPredicate?): Promise<PlayerEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments dispatched with the event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- clearPredicate: ((...args: PlayerEvents[Event]) => boolean) = ...
An optional predicate to check on incoming events to validate if the correct event has been received. If omitted, will return immediately on next event type received.
-- (...args): boolean
Parameters
Rest...args: PlayerEvents[Event]
Returns boolean
Returns Promise<PlayerEvents[Event]>
- event: Event
- (...args): boolean
Parameters
Rest...args: PlayerEvents[Event]
Returns boolean
Returns Promise<PlayerEvents[Event]>
Class RoomStateManager
Managers room state information, notifies subscribers of changes, and exposes helper methods for interacting with the +
Class RoomStateManager
Managers room state information, notifies subscribers of changes, and exposes helper methods for interacting with the room.
-Hierarchy (view full)
- EventBasedManager<RoomStateEvents>
- RoomStateManager
Index
Accessors
Hierarchy (view full)
- EventBasedManager<RoomStateEvents>
- RoomStateManager
Index
Accessors
Accessors
all
- get allLocations(): number[]
Returns a list of all location ids for this slot.
-Returns number[]
checked
- get checkedLocations(): number[]
Returns a list of location ids that have been checked.
-Returns number[]
games
- get games(): string[]
Returns the list of games present in the current room.
-Returns string[]
generator
- get generatorVersion(): {
build: number;
major: number;
minor: number;
} Returns the version of Archipelago the seed was generated from.
+Returns number[]
checked
- get checkedLocations(): number[]
Returns a list of location ids that have been checked.
+Returns number[]
games
- get games(): string[]
Returns the list of games present in the current room.
+Returns string[]
generator
- get generatorVersion(): {
build: number;
major: number;
minor: number;
} Returns the version of Archipelago the seed was generated from.
Returns {
build: number;
major: number;
minor: number;
}build: number
major: number
minor: number
hint
- get hintCost(): number
Returns the amount of hint points this player needs to request a hint.
-Returns number
hint
- get hintCostPercentage(): number
Returns the percentage of locations that need to be checked to have enough points to hint from the server.
-Returns number
hint
- get hintPoints(): number
Returns the amount of hint points this player currently has.
-Returns number
location
- get locationCheckPoints(): number
Returns the amount of hint points received per location checked.
-Returns number
missing
- get missingLocations(): number[]
Returns a list of location ids that have not been checked.
-Returns number[]
password
- get password(): boolean
Returns
-trueif the room requires a password to join.Returns boolean
permissions
- get permissions(): PermissionTable
Returns the current room's command permission bitflags.
-Returns PermissionTable
race
- get race(): boolean
ExperimentalReturns if this seed was generated with race mode enabled (to be used to obscure unnecessary details to make +
hint
- get hintCost(): number
Returns the amount of hint points this player needs to request a hint.
+Returns number
hint
- get hintCostPercentage(): number
Returns the percentage of locations that need to be checked to have enough points to hint from the server.
+Returns number
hint
- get hintPoints(): number
Returns the amount of hint points this player currently has.
+Returns number
location
- get locationCheckPoints(): number
Returns the amount of hint points received per location checked.
+Returns number
missing
- get missingLocations(): number[]
Returns a list of location ids that have not been checked.
+Returns number[]
password
- get password(): boolean
Returns
+trueif the room requires a password to join.Returns boolean
permissions
- get permissions(): PermissionTable
Returns the current room's command permission bitflags.
+Returns PermissionTable
race
- get race(): boolean
ExperimentalReturns if this seed was generated with race mode enabled (to be used to obscure unnecessary details to make clients race legal depending on rules).
-Returns boolean
seed
- get seedName(): string
Get the seed name for this room.
+Returns boolean
seed
- get seedName(): string
Get the seed name for this room.
Returns string
server
- get serverVersion(): {
build: number;
major: number;
minor: number;
} Returns the version of Archipelago the server is currently running.
+
server
- get serverVersion(): {
build: number;
major: number;
minor: number;
} Returns the version of Archipelago the server is currently running.
Returns {
build: number;
major: number;
minor: number;
}build: number
major: number
minor: number
tags
- get tags(): string[]
Returns a list of tags the server is currently capable of.
-Returns string[]
Methods
off
- off<Event>(event, listener): this
Removes an existing event listener.
+
tags
- get tags(): string[]
Returns a list of tags the server is currently capable of.
+Returns string[]
Methods
off
- off<Event>(event, listener): this
Removes an existing event listener.
Type Parameters
Parameters
- event: Event
The event name associated with this listener to remove.
- listener: ((...args: RoomStateEvents[Event]) => void)
The callback function to remove.
- (...args): void
Parameters
Rest...args: RoomStateEvents[Event]
Returns void
Returns this
This object.
-- event: Event
on
- on<Event>(event, listener): this
- +
Add an event listener for a specific event.
+on
- on<Event>(event, listener): this
Add an event listener for a specific event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- listener: ((...args: RoomStateEvents[Event]) => void)
The callback function to fire when this event is received.
- (...args): void
Parameters
Rest...args: RoomStateEvents[Event]
Returns void
Returns this
This object.
-- event: Event
wait
- wait<Event>(event, clearPredicate?): Promise<RoomStateEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments +
wait
- wait<Event>(event, clearPredicate?): Promise<RoomStateEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments dispatched with the event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- clearPredicate: ((...args: RoomStateEvents[Event]) => boolean) = ...
An optional predicate to check on incoming events to validate if the correct event has been received. If omitted, will return immediately on next event type received.
-- (...args): boolean
Parameters
Rest...args: RoomStateEvents[Event]
Returns boolean
Returns Promise<RoomStateEvents[Event]>
- event: Event
- (...args): boolean
Parameters
Rest...args: RoomStateEvents[Event]
Returns boolean
Returns Promise<RoomStateEvents[Event]>
Class SocketManager
Manages socket-level communication and exposes helper methods/events for interacting with the Archipelago API +
Class SocketManager
Manages socket-level communication and exposes helper methods/events for interacting with the Archipelago API directly.
-Hierarchy (view full)
- EventBasedManager<SocketEvents>
- SocketManager
Index
Accessors
Hierarchy (view full)
- EventBasedManager<SocketEvents>
- SocketManager
Accessors
connected
- get connected(): boolean
Returns
-trueif currently connected to a websocket server.Returns boolean
url
- get url(): string
Returns the current connection's URL or an empty string, if not connected.
-Returns string
Methods
connect
- connect(url): Promise<RoomInfoPacket>
Establish a connection to an Archipelago server before authenticating; useful if there might be tasked that are +
Returns boolean
url
- get url(): string
Returns the current connection's URL or an empty string, if not connected.
+Returns string
Methods
connect
- connect(url): Promise<RoomInfoPacket>
Establish a connection to an Archipelago server before authenticating; useful if there might be tasked that are needed to be performed before authenticating, but after connecting (e.g., DataPackage).
Parameters
- url: string | URL
The url of the server, including the protocol (e.g.,
wss://archipelago.gg:38281).
Returns Promise<RoomInfoPacket>
The RoomInfoPacket received on initial connection.
- url: string | URL
disconnect
off
- off<Event>(event, listener): this
Removes an existing event listener.
+
disconnect
off
- off<Event>(event, listener): this
Removes an existing event listener.
Type Parameters
Parameters
- event: Event
The event name associated with this listener to remove.
- listener: ((...args: SocketEvents[Event]) => void)
The callback function to remove.
- (...args): void
Parameters
Rest...args: SocketEvents[Event]
Returns void
Returns this
This object.
-- event: Event
on
- on<Event>(event, listener): this
Add an event listener for a specific event.
+on
- on<Event>(event, listener): this
Add an event listener for a specific event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- listener: ((...args: SocketEvents[Event]) => void)
The callback function to fire when this event is received.
- (...args): void
Parameters
Rest...args: SocketEvents[Event]
Returns void
Returns this
This object.
-- event: Event
send
- send(...packets): SocketManager
Send a list of raw client packets to the server.
+send
- send(...packets): SocketManager
Send a list of raw client packets to the server.
Parameters
Rest...packets: ClientPacket[]List of client packets to send.
Returns SocketManager
This SocketManager.
wait
- wait<Event>(event, clearPredicate?): Promise<SocketEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments +
wait
- wait<Event>(event, clearPredicate?): Promise<SocketEvents[Event]>
Returns a promise that waits for a single specified event to be received. Resolves with the list of arguments dispatched with the event.
Type Parameters
Parameters
- event: Event
The event name to listen for.
- clearPredicate: ((...args: SocketEvents[Event]) => boolean) = ...
An optional predicate to check on incoming events to validate if the correct event has been received. If omitted, will return immediately on next event type received.
-- (...args): boolean
Parameters
Rest...args: SocketEvents[Event]
Returns boolean
Returns Promise<SocketEvents[Event]>
- event: Event
- (...args): boolean
Parameters
Rest...args: SocketEvents[Event]
Returns boolean
Returns Promise<SocketEvents[Event]>
archipelago.js - v2.0.0-rc1
Class Hierarchy
archipelago.js - v2.0.0-rc2
Class Hierarchy
archipelago.js - v2.0.0-rc1
Archipelago.js
archipelago.js - v2.0.0-rc2
Archipelago.js
@@ -27,4 +27,4 @@
Disclaimer / Call for Help
Currently, there are no automated tests for this library, so all testing in browser, Node, Deno, and Bun are done manually. This is certainly one area that can be expanded upon.
Alternatively, expanding upon the documentation (either through the JSDoc or tutorial-like guides) would be appreciated.
-Interface AdminCommandResultJSONPacket
Sent to relevant clients to broadcast the result of an admin command.
+Interface AdminCommandResultJSONPacket
Sent to relevant clients to broadcast the result of an admin command.
See
PrintJSONPacket for all possible PrintJSON packet subtypes.
cmd: "PrintJSON";
data: JSONMessagePart[];
type: "AdminCommandResult";
}
Index
Properties
cmd: "PrintJSON";
data: JSONMessagePart[];
type: "AdminCommandResult";
}
Properties
Readonlycmd
Readonlydata
All the textual metadata for this packet.
-Readonlytype
The PrintJSONPacket subtype.
- Properties
Readonlycmd
Readonlydata
All the textual metadata for this packet.
+Readonlytype
The PrintJSONPacket subtype.
+Interface BouncePacket
Sent by the client to be broadcast from the server to all connected clients that match any one of the filter +
Interface BouncePacket
Sent by the client to be broadcast from the server to all connected clients that match any one of the filter arguments.
cmd: "Bounce";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
Index
Properties
cmd: "Bounce";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
Properties
Readonlycmd
Readonlydata
Any data you want to send.
-Optional Readonlygames
Optional. Games that should receive this message.
-Optional Readonlyslots
Optional. Player ids that should receive this message.
-Optional Readonlytags
Optional. Client tags that should receive this message.
- Properties
Readonlycmd
Readonlydata
Any data you want to send.
+Optional Readonlygames
Optional. Games that should receive this message.
+Optional Readonlyslots
Optional. Player ids that should receive this message.
+Optional Readonlytags
Optional. Client tags that should receive this message.
+Interface BouncedPacket
Sent to clients after a client requested this message be sent to them, more info in the BouncePacket.
-cmd: "Bounced";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
Index
Properties
Interface BouncedPacket
Sent to clients after a client requested this message be sent to them, more info in the BouncePacket.
+cmd: "Bounced";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
Properties
Readonlycmd
Readonlydata
A verbatim copy of the data in the BouncePacket package.
-Optional Readonlygames
Optional. Game names this message is targeting.
-Optional Readonlyslots
Optional. Player slot IDs that this message is targeting.
-Optional Readonlytags
Optional. Client tags this message is targeting.
- Properties
Readonlycmd
Readonlydata
A verbatim copy of the data in the BouncePacket package.
+Optional Readonlygames
Optional. Game names this message is targeting.
+Optional Readonlyslots
Optional. Player slot IDs that this message is targeting.
+Optional Readonlytags
Optional. Client tags this message is targeting.
+Interface ChatJSONPacket
Sent to clients to broadcast a normal chat message.
+Interface ChatJSONPacket
Sent to clients to broadcast a normal chat message.
See
PrintJSONPacket for all possible PrintJSON packet subtypes.
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
slot: number;
team: number;
type: "Chat";
}
Index
Properties
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
slot: number;
team: number;
type: "Chat";
}
Properties
Readonlycmd
Readonlydata
All the textual metadata for this packet.
-Readonlymessage
Original chat message without sender prefix.
-Readonlyslot
Slot of the triggering player.
-Readonlyteam
Team of the triggering player.
-Readonlytype
The PrintJSONPacket subtype.
- Properties
Readonlycmd
Readonlydata
All the textual metadata for this packet.
+Readonlymessage
Original chat message without sender prefix.
+Readonlyslot
Slot of the triggering player.
+Readonlyteam
Team of the triggering player.
+Readonlytype
The PrintJSONPacket subtype.
+Interface CollectJSONPacket
Sent to clients to broadcast a player has collected all their remaining items from the multi-world.
+Interface CollectJSONPacket
Sent to clients to broadcast a player has collected all their remaining items from the multi-world.
See
PrintJSONPacket for all possible PrintJSON packet subtypes.
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Collect";
}
Index
Properties
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Collect";
}
Properties
Readonlycmd
Readonlydata
All the textual metadata for this packet.
-Readonlyslot
Slot of the triggering player.
-Readonlyteam
Team of the triggering player.
-Readonlytype
The PrintJSONPacket subtype.
- Properties
Readonlycmd
Readonlydata
All the textual metadata for this packet.
+Readonlyslot
Slot of the triggering player.
+Readonlyteam
Team of the triggering player.
+Readonlytype
The PrintJSONPacket subtype.
+
The client that connects to an Archipelago server and provides helper methods and objects to facilitate +
- Preparing search index...
- The search index is not available
archipelago.js - v2.0.0-rc2Class Client
The client that connects to an Archipelago server and provides helper methods and objects to facilitate communication, listen for events, and manage data.
-Index
Constructors
Index
Constructors
Properties
Constructors
constructor
Instantiates a new Archipelago client. After creating, call Client.login to connect and authenticate to a server.
Parameters
Optionaloptions: ClientOptionsAdditional configuration options for this client. See ClientOptions for more information.
-Returns Client
Properties
ReadonlydeathA helper object for handling DeathLink mechanics.
-ReadonlyitemsA helper object for handling received items and hints.
-ReadonlymessagesA helper object for handling chat messages.
-options
Current options for this client.
-ReadonlypackageA helper object for handling game data packages.
-ReadonlyplayersA helper object for handling players (including self).
-ReadonlyroomA helper object for handling room state.
-ReadonlysocketA helper object for handling websocket communication and AP network protocol.
-ReadonlystorageA helper object for handling the data storage API.
-Accessors
arguments
Returns a copy of this client's current connection arguments (or defaults, if never connected).
-Returns Required<ConnectionOptions>
authenticated
Returns
-trueif currently connected and authenticated to the Archipelago server.Returns boolean
game
Returns the client's current game name (or an empty string, if never connected).
-Returns string
name
Returns the client's current slot name (or an empty string, if never connected).
-Returns string
Methods
bounce
Send a bounce packet targeting any clients that fulfil any target parameters. Can be listened for by listening to +
Returns Client
Properties
ReadonlydeathA helper object for handling DeathLink mechanics.
+ReadonlyitemsA helper object for handling received items and hints.
+ReadonlymessagesA helper object for handling chat messages.
+options
Current options for this client.
+ReadonlypackageA helper object for handling game data packages.
+ReadonlyplayersA helper object for handling players (including self).
+ReadonlyroomA helper object for handling room state.
+ReadonlysocketA helper object for handling websocket communication and AP network protocol.
+ReadonlystorageA helper object for handling the data storage API.
+Accessors
arguments
Returns a copy of this client's current connection arguments (or defaults, if never connected).
+Returns Required<ConnectionOptions>
authenticated
Returns
+trueif currently connected and authenticated to the Archipelago server.Returns boolean
game
Returns the client's current game name (or an empty string, if never connected).
+Returns string
name
Returns the client's current slot name (or an empty string, if never connected).
+Returns string
Methods
bounce
Send a bounce packet targeting any clients that fulfil any target parameters. Can be listened for by listening to "bounced" events on SocketManager.
Parameters
games?: string[];
slots?: number[];
tags?: string[];
}
The targets to receive this bounce packet.
Optionalgames?: string[]Specific games that should receive this bounce.
@@ -48,13 +48,13 @@[p: string]: JSONSerializableData;
}
The json-serializable data to send.
[p: string]: JSONSerializableData
Returns void
Throws
Error If attempting to send a bounce while not authenticated.
Remarks
If no targets are specified, no clients will receive this bounce packet.
-check
Marks a list of locations as checked on the server.
+check
Marks a list of locations as checked on the server.
Parameters
Rest...locations: number[]Location ids to check.
Returns void
Throws
Error If attempting to check locations while not authenticated.
Remarks
Locations that do not exist or have already been checked in the multi-world are ignored.
-goal
A shorthand for running
Client.updateStatus(clientStatuses.goal). Once set, cannot be changed and if release +goal
A shorthand for running
-Client.updateStatus(clientStatuses.goal). Once set, cannot be changed and if release and/or collect is set to automatic, will release/collect all items.Returns void
login
Connect and authenticate to an Archipelago server.
+Returns void
login
Connect and authenticate to an Archipelago server.
Type Parameters
If slot data is requested, this sets the type of the returning slot data.
Parameters
The url of the server, including the protocol (e.g.,
wss://archipelago.gg:38281).The slot name this client will be connecting to.
@@ -69,7 +69,7 @@Example: TypeScript with Slot Data
-scout
Scout a list of locations for their containing items.
+