-
diff --git a/classes/DataManager.html b/classes/DataManager.html
deleted file mode 100644
index f634b10..0000000
--- a/classes/DataManager.html
+++ /dev/null
@@ -1,378 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-add
-
-
- set
update
update
update
-
-
-Class Client<TSlotData>
Type Parameters
--
-
-
-
TSlotData = SlotData
Hierarchy
--
-
- Client
- Index
-
-
-
-
-
-
-
Constructors
-Accessors
-Methods
-Constructors
-constructor
-Accessors
-data
--
-
- get data(): DataManager<TSlotData> -
-
--
Get the DataManager helper object. See DataManager for additional information.
-Returns DataManager<TSlotData>
-
hints
--
-
- get hints(): HintsManager -
-
--
Get the HintsManager helper object. See HintsManager for additional information.
-Returns HintsManager
-
items
--
-
- get items(): ItemsManager -
-
--
Get the ItemsManager helper object. See ItemsManager for additional information.
-Returns ItemsManager
-
locations
--
-
- get locations(): LocationsManager -
-
--
Get the LocationsManager helper object. See LocationsManager for additional information.
-Returns LocationsManager
-
players
--
-
- get players(): PlayersManager -
-
--
Get the PlayersManager helper object. See PlayersManager for additional information.
-Returns PlayersManager
-
status
--
-
- get status(): ConnectionStatus -
-
--
Get the current WebSocket connection status to the Archipelago server.
-Returns ConnectionStatus
-
uri
--
-
- get uri(): undefined | string -
-
--
Get the URI of the current connection, including protocol.
-Returns undefined | string
-
Methods
-add
--
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "Bounced"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: BouncedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "Connected"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ConnectedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "ConnectionRefused"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ConnectionRefusedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "DataPackage"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: DataPackagePacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "InvalidPacket"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: InvalidPacketPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "LocationInfo"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: LocationInfoPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "PrintJSON"
--The event to listen for.
-
- -
-
listener: ((packet, message) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet, message): void -
-
---
Parameters
--
-
-
-
packet: PrintJSONPacket
- -
-
message: string
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "ReceivedItems"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ReceivedItemsPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "Retrieved"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: RetrievedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "RoomInfo"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: RoomInfoPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "RoomUpdate"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: RoomUpdatePacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "SetReply"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: SetReplyPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- add
Listener(event, listener): void
- -
--
Add an eventListener to fire depending on an event from the Archipelago server or the client.
---Parameters
--
-
-
-
event: "PacketReceived"
--The event to listen for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to run when an event is fired.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ServerPacket
Returns void
-
-
-
-
Returns void
- -
-
connect
--
-
- connect(info): Promise<ConnectedPacket> -
-
--
Connects to the given address with given connection information.
---Parameters
--
-
-
-
info: ConnectionInformation
--All the necessary connection information to connect to an Archipelago server.
-
Returns Promise<ConnectedPacket>
--Resolves
On successful connection and authentication to the room.
+Client | archipelago.js - v2.0.0-rc1 -Class 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
Properties
Accessors
Methods
Constructors
constructor
- new
Client(options?): Client 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
ReadonlydeathLink A 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
- get arguments(): Required<ConnectionOptions>
Returns a copy of this client's current connection arguments (or defaults, if never connected).
+Returns Required<ConnectionOptions>
authenticated
- get authenticated(): boolean
Returns
+trueif currently connected and authenticated to the Archipelago server.Returns boolean
game
- get game(): string
Returns the client's current game name (or an empty string, if never connected).
+Returns string
name
- get name(): string
Returns the client's current slot name (or an empty string, if never connected).
+Returns string
Methods
bounce
- bounce(targets, data): void
Send a bounce packet targeting any clients that fulfil any target parameters. Can be listened for by listening to +"bounced" events on SocketManager.
+Parameters
- targets: {
games?: string[];
slots?: number[];
tags?: string[];
}The targets to receive this bounce packet.
+Optionalgames?: string[]Specific games that should receive this bounce.
+Optionalslots?: number[]Specific slots that should receive this bounce.
+Optionaltags?: string[]Specific clients with these tags that should receive this bounce.
+
- data: {
[p: string]: JSONSerializableData;
}The json-serializable data to send.
+[p: string]: JSONSerializableData
Returns void
- targets: {
check
goal
login
- login<SlotData>(url, name, game, options?): Promise<SlotData>
Connect and authenticate to an Archipelago server.
+Type Parameters
- SlotData extends UnknownSlotData
If slot data is requested, this sets the type of the returning slot data.
+
Parameters
- url: string | URL
The url of the server, including the protocol (e.g.,
+wss://archipelago.gg:38281). - name: string
The slot name this client will be connecting to.
+ - game: string
The game name this client will be connecting to.
+ Optionaloptions: ConnectionOptionsAdditional optional connection arguments.
+
Returns Promise<SlotData>
-Remarks
If the port is omitted, the client will default to
+38281(AP default).If the protocol is omitted, client will attempt to connect via wss, then fallback to ws if unsuccessful.
+Any paths, queries, fragments, or userinfo components of the provided url will be ignored.
+-Example: Password Required and No Slot Data
-import { Client } from "archipelago.js";
const client = new Client();
await client.login("wss://archipelago.gg:38281", "Phar", "Clique", {
slotData: false,
password: "4444"
}); +Rejects
If web socket connection failed to establish connection or server refused connection, promise will -return a
-string[]of error messages.- -disconnect
-- -remove
-Listener -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "Bounced"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: BouncedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "Connected"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ConnectedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "ConnectionRefused"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ConnectionRefusedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "DataPackage"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: DataPackagePacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "InvalidPacket"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: InvalidPacketPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "LocationInfo"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: LocationInfoPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "PrintJSON"
--The event to stop listening for.
-
- -
-
listener: ((packet, message) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet, message): void -
-
---
Parameters
--
-
-
-
packet: PrintJSONPacket
- -
-
message: string
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "ReceivedItems"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ReceivedItemsPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "Retrieved"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: RetrievedPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "RoomInfo"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: RoomInfoPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "RoomUpdate"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: RoomUpdatePacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "SetReply"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: SetReplyPacket
Returns void
-
-
-
-
Returns void
-
- -
-
- remove
Listener(event, listener): void
- -
--
Remove an eventListener from this client's event emitter.
---Parameters
--
-
-
-
event: "PacketReceived"
--The event to stop listening for.
-
- -
-
listener: ((packet) => void)
-- -The listener callback function to remove.
--
-
-
-
-
-
- (packet): void -
-
---
Parameters
--
-
-
-
packet: ServerPacket
Returns void
-
-
-
-
Returns void
- -
-
- -say
-- -send
--
-
- send(...packets): void -
-
--
Send a list of raw packets to the Archipelago server in the order they are listed as arguments.
---Parameters
--
-
-
-
-Rest...packets: ClientPacket[]-An array of raw ClientPackets to send to the AP server. They are processed in -the order they are listed as arguments.
-
Returns void
- -
-
- update
-Status -
-
- update
Status(status): void
- -
--
Update the status for this client.
---Parameters
--
-
-
-
status: ClientStatus
--The status code to send.
-
Returns void
- -
-
- SlotData extends UnknownSlotData
-- \ No newline at end of file +Generated using TypeDoc
Example: TypeScript with Slot Data
+ +import { Client } from "archipelago.js";
interface CliqueSlotData {
color: string
hard_mode: boolean
}
const client = new Client();
// slotData: CliqueSlotData { color: "red", hard_mode: false }
const slotData = await client.login<CliqueSlotData>("wss://archipelago.gg:38281", "Phar", "Clique"); + -
-
scout
- scout(locations, createHint?): Promise<Item[]>
Scout a list of locations for their containing items.
+Parameters
- locations: number[]
A list of location ids to scout.
+ - createHint: 0 | 1 | 2 = 0
Whether to create hints for these locations.
+-
+
- If set to
0, this packet will not create hints for any locations in this packet.
+ - If set to
1, this packet will create hints for all locations in this packet and broadcast them to all +relevant clients.
+ - If set to
2, this packet will create hints for all locations in this packet and broadcast only new hints to +all relevant clients.
+
- If set to
Returns Promise<Item[]>
- locations: number[]
set
update
- update
Items Handling(items): void Request the server update the kinds of item received events this client should receive.
+Parameters
- items: number
New item handling flags. See API.itemsHandlingFlags for more information.
+
Returns void
- items: number
update
- update
Status(status): void Update the client status for the current player. For a list of known client statuses, see clientStatuses.
+Parameters
- status: ClientStatus
The status to change to.
+
Returns void
Remarks
The server will automatically set the player's status to clientStatuses.disconnected when all +clients connected to this slot have disconnected, set the status to clientStatuses.connected if a client +connects to this slot when previously set to clientStatuses.disconnected, or ignores any future updates +if ever set to clientStatuses.goal.
+- status: ClientStatus
update
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-hint
-
-
-hint
-
-
-
-
-
-
-
-
-
-
-
-
-slot
-
-
-
-
-
-
-
-
-
-Class DataManager<TSlotData>
Manages and watches for events regarding session data and the data package. Most other mangers use this information -to create helper functions and track other information.
-Type Parameters
--
-
-
-
TSlotData
Hierarchy
--
-
- DataManager
- Index
-Constructors
-constructor
--
-
- new
Data Manager<TSlotData>(client): DataManager<TSlotData>
- -
--
Creates a new DataManager and sets up events on the Client to listen for to start -updating its internal state.
-- - -Type Parameters
--
-
-
-
TSlotData
Returns DataManager<TSlotData>
- -
-
Accessors
-games
--
-
- get games(): string[] -
-
--
Returns an array of all games that exist in this room.
-Returns string[]
-
hint
--
-
- get hintCost(): number -
-
--
Returns how many hint points a player needs to spend to receive a hint.
-Returns number
-
hint
--
-
- get hintPoints(): number -
-
--
Returns how many hint points a player has.
-Returns number
-
package
--
-
- get package(): ReadonlyMap<string, GamePackage> -
-
--
Returns a map of all GamePackage mapped to their game
-name.Returns ReadonlyMap<string, GamePackage>
-
permissions
--
-
- get permissions(): Permissions -
-
--
Get the current permissions for the room.
-Returns Permissions
-
players
-seed
--
-
- get seed(): string -
-
--
Return the seed for this room.
-Returns string
-
slot
--
-
- get slot(): number -
-
--
Returns this player's slot. Returns
--1if player is not connected.Returns number
-
slot
--
-
- get slotData(): TSlotData -
-
--
Returns the slot data for this game. Will be
-undefinedif no connection has been established.Returns TSlotData
-
team
--
-
- get team(): number -
-
--
Returns this player's team. Returns
--1if player is not connected.Returns number
-
Methods
-set
--
-
- set(setOperation): Promise<void | SetReplyPacket> -
-
--
Send a series of set operations to the server. Promise returns a SetReplyPacket if
-want_replywas -requested.--Parameters
--
-
-
-
setOperation: SetOperationsBuilder
--The set builder to do operations on the data storage.
-
Returns Promise<void | SetReplyPacket>
- -
-
-
-
\ No newline at end of file
diff --git a/classes/DataPackageManager.html b/classes/DataPackageManager.html
new file mode 100644
index 0000000..467ffb1
--- /dev/null
+++ b/classes/DataPackageManager.html
@@ -0,0 +1,58 @@
+Generated using TypeDoc
Class DataPackageManager
Managers data packages metadata and exposes name lookup methods.
+ Index
Methods
export
- export
Package(): DataPackage Export a DataPackage object for local caching purposes.
+Returns DataPackage
Remarks
It is recommended to export/import any data packages ahead of time to reduce unnecessary calls to +DataPackageManager.fetchPackage and reduce connection startup time and lighten network overhead. See +below for an example.
+Example: Node.js
+ +import fs from "node:fs";
import { Client } from "archipelago.js";
// ... misc client code (connecting and fetching data package).
// Save data package to a local file.
const data = client.package.exportPackage();
fs.writeFileSync("path/to/cache/datapackage_cache.json", JSON.stringify(data), "utf8"); +
fetch
- fetch
Package(games?, update?): Promise<DataPackage> Fetches and returns the DataPackage from the server, if the games are not locally cached or checksums +do not match.
+Parameters
- games: string[] = []
A list of game packages to fetch. If omitted, will fetch all available game packages from the +current room.
+ - update: boolean = true
If
+true, after fetching the data package, any changes will automatically be updated without +needing to manually call DataPackageManager.importPackage.
Returns Promise<DataPackage>
- games: string[] = []
find
import
- import
Package(dataPackage): void Import a DataPackage object to prepopulate local cache.
+Parameters
- dataPackage: DataPackage
The package to import.
+
Returns void
Remarks
It is recommended to export/import any data packages ahead of time to reduce unnecessary calls to +DataPackageManager.fetchPackage and reduce connection startup time and lighten network overhead. See +below for an example.
+Example: Node.js
+ +import fs from "node:fs";
import { Client } from "archipelago.js";
const data = fs.readFileSync("path/to/cache/datapackage_cache.json");
const client = new Client();
client.package.importPackage(JSON.parse(data));
await client.login("wss://archipelago.gg:38281", "Phar", "Clique"); +Example: Modern browser (using localStorage and ES-syntax)
+ +<script src="archipelago.js" type="module">
import { Client } from "archipelago.js";
const data = localStorage.getItem("datapackage_cache");
const client = new Client();
client.package.importPackage(JSON.parse(data));
await client.login("wss://archipelago.gg:38281", "Phar", "Clique");
</script> +- dataPackage: DataPackage
lookup
- lookup
Item Name(game, id, fallback): string Lookup an item name by its integer id.
+Parameters
- game: string
The name of the game this item is associated with.
+ - id: number
The id of the item to name lookup.
+ - fallback: true
If
+true, returns"Unknown Item {id}"instead ofundefined, if id does not exist in package. +Defaults totrue, if omitted.
Returns string
- game: string
- lookup
Item Name(game, id, fallback): undefined | string Lookup an item name by its integer id.
+Parameters
- game: string
The name of the game this item is associated with.
+ - id: number
The id of the item to name lookup.
+ - fallback: false
If
+true, returns"Unknown Item {id}"instead ofundefined, if id does not exist in package. +Defaults totrue, if omitted.
Returns undefined | string
- game: string
lookup
- lookup
Location Name(game, id, fallback): string Lookup a location name by its integer id.
+Parameters
- game: string
The name of the game this location is associated with.
+ - id: number
The id of the location to name lookup.
+ - fallback: true
If
+true, returns"Unknown Location {id}"instead ofundefined, if id does not exist in +package. Defaults totrue, if omitted.
Returns string
- game: string
- lookup
Location Name(game, id, fallback): undefined | string Lookup a location name by its integer id.
+Parameters
- game: string
The name of the game this location is associated with.
+ - id: number
The id of the location to name lookup.
+ - fallback: false
If
+true, returns"Unknown Location {id}"instead ofundefined, if id does not exist in +package. Defaults totrue, if omitted.
Returns undefined | string
- game: string
Class DataStorageManager
Manages communication between the data storage API and notifies subscribers of changes to storage updates.
+ Index
Accessors
store
+
Methods
Accessors
store
- get store(): Record<string, JSONSerializableData>
Returns a copy of all currently monitored keys.
+Returns Record<string, JSONSerializableData>
Methods
fetch
- fetch(keys, monitor?): DataRecordPromise
Fetches provided keys from data storage.
+Parameters
- keys: string[]
A list of keys to be fetched.
+ - monitor: boolean = false
Adds keys to local cache and request the server to update client when changes are made to speed up +subsequent lookups. For one-off adhoc lookups, should be omitted.
+
Returns DataRecordPromise
An object containing all current values for each key requested.
+- keys: string[]
fetch
fetch
get
- get<T>(key, monitor?): Promise<T>
Gets a single provided key from data storage.
+Type Parameters
Parameters
- key: string
The keys to be fetched.
+ - monitor: boolean = false
Adds key to local cache and request the server to update client when changes are made to speed up +subsequent lookups. For one-off adhoc lookups, should be omitted.
+
Returns Promise<T>
The current value for this key.
+- key: string
notify
- notify(keys, callback): DataRecordPromise
Add a list of keys to be monitored for changes and fire a callback when changes are detected.
+Parameters
- keys: string[]
A list of keys to fetch and watch for changes.
+ - callback: DataChangeCallback
A callback to fire whenever one of these keys change.
+
Returns DataRecordPromise
An object containing all current values for each key requested.
+- keys: string[]
prepare
- prepare(key, _default?): IntermediateDataOperation
Create a new transaction for setting a data storage key by returning an IntermediateDataOperation. To +perform certain operations, just chain additional methods until finished, then call
+prepare().Parameters
- key: string
The key to manipulate.
+ - _default: JSONSerializableData = 0
The default value to be used if key does not exist.
+
Returns IntermediateDataOperation
- key: string
Class DeathLinkManager
Manages DeathLink mechanics for clients that choose to opt in to the mechanic.
+Hierarchy (view full)
- EventBasedManager<DeathEvents>
- DeathLinkManager
Index
Accessors
enabled
+
Methods
Accessors
enabled
- get enabled(): boolean
Returns
+trueif this client is participating in the DeathLink mechanic.Returns boolean
Methods
disable
enable
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: DeathEvents[Event]) => void)
The callback function to remove.
+- (...args): void
Parameters
Rest...args: DeathEvents[Event]
Returns void
Returns this
This object.
+- event: 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: DeathEvents[Event]) => void)
The callback function to fire when this event is received.
+- (...args): void
Parameters
Rest...args: DeathEvents[Event]
Returns void
Returns this
This object.
+- event: Event
send
- send
Death Link(source, cause?): void If DeathLink is enabled, sends a DeathLink to all DeathLink enabled players, otherwise this method does nothing.
+Parameters
- source: string
The name of the player who died. Can be a slot name, but could also be a name from within a +multiplayer game.
+ Optionalcause: stringOptional text explaining the cause of death. When provided, this should include the player's name. +(e.g.,
+Phar drowned in a vat of kittens.)
Returns void
Remarks
DeathLinks sent from this client will not fire a DeathEvents.deathReceived event to avoid +an infinite feedback loop of deaths.
+- source: string
wait
- wait<Event>(event, clearPredicate?): Promise<DeathEvents[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: DeathEvents[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: DeathEvents[Event]
Returns boolean
Returns Promise<DeathEvents[Event]>
- event: Event
Class EventBasedManager<Events>Abstract
An abstract class for managers that offer an event-based API.
+Type Parameters
Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
- new
Event Based Manager<Events>(): EventBasedManager<Events> Type Parameters
Returns EventBasedManager<Events>
Methods
off
- off<Event>(event, listener): this
Removes an existing event listener.
+Type Parameters
Parameters
Returns this
This object.
+
on
- on<Event>(event, listener): this
Add an event listener for a specific event.
+Type Parameters
Parameters
Returns this
This object.
+
wait
- wait<Event>(event, clearPredicate?): Promise<Events[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: Events[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
Returns boolean
Returns Promise<Events[Event]>
- event: Event
Class Hint
An abstraction of NetworkHint that exposes additional helper methods and accessors received hint data.
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HintManager
Manages and watches for hint events to this player slot and provides helper functions to make working with hints -easier.
-Hierarchy
--
-
- HintManager
- Index
-
-
-
-
-
Constructors
-Accessors
-mine
-
Constructors
-constructor
--
-
- new
Hint Manager(client): HintManager
- -
---
Parameters
--
-
-
-
client: Client<unknown>
Returns HintManager
-
-
Accessors
-mine
--
-
- get mine(): readonly Hint[] -
-
--
Get all hints that are relevant for this slot.
-Returns readonly Hint[]
-
-
-
\ No newline at end of file
diff --git a/classes/HintsManager.html b/classes/HintsManager.html
deleted file mode 100644
index f771a43..0000000
--- a/classes/HintsManager.html
+++ /dev/null
@@ -1,217 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HintsManager
Manages and watches for hint events to this player slot and provides helper functions to make working with hints -easier.
-Hierarchy
--
-
- HintsManager
- Index
-
-
-
-
-
Constructors
-Accessors
-mine
-
Constructors
-constructor
--
-
- new
Hints Manager(client): HintsManager
- -
---
Parameters
--
-
-
-
client: Client<unknown>
Returns HintsManager
-
-
Accessors
-mine
-
-
-
\ No newline at end of file
diff --git a/classes/IntermediateDataOperation.html b/classes/IntermediateDataOperation.html
new file mode 100644
index 0000000..32e930d
--- /dev/null
+++ b/classes/IntermediateDataOperation.html
@@ -0,0 +1,60 @@
+Generated using TypeDoc
Class IntermediateDataOperation
An intermediate abstract object holding an array of data storage operations to be performed in order by the server.
+ Methods
add
- add(value): IntermediateDataOperation
Adds
+valueto the current value of the key, if both the current value andvalueare arrays thenvaluewill +be appended to the current value.Parameters
- value: number | JSONSerializableData[]
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number | JSONSerializableData[]
and
- and(value): IntermediateDataOperation
Applies a bitwise AND to the current value of the key with
+value.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
ceiling
- ceiling(): IntermediateDataOperation
Rounds up the current value to the nearest integer.
+Returns IntermediateDataOperation
commit
- commit(awaitReply): Promise<JSONSerializableData>
Commit the current operations to data store and return a Promise with the updated key, once fulfilled.
+Parameters
- awaitReply: true
If
+true, a promise will be returned with the new value. Otherwise, immediately resolves.
Returns Promise<JSONSerializableData>
- awaitReply: true
- commit(awaitReply): Promise<void>
Commit the current operations to data store.
+Parameters
- awaitReply: false
Returns Promise<void>
default
- default(): IntermediateDataOperation
If the key has no value yet, sets the current value of the key to
+default.Returns IntermediateDataOperation
floor
- floor(): IntermediateDataOperation
Rounds down the current value to the nearest integer.
+Returns IntermediateDataOperation
left
- left
Shift(value): IntermediateDataOperation Applies a bitwise left-shift to the current value of the key by
+value.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
max
- max(value): IntermediateDataOperation
Sets the current value of the key to
+valueifvalueis bigger.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
min
- min(value): IntermediateDataOperation
Sets the current value of the key to
+valueifvalueis bigger.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
multiply
- multiply(value): IntermediateDataOperation
Multiplies the current value of the key by
+value.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
or
- or(value): IntermediateDataOperation
Applies a bitwise OR to the current value of the key with value.
+Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
pop
- pop(value): IntermediateDataOperation
List or Dict only: for
+listsit will remove the index of thevaluegiven. Fordictsit removes the element +with the specified key ofvalue.Parameters
- value: JSONSerializableData
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: JSONSerializableData
power
- power(value): IntermediateDataOperation
Multiplies the current value of the key to the power of
+value.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
remainder
- remainder(value): IntermediateDataOperation
Sets the current value of the key to the remainder after division by
+value.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
remove
- remove(value): IntermediateDataOperation
List only: removes the first instance of
+valuefound in the list.Parameters
- value: JSONSerializableData
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: JSONSerializableData
replace
- replace(value): IntermediateDataOperation
Sets the current value of the key to
+value.Parameters
- value: JSONSerializableData
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: JSONSerializableData
right
- right
Shift(value): IntermediateDataOperation Applies a bitwise right-shift to the current value of the key by
+value.Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
update
- update(value): IntermediateDataOperation
Dict only: Updates the dictionary with the specified elements given in
+valuecreating new keys, or updating old +ones if they previously existed.Parameters
- value: JSONSerializableData
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: JSONSerializableData
xor
- xor(value): IntermediateDataOperation
Applies a bitwise XOR to the current value of the key with value.
+Parameters
- value: number
A value for the operation to apply against the current data storage value.
+
Returns IntermediateDataOperation
- value: number
Class Item
An abstraction of NetworkItem that exposes additional helper methods and accessors for this item data.
+ Index
Accessors
filler
+flags
+game
+location
Methods
to
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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class ItemsManager
Manages and watches for events regarding item data and provides helper functions to make working with items easier.
-Hierarchy
--
-
- ItemsManager
- Index
-Constructors
-constructor
--
-
- new
Items Manager(client): ItemsManager
- -
-- -
Creates a new ItemsManager and sets up events on the Client to listen for to start -updating its internal state.
-Returns ItemsManager
-
Accessors
-index
--
-
- get index(): number -
-
--
Returns the current item index. If this value is larger than expected, that means new items have been received.
-Returns number
-
received
--
-
- get received(): readonly NetworkItem[] -
-
--
Returns an array of all items that have been received.
-Returns readonly NetworkItem[]
-
Methods
-group
-name
--
-
- name(player, id): string -
-
--
Returns the
-nameof a given itemid.--Parameters
--
-
-
-
player: number
--The
-idof the player this item belongs to.
- -
-
id: number
--The
-idof this item.
Returns string
Returns the name of the item or
- -Unknown Item: <id>if item or player is not in data.-Throws
Throws an error if
-playeroridis not a safe integer.
- -
-
- name(game, id): string -
-
--
Returns the
-nameof a given itemid.--Parameters
--
-
-
-
game: string
--The
-nameof the game this item belongs to.
- -
-
id: number
--The
-idof this item.
Returns string
Returns the name of the item or
- -Unknown Item: <id>if item or player is not in data.-Throws
Throws an error if
-idis not a safe integer. -
-
-
-
\ No newline at end of file
+Generated using TypeDoc
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 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.
+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.
+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 +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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-auto
-
-
-
-
-
-
-
-
-
-
-
-
-Class LocationsManager
Manages and watches for events regarding location data and provides helper functions to make checking, scouting, or -working with locations in general easier.
-Hierarchy
--
-
- LocationsManager
- Index
-
-
-
-
-
-
-
Constructors
-Accessors
-Methods
-Constructors
-constructor
--
-
- new
Locations Manager(client): LocationsManager
- -
-- -
Creates a new LocationsManager and sets up events on the Client to listen for to start -updating its internal state.
-Returns LocationsManager
-
Accessors
-checked
--
-
- get checked(): readonly number[] -
-
--
An array of all checked locations.
-Returns readonly number[]
-
missing
--
-
- get missing(): readonly number[] -
-
--
An array of all locations that are not checked.
-Returns readonly number[]
-
Methods
-auto
-check
-group
-name
--
-
- name(player, id): string -
-
--
Returns the
-nameof a given locationid.--Parameters
--
-
-
-
player: number
--The
-idof the player this location belongs to.
- -
-
id: number
--The
-idof this location.
Returns string
Returns the name of the location or
- -Unknown Location: <id>if location or player is not in data.-Throws
Throws an error if
-playeroridis not a safe integer.
- -
-
- name(game, id): string -
-
--
Returns the
-nameof a given locationid.--Parameters
--
-
-
-
game: string
--The
-nameof the game this location belongs to.
- -
-
id: number
--The
-idof this location.
Returns string
Returns the name of the location or
- -Unknown Location: <id>if location or player is not in data.-Throws
Throws an error if
-idis not a safe integer. -
-
scout
-
-
-
\ No newline at end of file
diff --git a/classes/MessageManager.html b/classes/MessageManager.html
new file mode 100644
index 0000000..47e078d
--- /dev/null
+++ b/classes/MessageManager.html
@@ -0,0 +1,28 @@
+Generated using TypeDoc
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
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
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.
+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 +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
Class Package
An abstraction of a GamePackage object which includes additional helper methods for interacting with a game's +package.
+ Index
Properties
Methods
Properties
Readonlychecksum
checksum: string
The SHA256 hexadecimal string representation of this game package.
+Readonlygame
game: string
The name of the game this game package is for.
+Readonlyitem
item
A record of names to ids for all items in this game package.
+Readonlylocation
location
A record of names to ids for all locations in this game package.
+Readonlyreverse
reverse
A record of ids to names for all items in this game package.
+Readonlyreverse
reverse
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
Methods
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
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class PlayersManager
Manages and watches for events regarding player data and provides helper functions to make working with players -easier.
-Hierarchy
--
-
- PlayersManager
Constructors
-constructor
--
-
- new
Players Manager(client): PlayersManager
- -
-- -
Creates a new PlayersManager and sets up events on the Client to listen for to start -updating its internal state.
-Returns PlayersManager
-
Accessors
-all
-Methods
-alias
--
-
- alias(id): string -
-
--
Returns the
-aliasof a given playerid. Returns "Unknown Player #" if player does not exist in the room.Special cases:
--
-
- If player id is
0, returnsArchipelago.
-
--Parameters
--
-
-
-
id: number
--The slot
-idof a player.
Returns string
--Throws
Throws an error if unable to find a player with the given
-id. - If player id is
game
-get
-members
-name
--
-
- name(id): string -
-
--
Returns the
-nameof a given playerid. Returns "Unknown Player #" if player does not exist in the room.Special cases:
--
-
- If player id is
0, returnsArchipelago.
-
--Parameters
--
-
-
-
id: number
--The slot
-idof a player.
Returns string
--Throws
Throws an error if unable to find a player with the given
-id. - If player id is
-
-
\ No newline at end of file
+Generated using TypeDoc
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 Readonly<Record<number, NetworkSlot>>
Remarks
Slot information is shared across each team. For accessing player data, see PlayersManager.
+
teams
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.
+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.
+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 +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
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
Methods
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 {
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 +clients race legal depending on rules).
+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.
+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.
+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.
+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 +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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-shift
-
-
-shift
-
-
-
-
-
-
-
-
-Class SetOperationsBuilder
A helper class of data operations to perform server-side on a given key.
-Hierarchy
--
-
- SetOperationsBuilder
Constructors
-constructor
--
-
- new
Set Operations Builder(key, defaultValue, wantReply?): SetOperationsBuilder
- -
---
Parameters
--
-
-
-
key: string
- -
-
defaultValue: JSONSerializableData
- -
-
wantReply: boolean = false
Returns SetOperationsBuilder
-
-
Methods
-add
--
-
- add(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number | number[]
Returns SetOperationsBuilder
-
-
and
--
-
- and(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
build
-default
--
-
- default(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: JSONSerializableData
Returns SetOperationsBuilder
-
-
max
--
-
- max(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
min
--
-
- min(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
modulo
--
-
- modulo(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
multiply
--
-
- multiply(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
or
--
-
- or(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
pop
--
-
- pop(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: JSONSerializableData
Returns SetOperationsBuilder
-
-
power
--
-
- power(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
remove
--
-
- remove(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: JSONSerializableData
Returns SetOperationsBuilder
-
-
replace
--
-
- replace(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: JSONSerializableData
Returns SetOperationsBuilder
-
-
shift
--
-
- shift
Left(value): SetOperationsBuilder
- -
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
shift
--
-
- shift
Right(value): SetOperationsBuilder
- -
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
update
--
-
- update(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: JSONSerializableData
Returns SetOperationsBuilder
-
-
xor
--
-
- xor(value): SetOperationsBuilder -
-
---
Parameters
--
-
-
-
value: number
Returns SetOperationsBuilder
-
-
-
-
\ No newline at end of file
diff --git a/classes/SocketManager.html b/classes/SocketManager.html
new file mode 100644
index 0000000..6987284
--- /dev/null
+++ b/classes/SocketManager.html
@@ -0,0 +1,37 @@
+Generated using TypeDoc
Class SocketManager
Manages socket-level communication and exposes helper methods/events for interacting with the Archipelago API +directly.
+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 +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.
+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.
+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.
+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 +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
archipelago.js - v2.0.0-rc1
Class Hierarchy
-
diff --git a/interfaces/API.AdminCommandResultJSONPacket.html b/interfaces/API.AdminCommandResultJSONPacket.html
new file mode 100644
index 0000000..e2843ca
--- /dev/null
+++ b/interfaces/API.AdminCommandResultJSONPacket.html
@@ -0,0 +1,8 @@
+
-archipelago.js - v2.0.0-rc1
-
-archipelago.js - v1.1.0
Archipelago.JS
A general purpose library for communicating with Archipelago servers in Node.js or in the browser.
-You can install it from npm or use a CDN to use it in browser.
--
-
- NPM:
npm install archipelago.js
- - CDN:
import { /* ... */ } from "https://unpkg.com/archipelago.js/dist/archipelago.min.js";in a -<script type="module"></script>block.
-
Archipelago.js Node.js Quick Start Guide
Archipelago.js is a JavaScript library that runs in Node or the browser that allows you to connect to an Archipelago -server and communicate with it for your JavaScript-based games or tools. This guide will walk you through the process of -setting up a client and connecting to an Archipelago server.
-Prerequisites
Before you begin, make sure you have the following prerequisites:
--
-
- Node.js installed on your machine. -
- Basic knowledge of JavaScript (or TypeScript). -
Installation
To start a new project with Archipelago.js follow these steps:
--
-
- Create a new directory for your project. -
- Open a terminal or command prompt and navigate to the project directory. -
- Run the following command to initialize a new Node.js project:
npm install archipelago.js.
- - If you plan to use TypeScript, also install typescript dependencies and nice to haves:
npm install -D typescript.-
-
- Replace any instances of "
.js" with ".ts" in this quick start guide.
-
- - Replace any instances of "
Getting Started
Follow the steps below to quickly set up a client and connect to an Archipelago server:
--
-
- Create a new file called
client.jsin your project directory.
- - Open the
client.jsfile with your preferred code editor and add the following code:
-
// ES module import, but you can use CommonJS syntax as well, if you prefer.
import { Client, ITEMS_HANDLING_FLAGS } from "archipelago.js";
// Create a new instance of the Client class.
const client = new Client();
// Set up the connection information.
const connectionInfo = {
hostname: "your-server-hostname", // Replace with the actual AP server hostname.
port: 38281, // Replace with the actual AP server port.
game: "your-game-name", // Replace with the game name for this player.
name: "your-player-name", // Replace with the player slot name.
items_handling: ITEMS_HANDLING_FLAGS.REMOTE_ALL,
};
// Connect to the Archipelago server
client
.connect(connectionInfo)
.then(() => {
console.log("Connected to the server");
// You are now connected and authenticated to the server. You can add more code here if need be.
})
.catch((error) => {
console.error("Failed to connect:", error);
// Handle the connection error.
});
-Make sure to replace "your-server-hostname", 38281, "your-game-name", "your-player-name", and set items_handling with
-the appropriate values for your game and room.
Then just run your client script using node client.js or if you're using TypeScript: npx ts-node client.ts.
That's it! You have now set up a client and connected to an Archipelago server using archipelago.js. You can start -sending packets, handling server events, and building your multiplayer experience.
-Running in Browser
Archipelago.js can also run in the browser. Here's an example that works in most major browsers:
-<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Archipelago.js Client Example</title>
</head>
<body>
<script type="module">
import {
Client,
ITEMS_HANDLING_FLAGS,
SERVER_PACKET_TYPE,
} from "https://unpkg.com/archipelago.js/dist/archipelago.min.js";
// Create a new Archipelago client
const client = new Client();
const connectionInfo = {
hostname: "your-server-hostname", // Replace with the actual AP server hostname.
port: 38281, // Replace with the actual AP server port.
game: "your-game-name", // Replace with the game name for this player.
name: "your-player-name", // Replace with the player slot name.
items_handling: ITEMS_HANDLING_FLAGS.REMOTE_ALL,
};
// Set up event listeners
client.addListener(SERVER_PACKET_TYPE.CONNECTED, (packet) => {
console.log("Connected to server: ", packet);
});
client.addListener(SERVER_PACKET_TYPE.ROOM_UPDATE, (packet) => {
console.log("Room update: ", packet);
});
// Connect to the Archipelago server
client
.connect(connectionInfo)
.then(() => {
console.log("Connected to the server");
// You are now connected and authenticated to the server. You can add more code here if need be.
})
.catch((error) => {
console.error("Failed to connect:", error);
// Handle the connection error.
});
// Disconnect from the server when unloading window.
window.addEventListener("beforeunload", () => {
client.disconnect();
});
</script>
</body>
</html>
-In this example, the Archipelago client is included as a script from the -https://unpkg.com/archipelago.js/dist/archipelago.min.js CDN. You can also use a locally hosted version of the library -if you prefer.
-Handling Server Events
You can listen for server events and handle them in your code. Here's an example of adding an event listener for the -"PrintJSON" event:
-import { /* ... */, SERVER_PACKET_TYPE } from "archipelago.js";
// Add an event listener for the PRINT_JSON event
client.addListener(SERVER_PACKET_TYPE.PRINT_JSON, (packet, message) => {
console.log("Received a PrintJSON: ", message);
// Add any additional logic here.
});
-Sending Client Events
You can also respond to the server at at time while you're connected. Here's a few examples of built-in events you can -send.
--
-
Say: Use the
-saymethod to send a normal chat message.
-client.say("Hello, archipelago!"); -
-Update Status: Use the
-updateStatusmethod to update your status from Ready to Playing or even Goal -Complete, once your game has completed.
-import { /* ... */, CLIENT_STATUS } from "archipelago.js";
// See documentation for all possible statuses.
client.updateStatus(CLIENT_STATUS.READY);
client.updateStatus(CLIENT_STATUS.PLAYING);
client.updateStatus(CLIENT_STATUS.GOAL); -
-Send Raw Packets: You can also just send raw packets to the server if none of the built-in methods work for your -use cases. Be sure to add a listener for the response from the server though (see above)!
-
-import { /* ... */, CLIENT_PACKET_TYPE } from "archipelago.js";
const syncPacket = {
cmd: CLIENT_PACKET_TYPE.SYNC,
}
client.send(syncPacket); -
-
Player
Player objects returned from PlayersManager contain the following data and helper functions for easy item and location
-name lookups:
-
-
name: The slot name for this player.
-alias: The aliased name for this player.
-slot: The slot number for this player.
-team: The team number for this player.
-game: The name of the game this player is playing.
-type: Whether this player is a spectator, actual player, or item link group.
-group_members: If this player is an item link group, this is the ids of all players that belong to this group.
-item(itemId): A function that returns the name for a given item id in the game of this player.-
-
- Example:
const itemName = player.item(1000);
-
-- Example:
location(locationId): A function that returns the name for a given location id in the game of this player.-
-
- Example:
const locationName = player.location(1000);
-
-- Example:
LocationsManager
The LocationsManager class in archipelago.js provides functionality for managing locations within the game. Here are
-some tips for working with the LocationsManager:
-
-
Check Locations: Use the
-checkmethod to mark locations as found. Pass the location IDs as arguments to the -method.
-client.locations.check(locationId1, locationId2, locationId3); -
-Scout Locations: Use the
-scoutmethod to scout locations without marking them as found. You can also create -hints for these locations by passing theCREATE_AS_HINT_MODEas the first argument followed by the location IDs.
-client.locations.scout(CREATE_AS_HINT_MODE.NO_HINT, locationId1, locationId2, locationId3); -
-Retrieve Location Name: Use the
-namemethod to retrieve the name of a location based on its ID and game name. -If the location or game is not found, it will return an "Unknown Location" string instead.
-const locationName = client.locations.name("your-game-name", locationId); -
-Retrieve Location Group: Use the
-groupmethod to retrieve an array of location names belonging to a specific -group in a game. If the game or group is not found, it will return an empty array.
-const locationGroup = client.locations.group("your-game-name", "group-name"); -
-Automatically Release All Locations: Use the
-autoReleasemethod to send all missing locations as checked.
-client.locations.autoRelease(); -
-
PlayersManager
The PlayersManager class in archipelago.js provides functionality for managing and looking up player data within the
-game. Here are some helpful methods for working with the PlayersManager:
-
-
Retrieve Player Name: Use the
-namemethod to retrieve the name of a player based on their ID. If the player is -not found, it will throw an error.
-const playerName = client.players.name(playerId); -
-Retrieve Player Alias: Use the
-aliasmethod to retrieve the alias of a player based on their ID. If the player -is not found, it will throw an error.
-const playerAlias = client.players.alias(playerId); -
-Retrieve Player Game: Use the
-gamemethod to retrieve the game name of a player based on their ID. If the -player is not found, it will throw an error.
-const playerGame = client.players.game(playerId); -
-Retrieve Group Members: Use the
-membersmethod to retrieve an array of player IDs belonging to an item links -group. If the id is of someone who is not an item links group or the group is not found, it will return an empty -array.
-const groupMembers = client.players.members(groupId); -
-Retrieve all Players: Use the
-allmethod to return an array of allPlayerobjects that are in this room.
-const players = client.players.all; -
-Retrieve a specific Player: Use the
-getmethod to return aPlayerobject with that id. Returnsundefinedif -player does not exist.
-const playerOne = client.players.get(1); -
-
Special Cases: The methods in PlayersManager handle some special cases. For example, if the player ID is 0, it
-represents the server (Archipelago), and the methods will return appropriate values for these cases. See documentation
-for full exceptions.
DataManager
The DataManager class in archipelago.js is responsible for managing room session data and the data package. Here are
-some tips for working with the DataManager:
-
-
Retrieve Games List: Use the
-gamesproperty to get an array of all games present in the room.
-const gamesList = client.data.games; -
-Retrieve Hint Cost: Use the
-hintCostproperty to get the number of hint points required to receive a hint.
-const hintCost = client.data.hintCost; -
-Retrieve Hint Points: Use the
-hintPointsproperty to get the number of hint points the player has.
-const hintPoints = client.data.hintPoints; -
-Retrieve Slot Data: Use the
-slotDataproperty to access the slot data for the game.
-const slotData = client.data.slotData; -
-Retrieve Slot and Team: Use the
-slotandteamproperties to get the player's slot and team.
-const slot = client.data.slot;
const team = client.data.team; -
-Retrieve Seed: Use the
-seedproperty to get the seed for the room.
-const seed = client.data.seed; -
-Retrieve Permissions: Use the
-permissionsproperty to get the current permissions for the room.
-const permissions = client.data.permissions; -
-Send Set Operations: Use the
-setmethod to send a series of set operations using theSetOperationBuilder-object to the server. This method returns a promise that resolves with aSetReplyPacketifwantReplywas -requested.
-import { /* ... */, SetOperationsBuilder } from "archipelago.js";
// Add additional set operations to the SetOperationBuilder.
const setOperation = new SetOperationsBuilder("key", 0 /* default value */, true /* wantReply */)
.add(12) // Add to it!
.multiply(4) // Multiply it!
.shiftLeft(2); // Shift bits!
const setReply = await client.data.set(setOperation); -
-
ItemsManager
The ItemsManager class in archipelago.js is responsible for managing item data. Here are some tips for working with
-the ItemsManager:
-
-
Retrieve Item Name: Use the name method to retrieve the name of an item based on its ID and game name. If the -item or game is not found, it will return a default message.
-
-const itemName = client.items.name(gameName, itemId); -
-Retrieve Item ID: Use the
-idmethod to retrieve the ID of an item based on its name and game name. If the item -or game is not found, it will throw an error.
-const itemId = client.items.id(gameName, itemName); -
-Retrieve Item Group: Use the
-groupmethod to retrieve an array of item names belonging to a specific group in -a game. If the game or group is not found, it will return an empty array.
-const itemGroup = client.items.group(gameName, groupName); -
-Retrieve all received items: Use the
-receivedproperty to retrieve an array of all items that have been sent -by the server.
-const allItems = client.items.received; -
-Retrieve ReceivedItem index: Returns the
-indexof the next expected item to be received from the server. Any -items with a lower index are stored inItemsManager.received. Useful for tracking if new items have been received -or to check if a de-sync event occurred.
-const receivedItemIndex = client.items.index; -
-
HintsManager
The HintsManager class in archipelago.js is responsible for managing hint events for a specific player slot. Here are
-some tips for working with the HintsManager:
-
-
- Get Relevant Hints: Use the
mineproperty to access an array of hints that are relevant to the player slot.
-
const relevantHints = client.hints.mine;
-Hints update automatically for the slot the player is in when new hints are made that are relevant for the player.
-Conclusion
Congratulations! You have successfully set up a client and hopefully learned a good amount of what this library is -capable of! You are now ready to integrate Archipelago functionality into your application.
-For more information, check out the archipelago.js API documentation and explore the available features and -capabilities.
-If you encounter any issues or have questions, feel free to reach out on the GitHub repository for support or directly -to Phar (thephar) in the Archipelago Discord, and thanks for checking out my little pet -project for Archipelago!
-Contributing / Development
To develop further or contribute to Archipelago.JS itself, just clone this repository to a desired location on your -computer:
-git clone https://github.com/ThePhar/archipelago.js && cd archipelago.js
-Then run npm install to install all dependencies.
Archipelago.JS is written in TypeScript and includes a strong ESLint and Prettier config file to ensure code
-consistency. Be sure to follow the code standards and check your work with npm run lint. You can build your code by
-running npm run pack (to package in a .tgz file) or npm run build (for a full dist/ folder).
It is recommended to work in a branch other than main, even if you fork, to avoid merge conflicts with GitHub when
-pull requests and squash merges happen.
API Documentation & Other Links
The full API documentation is located here. Please be sure to reference it, +
archipelago.js - v2.0.0-rc1
Archipelago.js
A runtime-agnostic and zero dependency TypeScript/JavaScript library for communicating with Archipelago servers.
+Targeted to work on all major desktop and mobile browsers (Firefox, +Chromium, and Safari) and server-side runtimes such as +Node.js, Bun, and Deno.
+Installation
Install via npm install archipelago.js (or via your preferred package manager's flavor).
Quick Start
import { Client } from "archipelago.js";
const client = new Client();
// Connect to Archipelago session.
client.connect("wss://archipelago.gg:38281", "Phar", "Clique")
.then(() => client.messages.chat("Hello, multiworld!"));
+Documentation
The full API documentation is located here. Please be sure to reference it while you are developing your JavaScript-based clients.
-This library supports 100% of the Archipelago network protocol referenced at -here as of 2023-07-08. See more -information about Archipelago at their website.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
This library supports 100% of the Archipelago network protocol referenced +here as of 2024-11-03 +(0.5.1 RC1). See more information about Archipelago at their website.
+Contribution
Archipelago.js is built using TypeScript and the Bun bundler. You can set up your development environment by cloning +this repository to a desired location on your computer and installing its devDependencies.
+git clone https://github.com/ThePhar/archipelago.js
cd archipelago.js
npm install # or pnpm install
+Then to build, have Bun installed and run npm run build:src (or pnpm build:docs).
Archipelago.js is written in TypeScript and includes a strong ESLint config file to ensure code consistency. Be sure
+to follow the code standards of this repository and check your work with npm run lint.
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.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface AdminCommandResultJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
type: "AdminCommandResult";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
type: "AdminCommandResult";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlytype
type
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 +arguments.
+interface BouncePacket {
cmd: "Bounce";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
cmd: "Bounce";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
Properties
Readonlycmd
cmd
Readonlydata
Any data you want to send.
+Optional Readonlygames
games?: string[]
Optional. Games that should receive this message.
+Optional Readonlyslots
slots?: number[]
Optional. Player ids that should receive this message.
+Optional Readonlytags
tags?: string[]
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.
+interface BouncedPacket {
cmd: "Bounced";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
cmd: "Bounced";
data: {
[p: string]: JSONSerializableData;
};
games?: string[];
slots?: number[];
tags?: string[];
}
Properties
Readonlycmd
cmd
Readonlydata
A verbatim copy of the data in the BouncePacket package.
+Optional Readonlygames
games?: string[]
Optional. Game names this message is targeting.
+Optional Readonlyslots
slots?: number[]
Optional. Player slot IDs that this message is targeting.
+Optional Readonlytags
tags?: string[]
Optional. Client tags this message is targeting.
+Interface ChatJSONPacket
Sent to clients to broadcast a normal chat message.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface ChatJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
slot: number;
team: number;
type: "Chat";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
slot: number;
team: number;
type: "Chat";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlymessage
message: string
Original chat message without sender prefix.
+Readonlyslot
slot: number
Slot of the triggering player.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+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.
interface CollectJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Collect";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Collect";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyslot
slot: number
Slot of the triggering player.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface CommandResultJSONPacket
Sent to relevant clients to broadcast the result of a chat command.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface CommandResultJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
type: "CommandResult";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
type: "CommandResult";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlytype
type
The PrintJSONPacket subtype.
+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;
}
cmd: "Connect";
game: string;
items_handling: number;
name: string;
password: string;
slot_data: boolean;
tags: string[];
uuid: string;
version: NetworkVersion;
}
Properties
Readonlycmd
cmd
Readonlygame
game: string
The name of the game the client is playing.
+Readonlyitems_
items_
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_
slot_
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
An object representing the minimum Archipelago server version this client supports.
+Interface ConnectUpdatePacket
Update arguments from the Connect packet, currently only updating tags and items_handling is supported.
Index
Properties
Properties
Readonlycmd
cmd
Readonlyitems_
items_
Bit flags configuring which items should be sent by the server. See itemsHandlingFlags for additional +information.
+Readonlytags
tags: string[]
Denotes special features or capabilities that the sender is currently capable of.
+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: JSONSerializableData;
slot_info: Record<string, NetworkSlot>;
team: number;
}
checked_locations: number[];
cmd: "Connected";
hint_points: number;
missing_locations: number[];
players: NetworkPlayer[];
slot: number;
slot_data: JSONSerializableData;
slot_info: Record<string, NetworkSlot>;
team: number;
}
Index
Properties
Properties
Readonlychecked_
checked_
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.
+Readonlycmd
cmd
Readonlyhint_
hint_
Number of hint points that the current player has.
+Readonlymissing_
missing_
Contains integer ids of remaining locations that need to be checked. Useful for trackers, among other things.
+Readonlyplayers
List denoting other players in the multi-world, whether connected or not.
+Readonlyslot
slot: number
Your slot number on your team. See NetworkPlayer for more info on the slot number.
+Readonlyslot_
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.
+Readonlyslot_
Object of each slot with their NetworkSlot information.
+Readonlyteam
team: number
Your team number. See NetworkPlayer for more info on team number.
+Interface ConnectionRefusedPacket
Sent to clients when the server refuses connection. This is sent during the initial connection handshake.
+ Properties
Readonlycmd
cmd
Optional Readonlyerrors
Optional. When provided, should contain one or more ConnectionError values. See ConnectionError +for additional information on what each error means.
+Interface CountdownJSONPacket
Sent to clients to broadcast a countdown message, usually for counting down the start of a game.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface CountdownJSONPacket {
cmd: "PrintJSON";
countdown: number;
data: JSONMessagePart[];
type: "Countdown";
}
cmd: "PrintJSON";
countdown: number;
data: JSONMessagePart[];
type: "Countdown";
}
Properties
Readonlycmd
cmd
Readonlycountdown
countdown: number
Amount of seconds remaining on the countdown.
+Readonlydata
All the textual metadata for this packet.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface DataPackagePacket
Sent to clients to provide what is known as a 'data package' which contains information to enable a client to most +easily communicate with the Archipelago server. Contents include things like location id to name mappings, among +others; see DataPackage for more info.
+ Properties
Readonlycmd
cmd
Readonlydata
The data package as an object of DataPackage.
+Interface GetDataPackagePacket
Sent by the client to request the data package from the server. Does not require client authentication.
+Interface GetPacket
Sent by the client to request a single or multiple values from the server's data storage, see the SetPacket +for how to write values to the data storage. A GetPacket will be answered with a RetrievedPacket.
+Additional properties sent in this package will also be added to the RetrievedPacket it triggers.
+Some special read-only keys exist with specific return data:
+-
+
_read_hints_{team}_{slot}: NetworkHint[] - All hinted NetworkHint items relevant to the requested +player.
+_read_slot_data_{slot}: JSONSerializableData -slot_databelonging to the requested slot.
+_read_item_name_groups_{game}:Record<string, string[]>- An object of item groups and their members.
+_read_location_name_groups_{game}:Record<string, string[]>- An object of location groups and their +members.
+_read_client_status_{team}_{slot}:number- The current status for the requested player. See +clientStatuses for all known client statues.
+_read_race_mode:number- Returns0if race mode is disabled,1if it's enabled.
+
Indexable
Additional arguments to be returned in RetrievedPacket.
+
Interface GoalJSONPacket
Sent to clients to broadcast a player has met their goal condition.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface GoalJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Goal";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Goal";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyslot
slot: number
Slot of the triggering player.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface HintJSONPacket
Sent to relevant clients to broadcast item hint information.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface HintJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
found: boolean;
item: NetworkItem;
receiving: number;
type: "Hint";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
found: boolean;
item: NetworkItem;
receiving: number;
type: "Hint";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyfound
found: boolean
Whether the location hinted for was checked.
+Readonlyitem
Source player's identifier, location identifier, item identifier and item flags.
+Readonlyreceiving
receiving: number
Destination player's identifier.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface InvalidArgumentsPacketPacket
Sent to clients if the server caught a problem with a given packet's arguments.
+See
InvalidPacketPacket for all possible InvalidPacket packet subtypes.
Interface InvalidCommandPacketPacket
Sent to clients if the server caught a problem with a given packet's cmd property.
See
InvalidPacketPacket for all possible InvalidPacket packet subtypes.
interface InvalidCommandPacketPacket {
cmd: "InvalidPacket";
original_cmd: string;
text: string;
type: "cmd";
}
cmd: "InvalidPacket";
original_cmd: string;
text: string;
type: "cmd";
}
Index
Properties
Interface ItemCheatJSONPacket
Sent to clients to broadcast a player has received a cheated item (via !getitem).
See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface ItemCheatJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
team: number;
type: "ItemCheat";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
team: number;
type: "ItemCheat";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyitem
Source player's identifier, location identifier, item identifier and item flags.
+Readonlyreceiving
receiving: number
Destination player's identifier.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface ItemSendJSONPacket
Sent to clients to broadcast a player has received an item.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface ItemSendJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
type: "ItemSend";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
type: "ItemSend";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyitem
Source player's identifier, location identifier, item identifier and item flags.
+Readonlyreceiving
receiving: number
Destination player's identifier.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface JoinJSONPacket
Sent to clients to broadcast a client has connected.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface JoinJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "Join";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "Join";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyslot
slot: number
Slot of the triggering player.
+Readonlytags
tags: string[]
Tags of the triggering player.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface LocationChecksPacket
Sent by the client to inform the server of locations that the client has checked. Used to inform the server of new +checks that are made, as well as to sync state.
+Interface LocationInfoPacket
Sent to clients to acknowledge a received LocationScoutsPacket and responds with the item in each location +being scouted.
+Interface LocationScoutsPacket
Sent by the client to inform the server of locations the client has seen, but not checked. Useful in cases in which +the item may appear in the game world, but may not be immediately gettable. The server will always respond with a +LocationInfoPacket with the items located in the scouted location.
+interface LocationScoutsPacket {
cmd: "LocationScouts";
create_as_hint: 0 | 1 | 2;
locations: number[];
}
cmd: "LocationScouts";
create_as_hint: 0 | 1 | 2;
locations: number[];
}
Index
Properties
Properties
Readonlycmd
cmd
Readonlycreate_
create_
-
+
- If set to
0, this packet will not create hints for any locations in this packet.
+ - If set to
1, this packet will create hints for all locations in this packet and broadcast them to all +relevant clients.
+ - If set to
2, this packet will create hints for all locations in this packet and broadcast only new hints to +all relevant clients.
+
Readonlylocations
locations: number[]
The ids of the locations seen by the client. May contain any number of locations, even ones sent before; +duplicates do not cause issues with the Archipelago server.
+Interface PartJSONPacket
Sent to clients to broadcast a client has disconnected.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface PartJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Part";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Part";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyslot
slot: number
Slot of the triggering player.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+
diff --git a/interfaces/API.ReleaseJSONPacket.html b/interfaces/API.ReleaseJSONPacket.html
new file mode 100644
index 0000000..8ddf5e8
--- /dev/null
+++ b/interfaces/API.ReleaseJSONPacket.html
@@ -0,0 +1,12 @@
+
Interface ReleaseJSONPacket
Sent to clients to broadcast a player has released all remaining items in their world.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface ReleaseJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Release";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Release";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyslot
slot: number
Slot of the triggering player.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface RetrievedPacket
Sent to clients as a response to a GetPacket.
+Additional arguments added to the GetPacket that triggered this RetrievedPacket will also be passed +along.
+interface RetrievedPacket {
cmd: "Retrieved";
keys: {
[key: string]: JSONSerializableData;
};
[p: string]: JSONSerializableData;
}
cmd: "Retrieved";
keys: {
[key: string]: JSONSerializableData;
};
[p: string]: JSONSerializableData;
}
Indexable
Additional arguments that were passed in from GetPacket.
+
Properties
Readonlycmd
cmd
Readonlykeys
A key-value collection containing all the values for the keys requested in the GetPacket.
+Interface RoomInfoPacket
Sent to clients when they connect to an Archipelago server, but before they authenticate.
+interface RoomInfoPacket {
cmd: "RoomInfo";
datapackage_checksums: Record<string, string>;
games: string[];
generator_version: NetworkVersion;
hint_cost: number;
location_check_points: number;
password: boolean;
permissions: PermissionTable;
seed_name: string;
tags: string[];
time: number;
version: NetworkVersion;
}
cmd: "RoomInfo";
datapackage_checksums: Record<string, string>;
games: string[];
generator_version: NetworkVersion;
hint_cost: number;
location_check_points: number;
password: boolean;
permissions: PermissionTable;
seed_name: string;
tags: string[];
time: number;
version: NetworkVersion;
}
Index
Properties
Properties
Readonlycmd
cmd
Readonlydatapackage_
datapackage_
Checksum hash of the individual games' data packages the server will send. Used by newer clients to decide which +games' caches are outdated. See DataPackage for more information on the data package.
+Readonlygames
games: string[]
List of games present in this multi-world.
+Readonlygenerator_
Object denoting the version of Archipelago which generated the multi-world.
+Readonlyhint_
hint_
The amount of points it costs to receive a hint from the server.
+Readonlylocation_
location_
The amount of hint points you receive per item/location check completed.
+Readonlypassword
password: boolean
Denoted whether a password is required to join this room.
+Readonlypermissions
Mapping of restrict-able commands to their current PermissionValue level.
+Readonlyseed_
seed_
Uniquely identifying name for this generation. Based on the seed, but not identical to prevent spoilers.
Readonlytags
tags: string[]
Denotes special features or capabilities that the sender is capable of. Example: WebHost
Readonlytime
time: number
Unix time stamp in seconds of "now". Sent for time synchronization if wanted for things like a DeathLink +BouncePacket.
+Readonlyversion
Object denoting the version of Archipelago which the server is running.
+Interface RoomUpdatePacket
Sent when there is a need to update information about the present game session. Generally useful for async games. +Once authenticated, this may also contain data from ConnectedPacket.
+All arguments for this packet are optional, only changes are sent.
+interface RoomUpdatePacket {
checked_locations?: number[];
cmd: "RoomUpdate";
hint_cost?: number;
hint_points?: number;
location_check_points?: number;
password?: boolean;
permissions: PermissionTable;
players?: NetworkPlayer[];
tags?: string[];
time?: number;
}
checked_locations?: number[];
cmd: "RoomUpdate";
hint_cost?: number;
hint_points?: number;
location_check_points?: number;
password?: boolean;
permissions: PermissionTable;
players?: NetworkPlayer[];
tags?: string[];
time?: number;
}
Index
Properties
Properties
Optional Readonlychecked_
checked_
Might be a partial update, containing new locations that were checked, especially from a co-op partner in the +same slot.
+Readonlycmd
cmd
Optional Readonlyhint_
hint_
The amount of points it costs to receive a hint from the server.
+Optional Readonlyhint_
hint_
Number of hint points that the current player has.
+Optional Readonlylocation_
location_
The amount of hint points you receive per item/location check completed.
+Optional Readonlypassword
password?: boolean
Denoted whether a password is required to join this room.
+Readonlypermissions
Mapping of restrict-able commands to their current PermissionValue level.
+Optional Readonlyplayers
Information on the players, whether connected or not.
+Optional Readonlytags
tags?: string[]
Denotes special features or capabilities that the sender is capable of. Example: WebHost
Optional Readonlytime
time?: number
Unix time stamp of "now". Send for time synchronization if wanted for things like a DeathLink +BouncePacket.
+
diff --git a/interfaces/API.ServerChatJSONPacket.html b/interfaces/API.ServerChatJSONPacket.html
new file mode 100644
index 0000000..ac2d3e5
--- /dev/null
+++ b/interfaces/API.ServerChatJSONPacket.html
@@ -0,0 +1,10 @@
+
Interface ServerChatJSONPacket
Sent to clients to broadcast a server-side chat message.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface ServerChatJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
type: "ServerChat";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
type: "ServerChat";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlymessage
message: string
Original chat message without sender prefix.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface SetNotifyPacket
Used to register your current session for receiving all SetReplyPackets of certain keys to allow your client +to keep track of changes.
+ Properties
Readonlycmd
cmd
Readonlykeys
keys: string[]
Keys to receive all SetReplyPackets for.
+Interface SetPacket
Sent by the client to write data to the server's data storage, that data can then be shared across worlds or just +saved for later. Values for keys in the data storage can be retrieved with a GetPacket, or monitored with a +SetNotifyPacket.
+Additional arguments sent in this package will also be added to the SetReplyPacket it triggers.
+interface SetPacket {
cmd: "Set";
default: JSONSerializableData;
key: string;
operations: DataStorageOperation[];
want_reply: boolean;
[p: string]: JSONSerializableData;
}
cmd: "Set";
default: JSONSerializableData;
key: string;
operations: DataStorageOperation[];
want_reply: boolean;
[p: string]: JSONSerializableData;
}
Indexable
Additional arguments to be returned in SetReplyPacket.
+
Index
Properties
Properties
Readonlycmd
cmd
Readonlydefault
The default value to use in case the key has no value on the server.
+Readonlykey
key: string
The key to manipulate.
+Readonlyoperations
Operations to apply to the value, multiple operations can be present, and they will be executed in order of +appearance. See DataStorageOperation for information on supported operations.
+Readonlywant_
want_
If set, the server will send a SetReplyPacket back to the client.
+Interface SetReplyPacket
Sent to clients in response to a SetPacket if want_reply was set to true, or if the client has registered
+to receive updates for a certain key using the SetNotifyPacket. SetReplyPackets are sent even if a
+SetPacket package did not alter the value for the key.
Additional arguments added to the SetPacket that triggered this SetReplyPacket will also be passed +along.
+interface SetReplyPacket {
cmd: "SetReply";
key: string;
original_value: JSONSerializableData;
value: JSONSerializableData;
[p: string]: JSONSerializableData;
}
cmd: "SetReply";
key: string;
original_value: JSONSerializableData;
value: JSONSerializableData;
[p: string]: JSONSerializableData;
}
Indexable
Additional arguments that were passed in from SetPacket.
+
Index
Properties
Interface StatusUpdatePacket
Sent to the server to update on the client's status. Examples include readiness or goal completion.
+ Properties
Readonlycmd
cmd
Readonlystatus
status:
| 0
| 5
| 10
| 20
| 30
| 0
| 5
| 10
| 20
| 30
The new client status value to set this slot to. See clientStatuses for all known values.
+Remarks
This packet is ignored if the client status was set to clientStatuses.goal.
+Interface SyncPacket
Sent to server to request a ReceivedItemsPacket with all items ever received.
+ Index
Properties
cmd
+
Interface TagsChangedJSONPacket
Sent to clients to broadcast a client has changed their tags.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
interface TagsChangedJSONPacket {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "TagsChanged";
}
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "TagsChanged";
}
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlyslot
slot: number
Slot of the triggering player.
+Readonlytags
tags: string[]
Tags of the triggering player.
+Readonlyteam
team: number
Team of the triggering player.
+Readonlytype
type
The PrintJSONPacket subtype.
+Interface TutorialJSONPacket
Sent to relevant clients to broadcast tutorial information, usually on first connection.
+See
PrintJSONPacket for all possible PrintJSON packet subtypes.
Properties
Readonlycmd
cmd
Readonlydata
All the textual metadata for this packet.
+Readonlytype
type
The PrintJSONPacket subtype.
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface BaseClientPacket
The base packet structure for all client packets.
-Hierarchy
-
- Index
-
-
-
Properties
-cmd
-
Properties
-Readonly cmd
-
-The type of packet this is.
-
-
-
\ No newline at end of file
diff --git a/interfaces/BaseServerPacket.html b/interfaces/BaseServerPacket.html
deleted file mode 100644
index b25a250..0000000
--- a/interfaces/BaseServerPacket.html
+++ /dev/null
@@ -1,205 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface BaseServerPacket
The base packet structure for all server packets.
-Hierarchy
-
- Index
-
-
-
Properties
-cmd
-
Properties
-Readonly cmd
-
-The type of packet this is.
-
-
-
\ No newline at end of file
diff --git a/interfaces/BouncePacket.html b/interfaces/BouncePacket.html
deleted file mode 100644
index 2e75f78..0000000
--- a/interfaces/BouncePacket.html
+++ /dev/null
@@ -1,236 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface BouncePacket
Sent by the client to have the server forward data to all clients that satisfy any given search criteria.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- BouncePacket
Properties
-cmd
-cmd: "Bounce"
-The type of packet this is.
-data
- -Any data you want to send.
-Optional games
-games?: string[]
-Optional. Game names that should receive this message.
-Optional slots
-slots?: number[]
-Optional. Player IDs that should receive this message.
-Optional tags
-tags?: string[]
-Optional. Client tags that should receive this message.
-
-
-
\ No newline at end of file
diff --git a/interfaces/BouncedPacket.html b/interfaces/BouncedPacket.html
deleted file mode 100644
index 1b9f974..0000000
--- a/interfaces/BouncedPacket.html
+++ /dev/null
@@ -1,236 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface BouncedPacket
Sent to clients after a client requested this message be sent to them, more info in the BouncePacket.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- BouncedPacket
Properties
-cmd
-cmd: "Bounced"
-The type of packet this is.
-data
- -A verbatim copy of the data in the BouncePacket package.
-Optional games
-games?: string[]
-Optional. Game names this message is targeting.
-Optional slots
-slots?: number[]
-Optional. Player slot IDs that this message is targeting.
-Optional tags
-tags?: string[]
-Optional. Client tags this message is targeting.
-
-
-
\ No newline at end of file
diff --git a/interfaces/ClientOptions.html b/interfaces/ClientOptions.html
new file mode 100644
index 0000000..e1f841e
--- /dev/null
+++ b/interfaces/ClientOptions.html
@@ -0,0 +1,26 @@
+Generated using TypeDoc
Interface ClientOptions
An interface of client options that can be set on a Client object.
+interface ClientOptions {
autoFetchDataPackage?: boolean;
debugLogVersions: boolean;
maximumMessages?: number;
timeout?: number;
}
autoFetchDataPackage?: boolean;
debugLogVersions: boolean;
maximumMessages?: number;
timeout?: number;
}
Index
Properties
Properties
Optionalauto
auto
Automatically requests the DataPackage from the server during Client.login, if the packages are missing +in the DataPackageManager.
+debug
debug
If enabled, logs the game, library version, and user agent to data storage, which can be used for debugging +purposes.
+Optionalmaximum
maximum
Determines the maximum number of chat messages to log in MessageManager.
+Optionaltimeout
timeout?: number
The maximum number of milliseconds to wait for a response from the server when awaiting a response to a client +packet.
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-items_
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface ConnectPacket
Sent by the client to initiate a connection to an Archipelago game session. Sent automatically during -connect.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- ConnectPacket
Properties
-cmd
-cmd: "Connect"
-The type of packet this is.
-game
-game: string
-The name of the game the client is playing.
-items_
-items_
-Bit flags configuring which items should be sent by the server. Read ItemsHandlingFlags for information -on individual flags.
-name
-name: string
-The slot name for this client.
-password
-password: string
-If the game session requires a password, it should be passed here.
-tags
-tags: string[]
-Denotes special features or capabilities that the sender is currently capable of.
-uuid
-uuid: string
-Unique identifier for player client.
-version
- -An object representing the minimum Archipelago server version this client supports.
-
-
-
\ No newline at end of file
diff --git a/interfaces/ConnectUpdatePacket.html b/interfaces/ConnectUpdatePacket.html
deleted file mode 100644
index 2f79f38..0000000
--- a/interfaces/ConnectUpdatePacket.html
+++ /dev/null
@@ -1,217 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-items_
-
-
-
-
-
-
-
-
-Interface ConnectUpdatePacket
Update arguments from the Connect packet, currently only updating tags and items_handling is supported.
Hierarchy
--
-
- BaseClientPacket
-
-
-
- ConnectUpdatePacket
- Index
-
-
-
Properties
-Properties
-cmd
-cmd: "ConnectUpdate"
-The type of packet this is.
-items_
-items_
-Bit flags configuring which items should be sent by the server. See ItemsHandlingFlags for additional -information.
-tags
-tags: string[]
-Denotes special features or capabilities that the sender is currently capable of.
-
-
-
\ No newline at end of file
diff --git a/interfaces/ConnectedPacket.html b/interfaces/ConnectedPacket.html
deleted file mode 100644
index 442772e..0000000
--- a/interfaces/ConnectedPacket.html
+++ /dev/null
@@ -1,282 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-checked_
-
-
-
-
-
-
-hint_
-
-
-
-missing_
-
-
-
-
-
-
-
-
-
-slot_
-
-
-
-
-slot_
-
-
-
-
-
-
-
-
-
-Interface ConnectedPacket
Sent to clients when the connection handshake is successfully completed.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- ConnectedPacket
- Index
-
-
-
Properties
-Properties
-checked_
-checked_
-Contains ids of all locations that have been checked. Useful for trackers, among other things. Location ids are -in the range of -2^53^ to +2^53^-1.
-cmd
-cmd: "Connected"
-The type of packet this is.
-hint_
-hint_
-Number of hint points that the current player has.
-missing_
-missing_
-Contains ids of remaining locations that need to be checked. Useful for trackers, among other things.
-players
- -List denoting other players in the multi-world, whether connected or not.
-slot
-slot: number
-Your slot number on your team. See NetworkPlayer for more info on the slot number.
-slot_
-
-Contains a json object for slot related data, differs per game. Empty if not required.
-slot_
-
-Object of each slot with their NetworkSlot information.
-
-
-Type declaration
--
-
-
-
[slot: number]: NetworkSlot
team
-team: number
-Your team number. See NetworkPlayer for more info on team number.
-
-
-
\ No newline at end of file
diff --git a/interfaces/ConnectionOptions.html b/interfaces/ConnectionOptions.html
new file mode 100644
index 0000000..4f1dee8
--- /dev/null
+++ b/interfaces/ConnectionOptions.html
@@ -0,0 +1,36 @@
+Generated using TypeDoc
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;
};
}
items?: number;
password?: string;
slotData?: boolean;
tags?: string[];
uuid?: string;
version?: {
build: number;
major: number;
minor: number;
};
}
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.
+Optional Readonlypassword
password?: string
The room password, if the server requires a password to join. Otherwise, optional.
+Optional Readonlyslot
slot
Request this slot's data during connection. If false, server will respond with an empty object ({}) instead.
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.
+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.
+Optional Readonlyversion
version?: {
build: number;
major: number;
minor: number;
}
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.
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface ConnectionRefusedPacket
Sent to clients when the server refuses connection. This is sent during the initial connection handshake.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- ConnectionRefusedPacket
Properties
-cmd
-cmd: "ConnectionRefused"
-The type of packet this is.
-Optional errors
-errors?: string[]
-Optional. When provided, should contain any one of the following ConnectionError enumerations or other -errors. See ConnectionError for additional information on what each error means.
-
-
-
\ No newline at end of file
diff --git a/interfaces/DataPackagePacket.html b/interfaces/DataPackagePacket.html
deleted file mode 100644
index 7418c86..0000000
--- a/interfaces/DataPackagePacket.html
+++ /dev/null
@@ -1,208 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface DataPackagePacket
Sent to clients to provide what is known as a 'data package' which contains information to enable a client to most -easily communicate with the Archipelago server. Contents include things like location id to name mappings, among -others; see DataPackage for more info.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- DataPackagePacket
Properties
-cmd
-cmd: "DataPackage"
-The type of packet this is.
-data
- -The data package as an object of DataPackage.
-
-
-
\ No newline at end of file
diff --git a/interfaces/GetDataPackagePacket.html b/interfaces/GetDataPackagePacket.html
deleted file mode 100644
index 4f8e2d4..0000000
--- a/interfaces/GetDataPackagePacket.html
+++ /dev/null
@@ -1,208 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface GetDataPackagePacket
Sent by the client to request the data package from the server. Does not require client authentication. Sent -automatically during connect.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- GetDataPackagePacket
Properties
-cmd
-cmd: "GetDataPackage"
-The type of packet this is.
-Optional games
-games?: string[]
-Optional. If specified, will only send back the specified data. Such as, ["Factorio"] ➔
-DataPackagePacket with only Factorio game data.
-
-
\ No newline at end of file
diff --git a/interfaces/GetPacket.html b/interfaces/GetPacket.html
deleted file mode 100644
index 2999318..0000000
--- a/interfaces/GetPacket.html
+++ /dev/null
@@ -1,213 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface GetPacket
Sent by the client to request a single or multiple values from the server's data storage, see the SetPacket -for how to write values to the data storage. A GetPacket will be answered with a RetrievedPacket.
-Additional properties sent in this package will also be added to the RetrievedPacket it triggers.
-Some special keys exist with specific return data, all of them have the prefix _read_.
-
-
_read_hints_{team}_{slot}: Hint[] - All known Hints belonging to the requested player.
-_read_slot_data_{slot}: JSONSerializableData -slot_databelonging to the requested slot.
-
Hierarchy
--
-
- BaseClientPacket
-
-
-
- GetPacket
Properties
-cmd
-cmd: "Get"
-The type of packet this is.
-keys
-keys: string[]
-Keys to retrieve the values for.
-
-
-
\ No newline at end of file
diff --git a/interfaces/InvalidPacketPacket.html b/interfaces/InvalidPacketPacket.html
deleted file mode 100644
index 1aee2e3..0000000
--- a/interfaces/InvalidPacketPacket.html
+++ /dev/null
@@ -1,227 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface InvalidPacketPacket
Sent to clients if the server caught a problem with a packet. This only occurs for errors that are explicitly checked -for.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- InvalidPacketPacket
- Index
-
-
-
Properties
-Properties
-cmd
-cmd: "InvalidPacket"
-The type of packet this is.
-Optional original_
-original_
-The cmd argument of the faulty packet, will be undefined if the cmd failed to be parsed.
text
-text: string
-A descriptive message of the problem at hand.
-type
-type: string
-The PacketProblemType that was detected in the packet.
-
-
-
\ No newline at end of file
diff --git a/interfaces/LocationChecksPacket.html b/interfaces/LocationChecksPacket.html
deleted file mode 100644
index 5e149e3..0000000
--- a/interfaces/LocationChecksPacket.html
+++ /dev/null
@@ -1,208 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface LocationChecksPacket
Sent by the client to inform the server of locations that the client has checked. Used to inform the server of new -checks that are made, as well as to sync state.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- LocationChecksPacket
Properties
-cmd
-cmd: "LocationChecks"
-The type of packet this is.
-locations
-locations: number[]
-The ids of the locations checked by the client. May contain any number of checks, even ones sent before; -duplicates do not cause issues with the Archipelago server.
-
-
-
\ No newline at end of file
diff --git a/interfaces/LocationInfoPacket.html b/interfaces/LocationInfoPacket.html
deleted file mode 100644
index 81864c3..0000000
--- a/interfaces/LocationInfoPacket.html
+++ /dev/null
@@ -1,207 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface LocationInfoPacket
Sent to clients to acknowledge a received LocationScoutsPacket and responds with the item in each location -being scouted.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- LocationInfoPacket
Properties
-cmd
-cmd: "LocationInfo"
-The type of packet this is.
-locations
- -Contains list of item(s) in the location(s) scouted.
-
-
-
\ No newline at end of file
diff --git a/interfaces/LocationScoutsPacket.html b/interfaces/LocationScoutsPacket.html
deleted file mode 100644
index a8d4b29..0000000
--- a/interfaces/LocationScoutsPacket.html
+++ /dev/null
@@ -1,220 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-create_
-
-
-
-
-
-
-
-
-
-Interface LocationScoutsPacket
Sent by the client to inform the server of locations the client has seen, but not checked. Useful in cases in which
-the item may appear in the game world, such as 'ledge items' in A Link to the Past. The server will always respond
-with a LocationInfoPacket with the items located in the scouted location.
Hierarchy
--
-
- BaseClientPacket
-
-
-
- LocationScoutsPacket
- Index
-
-
-
Properties
-Properties
-cmd
-cmd: "LocationScouts"
-The type of packet this is.
-create_
-
-If non-zero, the scouted locations get created and broadcast as a player-visible hint. If HINT_ONLY_NEW, only
-new hints are broadcast, however this does not remove them from the LocationInfo reply.
locations
-locations: number[]
-The ids of the locations seen by the client. May contain any number of locations, even ones sent before; -duplicates do not cause issues with the Archipelago server.
-
-
-
\ No newline at end of file
diff --git a/interfaces/ReceivedItemsPacket.html b/interfaces/ReceivedItemsPacket.html
deleted file mode 100644
index 0380a23..0000000
--- a/interfaces/ReceivedItemsPacket.html
+++ /dev/null
@@ -1,216 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface ReceivedItemsPacket
Sent to clients when they receive an item.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- ReceivedItemsPacket
Properties
-cmd
-cmd: "ReceivedItems"
-The type of packet this is.
-index
-index: number
-The next empty slot in the list of items for the receiving client. Useful for tracking items.
-items
- -The items which the client is receiving.
-
-
-
\ No newline at end of file
diff --git a/interfaces/RetrievedPacket.html b/interfaces/RetrievedPacket.html
deleted file mode 100644
index 7b112df..0000000
--- a/interfaces/RetrievedPacket.html
+++ /dev/null
@@ -1,213 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface RetrievedPacket
Sent to clients as a response to a GetPacket.
-Additional arguments added to the GetPacket that triggered this RetrievedPacket will also be passed -along.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- RetrievedPacket
Properties
-cmd
-cmd: "Retrieved"
-The type of packet this is.
-keys
- -A key-value collection containing all the values for the keys requested in the GetPacket.
-
-
-Type declaration
--
-
-
-
[key: string]: JSONSerializableData
-
-
\ No newline at end of file
diff --git a/interfaces/RoomInfoPacket.html b/interfaces/RoomInfoPacket.html
deleted file mode 100644
index 323f8a4..0000000
--- a/interfaces/RoomInfoPacket.html
+++ /dev/null
@@ -1,356 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-datapackage_
-
-
-
-
-
-
-generator_
-
-
-
-
-hint_
-
-
-
-location_
-
-
-
-
-
-
-
-
-
-seed_
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface RoomInfoPacket
Sent to clients when they connect to an Archipelago server, but before they authenticate.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- RoomInfoPacket
- Index
-
-
-
Properties
-Properties
-cmd
-cmd: "RoomInfo"
-The type of packet this is.
-datapackage_
-datapackage_
[game: string]: string;
}
-[game: string]: string;
}
Checksum hash of the individual games' data packages the server will send. Used by newer clients to decide which -games' caches are outdated. See DataPackage for more information on the data package.
-
-
-Type declaration
--
-
-
-
[game: string]: string
games
-games: string[]
-List of games present in this multiworld.
-generator_
-
-Object denoting the version of Archipelago which generated the multiworld.
-hint_
-hint_
-The amount of points it costs to receive a hint from the server.
-location_
-location_
-The amount of hint points you receive per item/location check completed.
-password
-password: boolean
-Denoted whether a password is required to join this room.
-permissions
- -Mapping of permission name to Permission, keys are: release, collect and remaining.
-
-Type declaration
--
-
-
-
collect: Permission
--Dictates what is allowed when it comes to a player collecting their run. A collect is an action which sends -the rest of the items in a player's run.
--
-
- Permission.AUTO: Automatically when they complete their goal. -
- Permission.ENABLED: Denotes that players may
!collectat any time in the game.
- - Permission.AUTO_ENABLED: Both of the above options together. -
- Permission.DISABLED: All collect modes disabled. -
- Permission.GOAL: Allows for manual use of
!collectcommand once a player completes their goal. -(Disabled until goal completion)
-
- -
-
release: Permission
--Dictates what is allowed when it comes to a player releasing their run. A release is an action which -distributes the rest of the items in a player's run to those other players awaiting them.
--
-
- Permission.AUTO: Distributes a player's items to other players when they complete their goal. -
- Permission.ENABLED: Denotes that players may
!releaseat any time in the game.
- - Permission.AUTO_ENABLED: Both of the above options together. -
- Permission.DISABLED: All forfeit modes disabled. -
- Permission.GOAL: Allows for manual use of
!releasecommand once a player completes their goal. -(Disabled until goal completion)
-
- -
-
remaining: ReducedPermission
--Dictates what is allowed when it comes to a player querying the items remaining in their run.
--
-
- Permission.GOAL: Allows a player to query for items remaining in their run but only after they -completed their own goal. -
- Permission.ENABLED: Denotes that players may query for any items remaining in their run (even -those belonging to other players). -
- Permission.DISABLED: All remaining item query modes disabled. -
seed_
-seed_
-Uniquely identifying name of this generation.
-tags
-tags: string[]
-Denotes special features or capabilities that the sender is capable of. Example: WebHost
time
-time: number
-Unix time stamp in seconds of "now". Send for time synchronization if wanted for things like a DeathLink -BouncePacket.
-version
- -Object denoting the version of Archipelago which the server is running.
-
-
-
\ No newline at end of file
diff --git a/interfaces/RoomUpdatePacket.html b/interfaces/RoomUpdatePacket.html
deleted file mode 100644
index 4cd2d33..0000000
--- a/interfaces/RoomUpdatePacket.html
+++ /dev/null
@@ -1,379 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface RoomUpdatePacket
Sent when there is a need to update information about the present game session. Generally useful for async games. -Once authenticated, this may also contain data from ConnectedPacket.
-All arguments for this packet are optional, only changes are sent.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- RoomUpdatePacket
- Index
-
-
-
Properties
-Properties
-Optional checked_
-checked_
-Might be a partial update, containing new locations that were checked, especially from a co-op partner in the -same slot.
-cmd
-cmd: "RoomUpdate"
-The type of packet this is.
-Optional datapackage_
-datapackage_
[game: string]: string;
}
-[game: string]: string;
}
Checksum hash of the individual games' data packages the server will send. Used by newer clients to decide which -games' caches are outdated. See DataPackage for more information on the data package.
-
-
-Type declaration
--
-
-
-
[game: string]: string
Optional games
-games?: string[]
-List of games present in this multiworld.
-Optional hint_
-hint_
-The amount of points it costs to receive a hint from the server.
-Optional hint_
-hint_
-Number of hint points that the current player has.
-Optional location_
-location_
-The amount of hint points you receive per item/location check completed.
-Optional password
-password?: boolean
-Denoted whether a password is required to join this room.
-Optional permissions
-
-Mapping of permission name to Permission, keys are: release, collect and remaining.
-
-Type declaration
--
-
-
-
collect: Permission
--Dictates what is allowed when it comes to a player collecting their run. A collect is an action which sends -the rest of the items in a player's run.
--
-
- Permission.AUTO: Automatically when they complete their goal. -
- Permission.ENABLED: Denotes that players may
!collectat any time in the game.
- - Permission.AUTO_ENABLED: Both of the above options together. -
- Permission.DISABLED: All collect modes disabled. -
- Permission.GOAL: Allows for manual use of
!collectcommand once a player completes their goal. -(Disabled until goal completion)
-
- -
-
release: Permission
--Dictates what is allowed when it comes to a player releasing their run. A release is an action which -distributes the rest of the items in a player's run to those other players awaiting them.
--
-
- Permission.AUTO: Distributes a player's items to other players when they complete their goal. -
- Permission.ENABLED: Denotes that players may
!releaseat any time in the game.
- - Permission.AUTO_ENABLED: Both of the above options together. -
- Permission.DISABLED: All release modes disabled. -
- Permission.GOAL: Allows for manual use of
!releasecommand once a player completes their goal. -(Disabled until goal completion)
-
- -
-
remaining: ReducedPermission
--Dictates what is allowed when it comes to a player querying the items remaining in their run.
--
-
- Permission.GOAL: Allows a player to query for items remaining in their run but only after they -completed their own goal. -
- Permission.ENABLED: Denotes that players may query for any items remaining in their run (even -those belonging to other players). -
- Permission.DISABLED: All remaining item query modes disabled. -
Optional players
-
-Information on the players, whether connected or not.
-Optional seed_
-seed_
-Uniquely identifying name of this generation.
-Optional tags
-tags?: string[]
-Denotes special features or capabilities that the sender is capable of. Example: WebHost
Optional time
-time?: number
-Unix time stamp of "now". Send for time synchronization if wanted for things like a DeathLink -BouncePacket.
-Optional version
-
-Object denoting the version of Archipelago which the server is running.
-
-
-
\ No newline at end of file
diff --git a/interfaces/SayPacket.html b/interfaces/SayPacket.html
deleted file mode 100644
index 05c4c9e..0000000
--- a/interfaces/SayPacket.html
+++ /dev/null
@@ -1,206 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface SayPacket
Basic chat-type packet which sends text to the server to be distributed to other clients.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- SayPacket
Properties
-cmd
-cmd: "Say"
-The type of packet this is.
-text
-text: string
-Text to send to others.
-
-
-
\ No newline at end of file
diff --git a/interfaces/SetNotifyPacket.html b/interfaces/SetNotifyPacket.html
deleted file mode 100644
index 7944df9..0000000
--- a/interfaces/SetNotifyPacket.html
+++ /dev/null
@@ -1,207 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface SetNotifyPacket
Used to register your current session for receiving all SetReplyPackets of certain keys to allow your client -to keep track of changes.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- SetNotifyPacket
Properties
-cmd
-cmd: "SetNotify"
-The type of packet this is.
-keys
-keys: string[]
-Keys to receive all SetReplyPackets for.
-
-
-
\ No newline at end of file
diff --git a/interfaces/SetPacket.html b/interfaces/SetPacket.html
deleted file mode 100644
index 6fcb592..0000000
--- a/interfaces/SetPacket.html
+++ /dev/null
@@ -1,240 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface SetPacket
Sent by the client to write data to the server's data storage, that data can then be shared across worlds or just -saved for later. Values for keys in the data storage can be retrieved with a GetPacket, or monitored with a -SetNotifyPacket.
-Additional arguments sent in this package will also be added to the SetReplyPacket it triggers.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- SetPacket
- Index
-
-
-
Properties
-Properties
-Readonly cmd
-cmd: "Set"
-The type of packet this is.
-Readonly default
-
-The default value to use in case the key has no value on the server.
-Readonly key
-key: string
-The key to manipulate.
-Readonly operations
-
-Operations to apply to the value, multiple operations can be present, and they will be executed in order of -appearance. See DataStorageOperation for information on supported operations.
-Readonly want_
-want_
-If set, the server will send a SetReplyPacket back to the client.
-
-
-
\ No newline at end of file
diff --git a/interfaces/SetReplyPacket.html b/interfaces/SetReplyPacket.html
deleted file mode 100644
index 11de4c0..0000000
--- a/interfaces/SetReplyPacket.html
+++ /dev/null
@@ -1,230 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface SetReplyPacket
Sent to clients in response to a SetPacket if want_reply was set to true, or if the client has registered
-to receive updates for a certain key using the SetNotifyPacket. SetReplyPackets are sent even if a
-SetPacket package did not alter the value for the key.
Additional arguments added to the SetPacket that triggered this SetReplyPacket will also be passed -along.
-Hierarchy
--
-
- BaseServerPacket
-
-
-
- SetReplyPacket
- Index
-
-
-
Properties
-Properties
-Readonly cmd
-cmd: "SetReply"
-The type of packet this is.
-Readonly key
-key: string
-The key that was updated.
-Readonly original_
-
-The value the key had before it was updated.
-Readonly value
-
-The new value for the key.
-
-
-
\ No newline at end of file
diff --git a/interfaces/StatusUpdatePacket.html b/interfaces/StatusUpdatePacket.html
deleted file mode 100644
index 5219ca9..0000000
--- a/interfaces/StatusUpdatePacket.html
+++ /dev/null
@@ -1,207 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface StatusUpdatePacket
Sent to the server to update on the client's status. Examples include readiness or goal completion. (Example:
-Defeated Ganon in A Link to the Past)
Hierarchy
--
-
- BaseClientPacket
-
-
-
- StatusUpdatePacket
Properties
-cmd
-cmd: "StatusUpdate"
-The type of packet this is.
-status
- -One of ClientStatus enumerations. See link for more information.
-
-
-
\ No newline at end of file
diff --git a/interfaces/SyncPacket.html b/interfaces/SyncPacket.html
deleted file mode 100644
index 4b16abf..0000000
--- a/interfaces/SyncPacket.html
+++ /dev/null
@@ -1,196 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface SyncPacket
Sent to server to request a ReceivedItemsPacket to resynchronize items if a "desync" ever occurs.
-Hierarchy
--
-
- BaseClientPacket
-
-
-
- SyncPacket
- Index
-
-
-
Properties
-cmd
-
Properties
-cmd
-cmd: "Sync"
-The type of packet this is.
-
-
-
\ No newline at end of file
diff --git a/modules.html b/modules.html
index 10d6605..d1cf315 100644
--- a/modules.html
+++ b/modules.html
@@ -1,302 +1,32 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-archipelago.js - v1.1.0
Index
-Classes
-Interfaces - Client Packets
-Interfaces - Server Packets
-Type Aliases - Data Storage Operations
-Add
Type Aliases - Other
-Admin
Type Aliases - Server Packets
-Variables
-CLIENT_
-
-
\ No newline at end of file
+Generated using TypeDoc
archipelago.js - v2.0.0-rc1
Index
Namespaces
API
+
Classes
Interfaces
Type Aliases
Variables
Namespace API
A collection of types, constants, and enumerations that get passed over the Archipelago network protocol.
+You can read more information about the Network Protocol in the Archipelago +Network Protocol +documentation on their GitHub repository. +API
+Index
DataStorage
Add
Network Packets
Admin
Other
Client
Type Alias AddDataStorageOperation
Adds value to the current value of the key, if both the current value and value are arrays then value will be
+appended to the current value.
Type declaration
Readonlyoperation: "add"Readonlyvalue: number | JSONSerializableData[]A value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias AndDataStorageOperation
And
operation: "and";
value: number;
}
operation: "and";
value: number;
}
Applies a bitwise AND to the current value of the key with value.
Type declaration
Readonlyoperation: "and"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias CeilingDataStorageOperation
Ceiling
operation: "ceil";
value: null;
}
operation: "ceil";
value: null;
}
Rounds up the current value to the nearest integer.
+Type declaration
Readonlyoperation: "ceil"Readonlyvalue: nullIgnored for this operation.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias ClientPacket
Client
| BouncePacket
| ConnectPacket
| ConnectUpdatePacket
| GetPacket
| GetDataPackagePacket
| LocationChecksPacket
| LocationScoutsPacket
| SayPacket
| SetPacket
| SetNotifyPacket
| StatusUpdatePacket
| SyncPacket
| BouncePacket
| ConnectPacket
| ConnectUpdatePacket
| GetPacket
| GetDataPackagePacket
| LocationChecksPacket
| LocationScoutsPacket
| SayPacket
| SetPacket
| SetNotifyPacket
| StatusUpdatePacket
| SyncPacket
Type Alias ColorJSONMessagePart
A textual node containing color metadata.
+Type declaration
Readonlycolor: ValidJSONColorTypeIncludes the color to print this text with.
+Readonlytext: stringUsed to supply text data for this node.
+Readonlytype: "color"Used to denote the intent of the message part.
+
See
JSONMessagePart for all possible message part node subtypes.
+Type Alias ConnectionError
Connection
| "InvalidSlot"
| "InvalidGame"
| "IncompatibleVersion"
| "InvalidPassword"
| "InvalidItemsHandling"
| "InvalidSlot"
| "InvalidGame"
| "IncompatibleVersion"
| "InvalidPassword"
| "InvalidItemsHandling"
A union of known errors the Archipelago server can send back to the client when they receive a +ConnectionRefusedPacket.
+Type Alias DataPackage
A DataPackage is an object which contains arbitrary metadata about each game to enable a client to interact +with the Archipelago server easily.
+Note:
+-
+
- Any
nameis unique to its type across its own Game only: Single Arrow can exist in two games.
+ - The
ids from the gameArchipelagomay be used in any other game. Especially Location ID-1:Cheat Console+and-2:Server(typically Remote Start Inventory).
+
Type declaration
Readonlygames: Record<string, GamePackage>Mapping of all Games and their respective data. See GamePackage for additional info.
+
Type Alias DataStorageOperation
Data
| ReplaceDataStorageOperation
| DefaultDataStorageOperation
| AddDataStorageOperation
| MultiplyDataStorageOperation
| PowerDataStorageOperation
| ModuloDataStorageOperation
| FloorDataStorageOperation
| CeilingDataStorageOperation
| MaxDataStorageOperation
| MinDataStorageOperation
| AndDataStorageOperation
| OrDataStorageOperation
| XorDataStorageOperation
| LeftShiftDataStorageOperation
| RightShiftDataStorageOperation
| RemoveDataStorageOperation
| PopDataStorageOperation
| UpdateDataStorageOperation
| ReplaceDataStorageOperation
| DefaultDataStorageOperation
| AddDataStorageOperation
| MultiplyDataStorageOperation
| PowerDataStorageOperation
| ModuloDataStorageOperation
| FloorDataStorageOperation
| CeilingDataStorageOperation
| MaxDataStorageOperation
| MinDataStorageOperation
| AndDataStorageOperation
| OrDataStorageOperation
| XorDataStorageOperation
| LeftShiftDataStorageOperation
| RightShiftDataStorageOperation
| RemoveDataStorageOperation
| PopDataStorageOperation
| UpdateDataStorageOperation
A union of all possible DataStorages. An operation manipulates or alters the value of a key in the data +storage. If the operation transforms the value from one state to another then the current value of the key is used +as the starting point otherwise the SetPacket's default is used if the key does not exist on the server +already.
+Each operation object consists of an object containing both the operation to be applied, provided in the form of a
+string, and the value to be used for that operation,
Type Alias DefaultDataStorageOperation
Default
operation: "default";
value: null;
}
operation: "default";
value: null;
}
If the key has no value yet, sets the current value of the key to default of the SetPacket's (value is
+ignored).
Type declaration
Readonlyoperation: "default"Readonlyvalue: nullA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias FloorDataStorageOperation
Floor
operation: "floor";
value: null;
}
operation: "floor";
value: null;
}
Rounds down the current value to the nearest integer.
+Type declaration
Readonlyoperation: "floor"Readonlyvalue: nullIgnored for this operation.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias GamePackage
Game
checksum: string;
item_name_to_id: Record<string, number>;
location_name_to_id: Record<string, number>;
}
checksum: string;
item_name_to_id: Record<string, number>;
location_name_to_id: Record<string, number>;
}
Collection of data that contains meta information for a particular game.
+Type declaration
Readonlychecksum: stringSHA1 checksum of this game's data.
+Readonlyitem_name_ to_ id: Record<string, number> Mapping of all item names to their respective id.
+Readonlylocation_name_ to_ id: Record<string, number> Mapping of all location names to their respective id.
+
Type Alias InvalidPacketPacket
A union of possible InvalidPacket packets. Sent to clients if the server caught a problem with a packet. See each
+packet subtype for more details.
Type Alias ItemJSONMessagePart
ItemJSONMessage
flags: number;
player: number;
text: string;
type: "item_id" | "item_name";
}
flags: number;
player: number;
text: string;
type: "item_id" | "item_name";
}
A textual node containing item metadata.
+Type declaration
Readonlyflags: numberBit flags that determine if an item is progression, "nice to have", filler, or a trap.
+Readonlyplayer: numberThe
+idof the player who owns this item.Readonlytext: stringUsed to supply text data for this node.
+Readonlytype: "item_id" | "item_name"Used to denote the intent of the message part.
+
See
JSONMessagePart for all possible message part node subtypes.
+Type Alias JSONMessagePart
JSONMessage
| ItemJSONMessagePart
| LocationJSONMessagePart
| ColorJSONMessagePart
| TextJSONMessagePart
| ItemJSONMessagePart
| LocationJSONMessagePart
| ColorJSONMessagePart
| TextJSONMessagePart
A union of all message node subtypes sent along with PrintJSONPacket, which can be reconstructed into a +legible message. Each node is intended to be read in the order provided in the packet.
+Type Alias JSONSerializableData
JSONSerializable
| string
| number
| boolean
| null
| {
[p: string]: JSONSerializableData;
}
| JSONSerializableData[]
| string
| number
| boolean
| null
| {
[p: string]: JSONSerializableData;
}
| JSONSerializableData[]
A type union of all basic JSON-compatible types.
+Type Alias LeftShiftDataStorageOperation
Left
operation: "left_shift";
value: number;
}
operation: "left_shift";
value: number;
}
Applies a bitwise left-shift to the current value of the key by value.
Type declaration
Readonlyoperation: "left_shift"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias LocationJSONMessagePart
LocationJSONMessage
player: number;
text: string;
type: "location_id" | "location_name";
}
player: number;
text: string;
type: "location_id" | "location_name";
}
A textual node containing location metadata.
+Type declaration
Readonlyplayer: numberThe
+idof the player who has this location.Readonlytext: stringUsed to supply text data for this node.
+Readonlytype: "location_id" | "location_name"Used to denote the intent of the message part.
+
See
JSONMessagePart for all possible message part node subtypes.
+Type Alias MaxDataStorageOperation
Max
operation: "max";
value: number;
}
operation: "max";
value: number;
}
Sets the current value of the key to value if value is bigger.
Type declaration
Readonlyoperation: "max"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias MinDataStorageOperation
Min
operation: "min";
value: number;
}
operation: "min";
value: number;
}
Sets the current value of the key to value if value is lower.
Type declaration
Readonlyoperation: "min"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias ModuloDataStorageOperation
Modulo
operation: "mod";
value: number;
}
operation: "mod";
value: number;
}
Sets the current value of the key to the remainder after division by value.
Type declaration
Readonlyoperation: "mod"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias MultiplyDataStorageOperation
Multiply
operation: "mul";
value: number;
}
operation: "mul";
value: number;
}
Multiplies the current value of the key by value.
Type declaration
Readonlyoperation: "mul"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias NetworkHint
Network
entrance: string;
finding_player: number;
found: boolean;
item: number;
item_flags: number;
location: number;
receiving_player: number;
}
entrance: string;
finding_player: number;
found: boolean;
item: number;
item_flags: number;
location: number;
receiving_player: number;
}
An object representing a hint information for a particular item and location that contains it.
+Type declaration
Readonlyentrance: stringThe name of the entrance to the location where this item is located.
+Readonlyfinding_player: number The id of the player who has this item in their world.
+Readonlyfound: booleanWhether this item has already been found.
+Readonlyitem: numberThe id of this item.
+Readonlyitem_flags: number The classification bit flags for this item. See itemsHandlingFlags for known flags.
+Readonlylocation: numberThe id of the location for this item.
+Readonlyreceiving_player: number The id of the player who owns this item.
+
Type Alias NetworkItem
Network
flags: number;
item: number;
location: number;
player: number;
}
flags: number;
item: number;
location: number;
player: number;
}
Items that are sent over the network.
+Type declaration
Readonlyflags: numberThe classification bit flags for this item. See itemsHandlingFlags for known flags.
+Readonlyitem: numberThe item id of the item. Item ids are in the range of -2^53 to +2^53-1.
+Readonlylocation: numberThe location id of the location inside the world. Location ids are in the range of -2^53 to +2^53 - 1.
+Readonlyplayer: numberThe slot id for the player whose world the item was located in, except when inside a LocationInfoPacket, +then it will be the slot id of the player the item belongs to.
+
Type Alias NetworkPlayer
Network
alias: string;
name: string;
slot: number;
team: number;
}
alias: string;
name: string;
slot: number;
team: number;
}
An object that contains metadata about an individual player on the network.
+Type declaration
Readonlyalias: stringRepresents the player's name in current time. Can be changed during a game with the
+!alias <name>command by +the player.Readonlyname: stringThe original slot name as defined by the player's configuration file. Individual names are unique among players.
+Readonlyslot: numberDetermines the slot id for this player. Slot numbers are unique per team and start at
+1. Slot number0refers +to the Archipelago server; this may appear in instances where the server grants the player an item.Readonlyteam: numberDetermines the team the player is on. Useful for competitive seeds. Team numbers start at
+0.
Type Alias NetworkSlot
Network
game: string;
group_members: number[];
name: string;
type: typeof slotTypes[keyof typeof slotTypes];
}
game: string;
group_members: number[];
name: string;
type: typeof slotTypes[keyof typeof slotTypes];
}
An object representing metadata about a given slot on each team.
+Type declaration
Readonlygame: stringThe game this slot is playing.
+Readonlygroup_members: number[] Contains a list of player ids, if the
+typeis slotTypes.group. Used for item links, otherwise empty.Readonlyname: stringThe original slot name as defined by the player's configuration file. Individual names are unique among players.
+Readonlytype: typeof slotTypes[keyof typeof slotTypes]The type of slot this is. See slotTypes for known slot types.
+
Type Alias NetworkVersion
Network
build: number;
class: "Version";
major: number;
minor: number;
}
build: number;
class: "Version";
major: number;
minor: number;
}
An object representing software versioning. Used in the ConnectPacket to allow the client to inform the +server the minimum Archipelago version it supports.
+Type declaration
Readonlybuild: numberThe build/patch component of the version number. (e.g., 0.0.X)
+Readonlyclass: "Version"Apparently required to be present to ensure the Archipelago server parses this object correctly.
+Readonlymajor: numberThe major component of the version number. (e.g., X.0.0)
+Readonlyminor: numberThe minor component of the version number. (e.g., 0.X.0)
+
Type Alias OrDataStorageOperation
Or
operation: "or";
value: number;
}
operation: "or";
value: number;
}
Applies a bitwise OR to the current value of the key with value.
+Type declaration
Readonlyoperation: "or"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias PermissionTable
Permission
collect: PermissionValue;
release: PermissionValue;
remaining: Omit<PermissionValue, typeof auto | typeof autoEnabled>;
}
collect: PermissionValue;
release: PermissionValue;
remaining: Omit<PermissionValue, typeof auto | typeof autoEnabled>;
}
Mapping of restrict-able commands to their current permissions level.
+Type declaration
Readonlycollect: PermissionValueDictates what is allowed when it comes to a player collecting their run. A collect is an action which sends +the rest of the items in a player's run.
+-
+
- permissions.auto: Automatically when they complete their goal. +
- permissions.enabled: Denotes that players may
!collectat any time in the game.
+ - permissions.autoEnabled: Both of the above options together. +
- permissions.disabled: All collect modes disabled. +
- permissions.goal: Allows for manual use of
!collectcommand once a player completes their +goal (disabled until goal completion).
+
Readonlyrelease: PermissionValueDictates what is allowed when it comes to a player releasing their run. A release is an action which +distributes the rest of the items in a player's run to those other players awaiting them.
+-
+
- permissions.auto: Distributes a player's items to other players when they complete their goal. +
- permissions.enabled: Denotes that players may
!releaseat any time in the game.
+ - permissions.autoEnabled: Both of the above options together. +
- permissions.disabled: All forfeit modes disabled. +
- permissions.goal: Allows for manual use of
!releasecommand once a player completes their +goal (disabled until goal completion).
+
Readonlyremaining: Omit<PermissionValue, typeof auto | typeof autoEnabled>Dictates what is allowed when it comes to a player querying the items remaining in their run.
+-
+
- permissions.goal: Allows a player to query for items remaining in their run but only after they +completed their own goal. +
- permissions.enabled: Denotes that players may query for any items remaining in their run (even +those belonging to other players). +
- permissions.disabled: All remaining item query modes disabled. +
Remarks
This command cannot have the permissions.auto or permissions.autoEnabled permission.
+
Type Alias PermissionValue
The type for a given permission value.
+Type Alias PopDataStorageOperation
List or Dict only: for lists it will remove the index of the value given. For dicts it removes the element with
+the specified key of value.
Type declaration
Readonlyoperation: "pop"Readonlyvalue: JSONSerializableDataA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias PowerDataStorageOperation
Power
operation: "pow";
value: number;
}
operation: "pow";
value: number;
}
Multiplies the current value of the key to the power of value.
Type declaration
Readonlyoperation: "pow"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias PrintJSONPacket
PrintJSONPacket:
| ItemSendJSONPacket
| ItemCheatJSONPacket
| HintJSONPacket
| JoinJSONPacket
| PartJSONPacket
| ChatJSONPacket
| ServerChatJSONPacket
| TutorialJSONPacket
| TagsChangedJSONPacket
| CommandResultJSONPacket
| AdminCommandResultJSONPacket
| GoalJSONPacket
| ReleaseJSONPacket
| CollectJSONPacket
| CountdownJSONPacket
| ItemSendJSONPacket
| ItemCheatJSONPacket
| HintJSONPacket
| JoinJSONPacket
| PartJSONPacket
| ChatJSONPacket
| ServerChatJSONPacket
| TutorialJSONPacket
| TagsChangedJSONPacket
| CommandResultJSONPacket
| AdminCommandResultJSONPacket
| GoalJSONPacket
| ReleaseJSONPacket
| CollectJSONPacket
| CountdownJSONPacket
A union of possible PrintJSON packets. Sent to clients purely to display a message to the player. While various
+message types provide additional arguments, clients only need to evaluate the data argument to construct the
+human-readable message text. All other arguments may be ignored safely.
Type Alias PrintJSONType
PrintJSONType:
| "ItemSend"
| "ItemCheat"
| "Hint"
| "Join"
| "Part"
| "Chat"
| "ServerChat"
| "Tutorial"
| "TagsChanged"
| "CommandResult"
| "AdminCommandResult"
| "Goal"
| "Release"
| "Collect"
| "Countdown"
| "ItemSend"
| "ItemCheat"
| "Hint"
| "Join"
| "Part"
| "Chat"
| "ServerChat"
| "Tutorial"
| "TagsChanged"
| "CommandResult"
| "AdminCommandResult"
| "Goal"
| "Release"
| "Collect"
| "Countdown"
A union of all known PrintJSONPacket types.
+Type Alias RemoveDataStorageOperation
List only: removes the first instance of value found in the list.
Type declaration
Readonlyoperation: "remove"Readonlyvalue: JSONSerializableDataA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias ReplaceDataStorageOperation
Sets the current value of the key to value.
Type declaration
Readonlyoperation: "replace"Readonlyvalue: JSONSerializableDataA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias RightShiftDataStorageOperation
Right
operation: "right_shift";
value: number;
}
operation: "right_shift";
value: number;
}
Applies a bitwise right-shift to the current value of the key by value.
Type declaration
Readonlyoperation: "right_shift"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias ServerPacket
Type Alias TextJSONMessagePart
TextJSONMessage
text: string;
type?:
| "text"
| "entrance_name"
| "player_id"
| "player_name";
}
text: string;
type?:
| "text"
| "entrance_name"
| "player_id"
| "player_name";
}
A textual node containing plaintext metadata.
+Type declaration
Readonlytext: stringUsed to supply text data for this node.
+OptionalReadonlytype?:
| "text"
| "entrance_name"
| "player_id"
| "player_name"Used to denote the intent of the message part.
+
See
JSONMessagePart for all possible message part node subtypes.
+Type Alias UpdateDataStorageOperation
Dict only: Updates the dictionary with the specified elements given in value creating new keys, or updating old
+ones if they previously existed.
Type declaration
Readonlyoperation: "update"Readonlyvalue: JSONSerializableDataA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+Type Alias ValidJSONColorType
ValidJSONColor
| "bold"
| "underline"
| "black"
| "red"
| "green"
| "yellow"
| "blue"
| "magenta"
| "cyan"
| "white"
| "black_bg"
| "red_bg"
| "green_bg"
| "yellow_bg"
| "blue_bg"
| "purple_bg"
| "cyan_bg"
| "white_bg"
| "bold"
| "underline"
| "black"
| "red"
| "green"
| "yellow"
| "blue"
| "magenta"
| "cyan"
| "white"
| "black_bg"
| "red_bg"
| "green_bg"
| "yellow_bg"
| "blue_bg"
| "purple_bg"
| "cyan_bg"
| "white_bg"
This is a type union of all supported "colors" denoting a console color to display the message part with and is only
+sent if the type is color. This is limited to console colors due to backwards compatibility needs with games such
+as A Link to the Past. Although background colors as well as foreground colors are listed, only one may be applied
+to a JSONMessagePart at a time.
Type Alias ValidJSONMessagePartType
ValidJSONMessage
| "text"
| "player_id"
| "player_name"
| "item_id"
| "item_name"
| "location_id"
| "location_name"
| "entrance_name"
| "color"
| "text"
| "player_id"
| "player_name"
| "item_id"
| "item_name"
| "location_id"
| "location_name"
| "entrance_name"
| "color"
This is a type union of all supported message types for denoting the intent of the message part. This can be used to +indicate special information which may be rendered differently depending on client.
+-
+
text: Regular text content. This is also the default type and is often omitted.
+player_id: Player id of someone on your team, should be resolved to player Name.
+player_name: Player Name, could be a player within a multiplayer game or from another team, not id resolvable.
+item_id: Item id, should be resolved to an item name.
+item_name: Item name, not currently used over network, but supported by reference clients.
+location_id: Location id, should be resolved to a location name.
+location_name: Location name, not currently used over network, but supported by reference clients.
+entrance_name: Entrance name. No id mapping exists.
+color: Regular text that should be colored. Only type that will contain color data.
+
Type Alias XorDataStorageOperation
Xor
operation: "xor";
value: number;
}
operation: "xor";
value: number;
}
Applies a bitwise XOR to the current value of the key with value.
Type declaration
Readonlyoperation: "xor"Readonlyvalue: numberA value for the operation to apply against the current data storage value.
+
See
DataStorageOperation for all possible operation subtypes.
+
-
-
-
-
-
-
-
-Type alias AddDataStorageOperation
Add
operation: "add";
value: number | number[];
}
-operation: "add";
value: number | number[];
}
Adds value to the current value of the key, if both the current value and value are arrays then value will
-be appended to the current value.
-
-Type declaration
--
-
-
-
operation: "add"
- -
-
value: number | number[]
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/AdminCommandResultJSONPacket.html b/types/AdminCommandResultJSONPacket.html
deleted file mode 100644
index 0c12967..0000000
--- a/types/AdminCommandResultJSONPacket.html
+++ /dev/null
@@ -1,177 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias AdminCommandResultJSONPacket
Admin
cmd: "PrintJSON";
data: JSONMessagePart[];
type: "AdminCommandResult";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
type: "AdminCommandResult";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
type: "AdminCommandResult"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/AndDataStorageOperation.html b/types/AndDataStorageOperation.html
deleted file mode 100644
index e2ae294..0000000
--- a/types/AndDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias AndDataStorageOperation
And
operation: "and";
value: number;
}
-operation: "and";
value: number;
}
Applies a bitwise AND to the current value of the key with value.
-
-Type declaration
--
-
-
-
operation: "and"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/ArchipelagoPacket.html b/types/ArchipelagoPacket.html
deleted file mode 100644
index e46fe85..0000000
--- a/types/ArchipelagoPacket.html
+++ /dev/null
@@ -1,165 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias ArchipelagoPacket
A type union of all known and supported Archipelago packets.
-
-
-
\ No newline at end of file
diff --git a/types/AwaitSetReply.html b/types/AwaitSetReply.html
deleted file mode 100644
index c5de678..0000000
--- a/types/AwaitSetReply.html
+++ /dev/null
@@ -1,183 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias AwaitSetReply
Await
key: string;
resolve: ((value) => void);
}
-key: string;
resolve: ((value) => void);
}
A helper object for awaiting a key to return from a Set request.
-
-
-Type declaration
--
-
-
-
key: string
- -
-
resolve: ((value) => void)
--
-
-
-
-
-
- (value): void -
-
---
Parameters
--
-
-
-
value: PromiseLike<SetReplyPacket> | SetReplyPacket
Returns void
-
-
-
-
-
-
\ No newline at end of file
diff --git a/types/ChatJSONPacket.html b/types/ChatJSONPacket.html
deleted file mode 100644
index 3034891..0000000
--- a/types/ChatJSONPacket.html
+++ /dev/null
@@ -1,192 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ChatJSONPacket
ChatJSONPacket: {
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
slot: number;
team: number;
type: "Chat";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
slot: number;
team: number;
type: "Chat";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
message: string
--Original chat message without sender prefix.
-
- -
-
slot: number
--Slot of the triggering player.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "Chat"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/ClientPacket.html b/types/ClientPacket.html
deleted file mode 100644
index 78f0f10..0000000
--- a/types/ClientPacket.html
+++ /dev/null
@@ -1,165 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ClientPacket
Client
-A type union of all known and supported Archipelago client packets.
-
-
-
\ No newline at end of file
diff --git a/types/ClientPacketType.html b/types/ClientPacketType.html
deleted file mode 100644
index 080ffbe..0000000
--- a/types/ClientPacketType.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ClientPacketType
-
-
\ No newline at end of file
diff --git a/types/ClientStatus.html b/types/ClientStatus.html
index 670b592..5f3c29d 100644
--- a/types/ClientStatus.html
+++ b/types/ClientStatus.html
@@ -1,162 +1,2 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ClientStatus
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias ClientStatus
A type alias for any known client status. See clientStatuses for more information.
+
-
-
-
-
-
-
-Type alias CollectJSONPacket
CollectJSONPacket: {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Collect";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Collect";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
slot: number
--Slot of the triggering player.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "Collect"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/ColorJSONMessagePart.html b/types/ColorJSONMessagePart.html
deleted file mode 100644
index 1980ae6..0000000
--- a/types/ColorJSONMessagePart.html
+++ /dev/null
@@ -1,180 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ColorJSONMessagePart
-
Type declaration
--
-
-
-
color: ValidJSONColorType
--Includes the color to print this text with.
-
- -
-
text: string
--Used to supply text data for this node.
-
- -
-
type: "color"
--Used to denote the intent of the message part.
-
-
-
\ No newline at end of file
diff --git a/types/CommandResultJSONPacket.html b/types/CommandResultJSONPacket.html
deleted file mode 100644
index b0bef56..0000000
--- a/types/CommandResultJSONPacket.html
+++ /dev/null
@@ -1,177 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias CommandResultJSONPacket
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
type: "CommandResult"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/CommonTags.html b/types/CommonTags.html
deleted file mode 100644
index 0fc636d..0000000
--- a/types/CommonTags.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias CommonTags
-
-
\ No newline at end of file
diff --git a/types/ConnectionError.html b/types/ConnectionError.html
deleted file mode 100644
index 1a3a9c5..0000000
--- a/types/ConnectionError.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ConnectionError
-
-
\ No newline at end of file
diff --git a/types/ConnectionInformation.html b/types/ConnectionInformation.html
deleted file mode 100644
index 505a652..0000000
--- a/types/ConnectionInformation.html
+++ /dev/null
@@ -1,228 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ConnectionInformation
Connection
game: string;
hostname: string;
items_handling: number | ItemsHandlingFlags;
name: string;
password?: string;
port: number;
protocol?: "ws" | "wss";
tags?: string[];
uuid?: string;
version?: {
build: number;
major: number;
minor: number;
};
}
-game: string;
hostname: string;
items_handling: number | ItemsHandlingFlags;
name: string;
password?: string;
port: number;
protocol?: "ws" | "wss";
tags?: string[];
uuid?: string;
version?: {
build: number;
major: number;
minor: number;
};
}
An object that holds credential information for a slot to connect.
-
-
-Type declaration
--
-
-
-
game: string
--The name of the game the client is playing.
-
- -
-
hostname: string
--The hostname or ip address of the Archipelago server to connect to.
-
- -
-
items_
-handling: number | ItemsHandlingFlags -Bit flags configuring which items should be sent by the server. Read ItemsHandlingFlags for information -on individual flags.
-
- -
-
name: string
--The slot/player name for this client.
-
- -
-
-Optionalpassword?: string-If the game session requires a password, it should be passed here.
-
- -
-
port: number
--The port of the Archipelago server to connect to.
-
- -
-
-Optionalprotocol?: "ws" | "wss"-Whether to explicitly use insecure websockets or secure websockets. If
-undefined, client will attempt secure -websockets first, then fallback to insecure websockets if it fails to connect.
- -
-
-Optionaltags?: string[]-Denotes special features or capabilities that the sender is currently capable of.
-
- -
-
-Optionaluuid?: string-Unique identifier for player client. If not specified, the client will generate one automatically.
-
- -
-
-Optionalversion?: {
build: number;
major: number;
minor: number;
}- -An object representing the minimum Archipelago server version this client supports. If not specified, -Client will send the minimum supported version by this library.
--
-
-
-
build: number
- -
-
major: number
- -
-
minor: number
-
-
-
-
\ No newline at end of file
diff --git a/types/ConnectionStatus.html b/types/ConnectionStatus.html
deleted file mode 100644
index 1cbe3cb..0000000
--- a/types/ConnectionStatus.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ConnectionStatus
-
-
\ No newline at end of file
diff --git a/types/CountdownJSONPacket.html b/types/CountdownJSONPacket.html
deleted file mode 100644
index 637ff1b..0000000
--- a/types/CountdownJSONPacket.html
+++ /dev/null
@@ -1,182 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias CountdownJSONPacket
CountdownJSONPacket: {
cmd: "PrintJSON";
countdown: number;
data: JSONMessagePart[];
type: "Countdown";
}
-cmd: "PrintJSON";
countdown: number;
data: JSONMessagePart[];
type: "Countdown";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
countdown: number
--Amount of seconds remaining on the countdown.
-
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
type: "Countdown"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/CreateAsHintMode.html b/types/CreateAsHintMode.html
deleted file mode 100644
index a662281..0000000
--- a/types/CreateAsHintMode.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias CreateAsHintMode
-
-
\ No newline at end of file
diff --git a/types/DataChangeCallback.html b/types/DataChangeCallback.html
new file mode 100644
index 0000000..515af43
--- /dev/null
+++ b/types/DataChangeCallback.html
@@ -0,0 +1,2 @@
+Generated using TypeDoc
Type Alias DataChangeCallback
Data
A callback that fires when a monitored key is updated in data storage.
+
-
-
-
-
-
-
-
-
-Type alias DataPackage
A DataPackage is an object which contains arbitrary metadata about each game to enable a client to interact -with the Archipelago server easily.
-Note:
--
-
- Any
nameis unique to its type across its own Game only: Single Arrow can exist in two games.
- - The
ids from the gameArchipelagomay be used in any other game. Especially Location ID-1:Cheat Console-and-2:Server(typically Remote Start Inventory).
-
-
-Type declaration
--
-
-
-
games: {
-
[game: string]: GamePackage;
}- -Mapping of all Games and their respective data. See GamePackage for additional info.
--
-
-
-
[game: string]: GamePackage
-
-
-
-
\ No newline at end of file
diff --git a/types/DataRecordPromise.html b/types/DataRecordPromise.html
new file mode 100644
index 0000000..ba7bf41
--- /dev/null
+++ b/types/DataRecordPromise.html
@@ -0,0 +1,2 @@
+Generated using TypeDoc
Type Alias DataRecordPromise
A promise that resolves to a record of key-value pairs from data storage.
+
-
-
-
-
-
-
-
-Type alias DataStorageOperation
Data
-A DataStorageOperation manipulates or alters the value of a key in the data storage. If the operation -transforms the value from one state to another then the current value of the key is used as the starting point -otherwise the SetPacket's default is used if the key does not exist on the server already.
-DataStorageOperations consist of an object containing both the operation to be applied, provided in the -form of a string, and the value to be used for that operation,
-Example:
-{ operation: "add", value: 12 }
-
-
-
\ No newline at end of file
diff --git a/types/DeathEvents.html b/types/DeathEvents.html
new file mode 100644
index 0000000..116a015
--- /dev/null
+++ b/types/DeathEvents.html
@@ -0,0 +1,8 @@
+Generated using TypeDoc
Type Alias DeathEvents
Death
deathReceived: [source: string, time: number, cause?: string];
}
deathReceived: [source: string, time: number, cause?: string];
}
An interface with all supported death events and their respective callback arguments. To be called from +MessageManager.
+Type declaration
death
Received: [source: string, time: number, cause?: string] Fired when a DeathLink-enabled player has sent a DeathLink.
+
-
-
-
-
-
-
-
-Type alias DeathLinkData
Death
cause?: string;
source: string;
time: number;
}
-cause?: string;
source: string;
time: number;
}
The data for a special kind of BouncePacket that can be supported by any Archipelago game. It targets the tag -CommonTags.DEATH_LINK and carries the following data:
-
-
-Type declaration
--
-
-
-
-Optionalcause?: string-Optional. Text to explain the cause of death, e.g. "Phar was shot after breaking core again."
-
- -
-
source: string
--Name of the player who first died. Can be a slot name, but can also be a name from within a multiplayer game.
-
- -
-
time: number
--Unix time stamp of time of death in seconds.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias DeathLinkData
Death
cause?: string;
source: string;
time: number;
}
cause?: string;
source: string;
time: number;
}
The DeathLink data structure.
+Type declaration
OptionalReadonlycause?: stringOptional text explaining the cause of death. When provided, this should include the player's name. (e.g.,
+Phar drowned in a vat of kittens.)Readonlysource: stringThe name of the player who died. Can be a slot name, but could also be a name from within a multiplayer game.
+Readonlytime: numberUnix timestamp of time of death.
+
-
-
-
-
-
-
-
-
-Type alias DefaultDataStorageOperation
If the key has no value yet, sets the current value of the key to default of the SetPacket's (value
-is ignored).
-
-Type declaration
--
-
-
-
operation: "default"
- -
-
value: JSONSerializableData
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/GamePackage.html b/types/GamePackage.html
deleted file mode 100644
index fe6ceb4..0000000
--- a/types/GamePackage.html
+++ /dev/null
@@ -1,223 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias GamePackage
Game
checksum: string;
item_id_to_name: {
[id: number]: string;
};
item_name_groups: {
[group: string]: string[];
};
item_name_to_id: {
[name: string]: number;
};
location_id_to_name: {
[id: number]: string;
};
location_name_groups: {
[group: string]: string[];
};
location_name_to_id: {
[name: string]: number;
};
}
-checksum: string;
item_id_to_name: {
[id: number]: string;
};
item_name_groups: {
[group: string]: string[];
};
item_name_to_id: {
[name: string]: number;
};
location_id_to_name: {
[id: number]: string;
};
location_name_groups: {
[group: string]: string[];
};
location_name_to_id: {
[name: string]: number;
};
}
Collection of data that contains meta information for a particular game.
-
-
-Type declaration
--
-
-
-
checksum: string
--SHA1 checksum of this game's data. Used to validate if cached data package needs to be requested from the server.
-
- -
-
item_
-id_ to_ name: {
[id: number]: string;
}- -Mapping of all item ids to their respective names. Inverse of
-item_name_to_id. This is not sent by the -Archipelago server, but is built by DataManager when it loads the data package.-
-
-
-
[id: number]: string
- -
-
-
-
item_
-name_ groups: {
[group: string]: string[];
}- -Mapping of all item groups.
--
-
-
-
[group: string]: string[]
- -
-
-
-
item_
-name_ to_ id: {
[name: string]: number;
}- -Mapping of all item names to their respective id.
--
-
-
-
[name: string]: number
- -
-
-
-
location_
-id_ to_ name: {
[id: number]: string;
}- -Mapping of all location ids to their respective names. Inverse of
-location_name_to_id. This is not sent by the -Archipelago server, but is built by DataManager when it loads the data package.-
-
-
-
[id: number]: string
- -
-
-
-
location_
-name_ groups: {
[group: string]: string[];
}- -Mapping of all location groups.
--
-
-
-
[group: string]: string[]
- -
-
-
-
location_
-name_ to_ id: {
[name: string]: number;
}- -Mapping of all location names to their respective id.
--
-
-
-
[name: string]: number
-
-
-
-
\ No newline at end of file
diff --git a/types/GoalJSONPacket.html b/types/GoalJSONPacket.html
deleted file mode 100644
index e9a3a5c..0000000
--- a/types/GoalJSONPacket.html
+++ /dev/null
@@ -1,187 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias GoalJSONPacket
GoalJSONPacket: {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Goal";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Goal";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
slot: number
--Slot of the triggering player.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "Goal"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/Hint.html b/types/Hint.html
deleted file mode 100644
index 8550bc6..0000000
--- a/types/Hint.html
+++ /dev/null
@@ -1,203 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias Hint
Hint: {
entrance: string;
finding_player: number;
found: boolean;
item: number;
item_flags: number | ItemFlags;
location: number;
receiving_player: number;
}
-entrance: string;
finding_player: number;
found: boolean;
item: number;
item_flags: number | ItemFlags;
location: number;
receiving_player: number;
}
An object representing a hint information for a particular item and location that contains it.
-
-
-Type declaration
--
-
-
-
entrance: string
--The name of the entrance to the location where this item is located.
-
- -
-
finding_
-player: number -The id of the player who has this item in their world.
-
- -
-
found: boolean
--Whether this item has already been found.
-
- -
-
item: number
--The id of this item.
-
- -
-
item_
-flags: number | ItemFlags -The ItemFlags for this item.
-
- -
-
location: number
--The id of the location for this item.
-
- -
-
receiving_
-player: number -The id of the player who owns this item.
-
-
-
\ No newline at end of file
diff --git a/types/HintJSONPacket.html b/types/HintJSONPacket.html
deleted file mode 100644
index a663555..0000000
--- a/types/HintJSONPacket.html
+++ /dev/null
@@ -1,192 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias HintJSONPacket
HintJSONPacket: {
cmd: "PrintJSON";
data: JSONMessagePart[];
found: boolean;
item: NetworkItem;
receiving: number;
type: "Hint";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
found: boolean;
item: NetworkItem;
receiving: number;
type: "Hint";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
found: boolean
--Whether the location hinted for was checked.
-
- -
-
item: NetworkItem
--Source player's identifier, location identifier, item identifier and item flags.
-
- -
-
receiving: number
--Destination player's identifier.
-
- -
-
type: "Hint"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/ItemCheatJSONPacket.html b/types/ItemCheatJSONPacket.html
deleted file mode 100644
index e17ff4b..0000000
--- a/types/ItemCheatJSONPacket.html
+++ /dev/null
@@ -1,192 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ItemCheatJSONPacket
Item
cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
team: number;
type: "ItemCheat";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
team: number;
type: "ItemCheat";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
item: NetworkItem
--Source player's identifier, location identifier, item identifier and item flags.
-
- -
-
receiving: number
--Destination player's identifier.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "ItemCheat"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/ItemEvents.html b/types/ItemEvents.html
new file mode 100644
index 0000000..71fbcc3
--- /dev/null
+++ b/types/ItemEvents.html
@@ -0,0 +1,12 @@
+Generated using TypeDoc
Type Alias ItemEvents
Item
hintFound: [hint: Hint];
hintReceived: [hint: Hint];
hintsInitialized: [hints: Hint[]];
itemsReceived: [items: Item[], startingIndex: number];
}
hintFound: [hint: Hint];
hintReceived: [hint: Hint];
hintsInitialized: [hints: Hint[]];
itemsReceived: [items: Item[], startingIndex: number];
}
An interface with all supported item/hint events and their respective callback arguments. To be called from +ItemsManager.
+Type declaration
hint
Found: [hint: Hint] Fired when a hint has been found.
+hint
Received: [hint: Hint] Fired when a new hint has been received.
+hints
Initialized: [hints: Hint[]] Fired shortly after initial connection with all current hints relevant to this player.
+items
Received: [items: Item[], startingIndex: number] Fired when items have been received.
+Param: startingIndex
The ItemsManager.received index for the first item in the
+itemsarray.
-
-
-
-
-
-
-Type alias ItemFlags
-
-
\ No newline at end of file
diff --git a/types/ItemJSONMessagePart.html b/types/ItemJSONMessagePart.html
deleted file mode 100644
index 8c599d7..0000000
--- a/types/ItemJSONMessagePart.html
+++ /dev/null
@@ -1,185 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ItemJSONMessagePart
ItemJSONMessage
flags: ItemFlags | number;
player: number;
text: string;
type: "item_id" | "item_name";
}
-flags: ItemFlags | number;
player: number;
text: string;
type: "item_id" | "item_name";
}
-
Type declaration
--
-
-
-
flags: ItemFlags | number
--Bit flags that determine if an item is progression, "nice to have", filler, or a trap.
-
- -
-
player: number
--The
-idof the player who owns this item.
- -
-
text: string
--Used to supply text data for this node.
-
- -
-
type: "item_id" | "item_name"
--Used to denote the intent of the message part.
-
-
-
\ No newline at end of file
diff --git a/types/ItemSendJSONPacket.html b/types/ItemSendJSONPacket.html
deleted file mode 100644
index f100b1d..0000000
--- a/types/ItemSendJSONPacket.html
+++ /dev/null
@@ -1,187 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ItemSendJSONPacket
Item
cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
type: "ItemSend";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
item: NetworkItem;
receiving: number;
type: "ItemSend";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
item: NetworkItem
--Source player's identifier, location identifier, item identifier and item flags.
-
- -
-
receiving: number
--Destination player's identifier.
-
- -
-
type: "ItemSend"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/ItemsHandlingFlags.html b/types/ItemsHandlingFlags.html
deleted file mode 100644
index c93fbf0..0000000
--- a/types/ItemsHandlingFlags.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ItemsHandlingFlags
-
-
\ No newline at end of file
diff --git a/types/JSONMessagePart.html b/types/JSONMessagePart.html
deleted file mode 100644
index 3ab9bf9..0000000
--- a/types/JSONMessagePart.html
+++ /dev/null
@@ -1,166 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias JSONMessagePart
JSONMessage
-Message nodes sent along with PrintJSONPacket to be reconstructed into a legible message. The nodes are -intended to be read in the order they are listed in the packet.
-
-
-
\ No newline at end of file
diff --git a/types/JSONSerializableData.html b/types/JSONSerializableData.html
deleted file mode 100644
index 881c357..0000000
--- a/types/JSONSerializableData.html
+++ /dev/null
@@ -1,170 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias JSONSerializableData
JSONSerializable
[key: string]: JSONSerializableData;
} | JSONSerializableData[]
-[key: string]: JSONSerializableData;
} | JSONSerializableData[]
A type union of all basic JSON-compatible types that can be communicated with or from the server.
-
-
-Type declaration
--
-
-
-
[key: string]: JSONSerializableData
-
-
\ No newline at end of file
diff --git a/types/JoinJSONPacket.html b/types/JoinJSONPacket.html
deleted file mode 100644
index cdc7e72..0000000
--- a/types/JoinJSONPacket.html
+++ /dev/null
@@ -1,192 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias JoinJSONPacket
JoinJSONPacket: {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "Join";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "Join";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
slot: number
--Slot of the triggering player.
-
- -
-
tags: string[]
--Tags of the triggering player.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "Join"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/LeftShiftDataStorageOperation.html b/types/LeftShiftDataStorageOperation.html
deleted file mode 100644
index 57c25b7..0000000
--- a/types/LeftShiftDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias LeftShiftDataStorageOperation
Left
operation: "left_shift";
value: number;
}
-operation: "left_shift";
value: number;
}
Applies a bitwise left-shift to the current value of the key by value.
-
-Type declaration
--
-
-
-
operation: "left_shift"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/LocationJSONMessagePart.html b/types/LocationJSONMessagePart.html
deleted file mode 100644
index 5ccbefc..0000000
--- a/types/LocationJSONMessagePart.html
+++ /dev/null
@@ -1,180 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias LocationJSONMessagePart
LocationJSONMessage
player: number;
text: string;
type: "location_id" | "location_name";
}
-player: number;
text: string;
type: "location_id" | "location_name";
}
-
Type declaration
--
-
-
-
player: number
--The
-idof the player who has this location.
- -
-
text: string
--Used to supply text data for this node.
-
- -
-
type: "location_id" | "location_name"
--Used to denote the intent of the message part.
-
-
-
\ No newline at end of file
diff --git a/types/MaxDataStorageOperation.html b/types/MaxDataStorageOperation.html
deleted file mode 100644
index 231c7a1..0000000
--- a/types/MaxDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias MaxDataStorageOperation
Max
operation: "max";
value: number;
}
-operation: "max";
value: number;
}
Sets the current value of the key to value if value is bigger.
-
-Type declaration
--
-
-
-
operation: "max"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/MessageEvents.html b/types/MessageEvents.html
new file mode 100644
index 0000000..2a7a69c
--- /dev/null
+++ b/types/MessageEvents.html
@@ -0,0 +1,18 @@
+Generated using TypeDoc
Type Alias MessageEvents
Message
chatMessage: [message: string, index: number, sender: Player];
countdown: [message: string, index: number, value: number];
receivedMessage: [message: string, index: number, packet: PrintJSONPacket];
}
chatMessage: [message: string, index: number, sender: Player];
countdown: [message: string, index: number, value: number];
receivedMessage: [message: string, index: number, packet: PrintJSONPacket];
}
An interface with all supported message events and their respective callback arguments. To be called from +MessageManager.
+Type declaration
chat
Message: [message: string, index: number, sender: Player] Fires when a player message is received.
+Param: index
The index of this message in MessageManager.messages, when this event was fired. If message +logging is disabled, this will return
+-1.countdown: [message: string, index: number, value: number]
Fires when a countdown message is received.
+Param: index
The index of this message in MessageManager.messages, when this event was fired. If message +logging is disabled, this will return
+-1.received
Message: [message: string, index: number, packet: PrintJSONPacket] Fires when any message is received.
+Param: index
The index of this message in MessageManager.messages, when this event was fired. If message +logging is disabled, this will return
+-1.
-
-
-
-
-
-
-
-Type alias MinDataStorageOperation
Min
operation: "min";
value: number;
}
-operation: "min";
value: number;
}
Sets the current value of the key to value if value is lower.
-
-Type declaration
--
-
-
-
operation: "min"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/MiscJSONMessagePart.html b/types/MiscJSONMessagePart.html
deleted file mode 100644
index c725cd7..0000000
--- a/types/MiscJSONMessagePart.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias MiscJSONMessagePart
MiscJSONMessage
text: string;
type?: "text" | "entrance_name" | "player_id" | "player_name";
}
-text: string;
type?: "text" | "entrance_name" | "player_id" | "player_name";
}
-
Type declaration
--
-
-
-
text: string
--Used to supply text data for this node.
-
- -
-
-Optionaltype?: "text" | "entrance_name" | "player_id" | "player_name"-Used to denote the intent of the message part.
-
-
-
\ No newline at end of file
diff --git a/types/ModuloDataStorageOperation.html b/types/ModuloDataStorageOperation.html
deleted file mode 100644
index 0056c3d..0000000
--- a/types/ModuloDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ModuloDataStorageOperation
Modulo
operation: "mod";
value: number;
}
-operation: "mod";
value: number;
}
Sets the current value of the key to the remainder after division by value.
-
-Type declaration
--
-
-
-
operation: "mod"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/MultiplyDataStorageOperation.html b/types/MultiplyDataStorageOperation.html
deleted file mode 100644
index 6b0c51b..0000000
--- a/types/MultiplyDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias MultiplyDataStorageOperation
Multiply
operation: "mul";
value: number;
}
-operation: "mul";
value: number;
}
Multiplies the current value of the key by value.
-
-Type declaration
--
-
-
-
operation: "mul"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/NetworkItem.html b/types/NetworkItem.html
deleted file mode 100644
index ece2270..0000000
--- a/types/NetworkItem.html
+++ /dev/null
@@ -1,189 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias NetworkItem
Items that are sent over the network.
-
-
-Type declaration
--
-
-
-
flags: ItemFlags | number
--Bit flags for the type of item this is. See ItemFlags for additional information.
-
- -
-
item: number
--The item id of the item. Item ids are in the range of -2^53^ to +2^53^-1.
-
- -
-
location: number
--The location id of the location inside the world. Location ids are in the range of -2^53^ to +2^53^-1.
-
- -
-
player: number
--The slot id for the player whose world the item was located in, except when inside a LocationInfoPacket, -then it will be the slot id of the player the item belongs to.
-
-
-
\ No newline at end of file
diff --git a/types/NetworkPlayer.html b/types/NetworkPlayer.html
deleted file mode 100644
index 2e389f7..0000000
--- a/types/NetworkPlayer.html
+++ /dev/null
@@ -1,190 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias NetworkPlayer
Network
alias: string;
name: string;
slot: number;
team: number;
}
-alias: string;
name: string;
slot: number;
team: number;
}
An object that contains information about a player on the network.
-
-
-Type declaration
--
-
-
-
alias: string
--Represents the player's name in current time. Can be changed during a game with the
-!alias <name>command by -the player.
- -
-
name: string
--The original slot name as defined by the player's configuration file. Individual names are unique among players.
-
- -
-
slot: number
--Determines the slot id for this player. Slot numbers are unique per team and start at
-1. Slot number0refers -to the Archipelago server; this may appear in instances where the server grants the player an item.
- -
-
team: number
--Determines the team the player is on. Useful for competitive seeds. Team numbers start at
-0.
-
-
\ No newline at end of file
diff --git a/types/NetworkSlot.html b/types/NetworkSlot.html
deleted file mode 100644
index 54ab3d4..0000000
--- a/types/NetworkSlot.html
+++ /dev/null
@@ -1,188 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias NetworkSlot
An object representing static information about a slot.
-
-
-Type declaration
--
-
-
-
game: string
--The game this slot is playing.
-
- -
-
group_
-members: number[] -Contains a list of player ids, if the
-typeis SlotType.GROUP. Used for item links, otherwise empty.
- -
-
name: string
--The original slot name as defined by the player's configuration file. Individual names are unique among players.
-
- -
-
type: SlotType
--The type of slot this is. See SlotType for additional information on allowed types.
-
-
-
\ No newline at end of file
diff --git a/types/NetworkVersion.html b/types/NetworkVersion.html
deleted file mode 100644
index a6bd58e..0000000
--- a/types/NetworkVersion.html
+++ /dev/null
@@ -1,180 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias NetworkVersion
Network
build: number;
class: "Version";
major: number;
minor: number;
}
-build: number;
class: "Version";
major: number;
minor: number;
}
An object representing software versioning. Used in the ConnectPacket to allow the client to inform the -server the minimum Archipelago version it supports.
-
-
-Type declaration
--
-
-
-
build: number
- -
-
class: "Version"
--Always required for Archipelago to parse NetworkVersion data.
-
- -
-
major: number
- -
-
minor: number
-
-
\ No newline at end of file
diff --git a/types/ObjectValues.html b/types/ObjectValues.html
deleted file mode 100644
index d40d595..0000000
--- a/types/ObjectValues.html
+++ /dev/null
@@ -1,167 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ObjectValues<T>
Object
-Type Parameters
--
-
-
-
T
-
-
\ No newline at end of file
diff --git a/types/OrDataStorageOperation.html b/types/OrDataStorageOperation.html
deleted file mode 100644
index f29a9a3..0000000
--- a/types/OrDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias OrDataStorageOperation
Or
operation: "or";
value: number;
}
-operation: "or";
value: number;
}
Applies a bitwise OR to the current value of the key with value.
-
-
-Type declaration
--
-
-
-
operation: "or"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/PacketProblemType.html b/types/PacketProblemType.html
deleted file mode 100644
index ec778af..0000000
--- a/types/PacketProblemType.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias PacketProblemType
-
-
\ No newline at end of file
diff --git a/types/PartJSONPacket.html b/types/PartJSONPacket.html
deleted file mode 100644
index bdc23a3..0000000
--- a/types/PartJSONPacket.html
+++ /dev/null
@@ -1,187 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias PartJSONPacket
PartJSONPacket: {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Part";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Part";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
slot: number
--Slot of the triggering player.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "Part"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/Permission.html b/types/Permission.html
deleted file mode 100644
index d667ca9..0000000
--- a/types/Permission.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias Permission
-
-
\ No newline at end of file
diff --git a/types/Permissions.html b/types/Permissions.html
deleted file mode 100644
index 63eb158..0000000
--- a/types/Permissions.html
+++ /dev/null
@@ -1,174 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias Permissions
All three Permission values for a given room.
-
-
-Type declaration
--
-
-
-
Readonlycollect: Permission
- -
-
Readonlyrelease: Permission
- -
-
Readonlyremaining: ReducedPermission
-
-
\ No newline at end of file
diff --git a/types/Player.html b/types/Player.html
deleted file mode 100644
index 7613397..0000000
--- a/types/Player.html
+++ /dev/null
@@ -1,201 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias Player
An object that contains information about a player. Combination of NetworkPlayer, NetworkSlot and -some helper functions.
-
-
-Type declaration
--
-
-
-
item: ((id) => string)
--
-
-
-
-
-
- (id): string -
-
--
Helper function for looking up an item name for this player.
---Parameters
--
-
-
-
id: number
Returns string
- -
-
- -
-
-
-
location: ((id) => string)
--
-
-
-
-
-
- (id): string -
-
--
Helper function for looking up a location name for this player.
---Parameters
--
-
-
-
id: number
Returns string
- -
-
-
-
-
-
\ No newline at end of file
diff --git a/types/PlayerEvents.html b/types/PlayerEvents.html
new file mode 100644
index 0000000..c207e43
--- /dev/null
+++ b/types/PlayerEvents.html
@@ -0,0 +1,5 @@
+Generated using TypeDoc
Type Alias PlayerEvents
-
-
-
-
-
-
-
-
-Type alias PopDataStorageOperation
List or Dict only: for lists it will remove the index of the value given. For dicts it removes the element with
-the specified key of value.
-
-Type declaration
--
-
-
-
operation: "pop"
- -
-
value: JSONSerializableData
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/PowerDataStorageOperation.html b/types/PowerDataStorageOperation.html
deleted file mode 100644
index 8ebcfb3..0000000
--- a/types/PowerDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias PowerDataStorageOperation
Power
operation: "pow";
value: number;
}
-operation: "pow";
value: number;
}
Multiplies the current value of the key to the power of value.
-
-Type declaration
--
-
-
-
operation: "pow"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/PrintJSONPacket.html b/types/PrintJSONPacket.html
deleted file mode 100644
index fa5f2a0..0000000
--- a/types/PrintJSONPacket.html
+++ /dev/null
@@ -1,170 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias PrintJSONPacket
PrintJSONPacket: ItemSendJSONPacket | ItemCheatJSONPacket | HintJSONPacket | JoinJSONPacket | PartJSONPacket | ChatJSONPacket | ServerChatJSONPacket | TutorialJSONPacket | TagsChangedJSONPacket | CommandResultJSONPacket | AdminCommandResultJSONPacket | GoalJSONPacket | ReleaseJSONPacket | CollectJSONPacket | CountdownJSONPacket
-Sent to clients purely to display a message to the player. While various message types provide additional arguments,
-clients only need to evaluate the data argument to construct the human-readable message text. All other arguments
-may be ignored safely.
Only some of these attributes are present on PrintJSONPacket packets, see -PrintJSON in AP Docs -for more information.
-
-
-
\ No newline at end of file
diff --git a/types/PrintJSONType.html b/types/PrintJSONType.html
deleted file mode 100644
index 05c36fc..0000000
--- a/types/PrintJSONType.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias PrintJSONType
-
-
\ No newline at end of file
diff --git a/types/ReducedPermission.html b/types/ReducedPermission.html
deleted file mode 100644
index ec8dfca..0000000
--- a/types/ReducedPermission.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ReducedPermission
-
-
\ No newline at end of file
diff --git a/types/ReleaseJSONPacket.html b/types/ReleaseJSONPacket.html
deleted file mode 100644
index 39515fc..0000000
--- a/types/ReleaseJSONPacket.html
+++ /dev/null
@@ -1,187 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ReleaseJSONPacket
ReleaseJSONPacket: {
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Release";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
team: number;
type: "Release";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
slot: number
--Slot of the triggering player.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "Release"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/RemoveDataStorageOperation.html b/types/RemoveDataStorageOperation.html
deleted file mode 100644
index 99990c6..0000000
--- a/types/RemoveDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias RemoveDataStorageOperation
List only: removes the first instance of value found in the list.
-
-Type declaration
--
-
-
-
operation: "remove"
- -
-
value: JSONSerializableData
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/ReplaceDataStorageOperation.html b/types/ReplaceDataStorageOperation.html
deleted file mode 100644
index 1bf77b4..0000000
--- a/types/ReplaceDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias ReplaceDataStorageOperation
Sets the current value of the key to value.
-
-Type declaration
--
-
-
-
operation: "replace"
- -
-
value: JSONSerializableData
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/RightShiftDataStorageOperation.html b/types/RightShiftDataStorageOperation.html
deleted file mode 100644
index b5c2f16..0000000
--- a/types/RightShiftDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias RightShiftDataStorageOperation
Right
operation: "right_shift";
value: number;
}
-operation: "right_shift";
value: number;
}
Applies a bitwise right-shift to the current value of the key by value.
-
-Type declaration
--
-
-
-
operation: "right_shift"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/RoomStateEvents.html b/types/RoomStateEvents.html
new file mode 100644
index 0000000..0f92e5e
--- /dev/null
+++ b/types/RoomStateEvents.html
@@ -0,0 +1,21 @@
+Generated using TypeDoc
Type Alias RoomStateEvents
Room
hintCostUpdated: [oldCost: number, newCost: number, oldPercentage: number, newPercentage: number];
hintPointsUpdated: [oldValue: number, newValue: number];
locationCheckPointsUpdated: [oldValue: number, newValue: number];
locationsChecked: [locations: number[]];
passwordUpdated: [password: boolean];
permissionsUpdated: [oldValue: PermissionTable, newValue: PermissionTable];
}
hintCostUpdated: [oldCost: number, newCost: number, oldPercentage: number, newPercentage: number];
hintPointsUpdated: [oldValue: number, newValue: number];
locationCheckPointsUpdated: [oldValue: number, newValue: number];
locationsChecked: [locations: number[]];
passwordUpdated: [password: boolean];
permissionsUpdated: [oldValue: PermissionTable, newValue: PermissionTable];
}
An interface with all supported room events and their respective callback arguments. To be called from +RoomStateManager.
+Type declaration
hint
Cost Updated: [oldCost: number, newCost: number, oldPercentage: number, newPercentage: number] Fires when the hint cost has been updated.
+hint
Points Updated: [oldValue: number, newValue: number] Fires when the player's hint points value has updated.
+location
Check Points Updated: [oldValue: number, newValue: number] Fires when the location check points have been updated.
+locations
Checked: [locations: number[]] Fires when new locations have been checked (or all locations on initial connection).
+password
Updated: [password: boolean] Fires when the room password has been toggled.
+permissions
Updated: [oldValue: PermissionTable, newValue: PermissionTable] Fires when command permissions have been updated.
+
-
-
-
-
-
-
-Type alias ServerChatJSONPacket
Server
cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
type: "ServerChat";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
message: string;
type: "ServerChat";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
message: string
--Original chat message without sender prefix.
-
- -
-
type: "ServerChat"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/ServerPacket.html b/types/ServerPacket.html
deleted file mode 100644
index bdd0580..0000000
--- a/types/ServerPacket.html
+++ /dev/null
@@ -1,165 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ServerPacket
Server
-A type union of all known and supported Archipelago server packets.
-
-
-
\ No newline at end of file
diff --git a/types/ServerPacketType.html b/types/ServerPacketType.html
deleted file mode 100644
index 8a35653..0000000
--- a/types/ServerPacketType.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ServerPacketType
-
-
\ No newline at end of file
diff --git a/types/SlotData.html b/types/SlotData.html
deleted file mode 100644
index fc546fb..0000000
--- a/types/SlotData.html
+++ /dev/null
@@ -1,170 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias SlotData
A stand in for unknown slot data.
-
-
-Type declaration
--
-
-
-
[arg: string]: JSONSerializableData
-
-
\ No newline at end of file
diff --git a/types/SlotType.html b/types/SlotType.html
deleted file mode 100644
index eed9ded..0000000
--- a/types/SlotType.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias SlotType
-
-
\ No newline at end of file
diff --git a/types/SocketEvents.html b/types/SocketEvents.html
new file mode 100644
index 0000000..6c82736
--- /dev/null
+++ b/types/SocketEvents.html
@@ -0,0 +1,41 @@
+Generated using TypeDoc
Type Alias SocketEvents
Socket
bounced: [packet: BouncedPacket, data: {
[p: string]: JSONSerializableData;
}];
connected: [packet: ConnectedPacket];
connectionRefused: [packet: ConnectionRefusedPacket];
dataPackage: [packet: DataPackagePacket];
disconnected: [];
invalidPacket: [packet: InvalidPacketPacket];
locationInfo: [packet: LocationInfoPacket];
printJSON: [packet: PrintJSONPacket, message: string];
receivedItems: [packet: ReceivedItemsPacket];
receivedPacket: [packet: ServerPacket];
retrieved: [packet: RetrievedPacket];
roomInfo: [packet: RoomInfoPacket];
roomUpdate: [packet: RoomUpdatePacket];
sentPackets: [packets: ClientPacket[]];
setReply: [packet: SetReplyPacket];
}
bounced: [packet: BouncedPacket, data: {
[p: string]: JSONSerializableData;
}];
connected: [packet: ConnectedPacket];
connectionRefused: [packet: ConnectionRefusedPacket];
dataPackage: [packet: DataPackagePacket];
disconnected: [];
invalidPacket: [packet: InvalidPacketPacket];
locationInfo: [packet: LocationInfoPacket];
printJSON: [packet: PrintJSONPacket, message: string];
receivedItems: [packet: ReceivedItemsPacket];
receivedPacket: [packet: ServerPacket];
retrieved: [packet: RetrievedPacket];
roomInfo: [packet: RoomInfoPacket];
roomUpdate: [packet: RoomUpdatePacket];
sentPackets: [packets: ClientPacket[]];
setReply: [packet: SetReplyPacket];
}
An interface with all supported socket events and their respective callback arguments. To be called from +SocketManager.
+Type declaration
bounced: [packet: BouncedPacket, data: {
[p: string]: JSONSerializableData;
}]Fires when the client receives a BouncedPacket.
+Param: packet
The raw BouncedPacket.
+connected: [packet: ConnectedPacket]
Fires when the client receives a ConnectedPacket
+Param: packet
The raw ConnectedPacket packet.
+connection
Refused: [packet: ConnectionRefusedPacket] Fires when the client receives a ConnectionRefusedPacket.
+Param: packet
The raw ConnectionRefusedPacket.
+data
Package: [packet: DataPackagePacket] Fires when the client receives a DataPackagePacket.
+Param: packet
The raw DataPackagePacket.
+disconnected: []
Fires when the client has lost connection to the server, intentionally or not.
+invalid
Packet: [packet: InvalidPacketPacket] Fires when the client receives a InvalidPacketPacket.
+Param: packet
The raw InvalidPacketPacket.
+location
Info: [packet: LocationInfoPacket] Fires when the client receives a LocationInfoPacket.
+Param: packet
The raw LocationInfoPacket.
+printJSON: [packet: PrintJSONPacket, message: string]
Fires when the client receives a PrintJSONPacket.
+Param: packet
The raw PrintJSONPacket packet.
+received
Items: [packet: ReceivedItemsPacket] Fires when the client receives a ReceivedItemsPacket.
+Param: packet
The raw ReceivedItemsPacket.
+received
Packet: [packet: ServerPacket] Fires when the client receives any ServerPacket.
+Param: packet
Any received ServerPacket. Additional checks on the
+cmdproperty will be required to +determine the type of packet received.retrieved: [packet: RetrievedPacket]
Fires when the client receives a RetrievedPacket.
+Param: packet
The raw RetrievedPacket.
+room
Info: [packet: RoomInfoPacket] Fires when the client receives a RoomInfoPacket.
+Param: packet
The raw RoomInfoPacket.
+room
Update: [packet: RoomUpdatePacket] Fires when the client receives a RoomUpdatePacket.
+Param: packet
The raw RoomUpdatePacket.
+sent
Packets: [packets: ClientPacket[]] Fires when the client sends an array of ClientPacket.
+Param: packets
An array of ClientPacket sent to the server.
+set
Reply: [packet: SetReplyPacket] Fires when the client receives a SetReplyPacket.
+Param: packet
The raw SetReplyPacket.
+
-
-
-
-
-
-
-Type alias TagsChangedJSONPacket
Tags
cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "TagsChanged";
}
-cmd: "PrintJSON";
data: JSONMessagePart[];
slot: number;
tags: string[];
team: number;
type: "TagsChanged";
}
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
slot: number
--Slot of the triggering player.
-
- -
-
tags: string[]
--Tags of the triggering player.
-
- -
-
team: number
--Team of the triggering player.
-
- -
-
type: "TagsChanged"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/TutorialJSONPacket.html b/types/TutorialJSONPacket.html
deleted file mode 100644
index 4a5ecd0..0000000
--- a/types/TutorialJSONPacket.html
+++ /dev/null
@@ -1,177 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias TutorialJSONPacket
-
Type declaration
--
-
-
-
cmd: "PrintJSON"
- -
-
data: JSONMessagePart[]
--All the data for this type of message.
-
- -
-
type: "Tutorial"
--May be present to indicate the nature of this message. Known types are specified in PRINT_JSON_TYPE.
-
-
-
\ No newline at end of file
diff --git a/types/UnknownSlotData.html b/types/UnknownSlotData.html
index 95c754b..a7e1d80 100644
--- a/types/UnknownSlotData.html
+++ b/types/UnknownSlotData.html
@@ -1,162 +1,2 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias UnknownSlotData
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias UnknownSlotData
An abstract type for unknown slot data.
+
-
-
-
-
-
-
-
-
-Type alias UpdateDataStorageOperation
Dict only: Updates the dictionary with the specified elements given in value creating new keys, or updating old
-ones if they previously existed.
-
-Type declaration
--
-
-
-
operation: "update"
- -
-
value: JSONSerializableData
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/types/ValidJSONColorType.html b/types/ValidJSONColorType.html
deleted file mode 100644
index 9834f61..0000000
--- a/types/ValidJSONColorType.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ValidJSONColorType
-
-
\ No newline at end of file
diff --git a/types/ValidJSONMessageType.html b/types/ValidJSONMessageType.html
deleted file mode 100644
index 0bdf22e..0000000
--- a/types/ValidJSONMessageType.html
+++ /dev/null
@@ -1,162 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias ValidJSONMessageType
-
-
\ No newline at end of file
diff --git a/types/XorDataStorageOperation.html b/types/XorDataStorageOperation.html
deleted file mode 100644
index 41c6473..0000000
--- a/types/XorDataStorageOperation.html
+++ /dev/null
@@ -1,175 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias XorDataStorageOperation
Xor
operation: "xor";
value: number;
}
-operation: "xor";
value: number;
}
Applies a bitwise XOR to the current value of the key with value.
-
-Type declaration
--
-
-
-
operation: "xor"
- -
-
value: number
--A value for the operation to apply against the current data storage value.
-
-
-
\ No newline at end of file
diff --git a/variables/API.clientStatuses.html b/variables/API.clientStatuses.html
new file mode 100644
index 0000000..66eb85d
--- /dev/null
+++ b/variables/API.clientStatuses.html
@@ -0,0 +1,8 @@
+Generated using TypeDoc
Variable clientStatusesConst
client
connected: 5;
disconnected: 0;
goal: 30;
playing: 20;
ready: 10;
} = ...
connected: 5;
disconnected: 0;
goal: 30;
playing: 20;
ready: 10;
} = ...
A const of known containing the possible client states that may be used to inform the server during a status update.
+Type declaration
Readonlyconnected: 5Client is currently connected. This status is set automatically when a client connects.
+Readonlydisconnected: 0Client is in an unknown or disconnected state. This status is set automatically initially and when all connected +clients have disconnected from the server.
+Readonlygoal: 30Client has completed their goal. Once set, cannot be changed.
+Readonlyplaying: 20Client is currently playing.
+Readonlyready: 10Client is ready to start, but hasn't started playing yet.
+
Variable itemClassificationsConst
item
normal: 0;
progression: 1;
trap: 4;
useful: 2;
} = ...
normal: 0;
progression: 1;
trap: 4;
useful: 2;
} = ...
Bit flags that define the special characteristics of a NetworkItem.
+Type declaration
Readonlynormal: 0A shorthand with no flags set, also known as 'filler' or 'junk' items.
+Readonlyprogression: 1If set, indicates the item may unlock logical advancement.
+Readonlytrap: 4If set, indicates the item can inconvenience a player.
+Readonlyuseful: 2If set, indicates the item is classified as useful to have.
+
Variable itemsHandlingFlagsConst
items
all: 7;
minimal: 0;
others: 1;
own: 2;
starting: 4;
} = ...
all: 7;
minimal: 0;
others: 1;
own: 2;
starting: 4;
} = ...
Bit flags configuring which items should be sent by the server to this client.
+Type declaration
Readonlyall: 7Shorthand for
+REMOTE_DIFFERENT_WORLDS,REMOTE_OWN_WORLD, andREMOTE_STARTING_INVENTORY.Readonlyminimal: 0Indicates the client only receives items created by cheat commands.
+Readonlyothers: 1Indicates the client get items sent from other worlds.
+Readonlyown: 2Indicates the client get items sent from your own world. Requires
+REMOTE_DIFFERENT_WORLDSto be set.Readonlystarting: 4Indicates the client get your starting inventory sent. Requires
+REMOTE_DIFFERENT_WORLDSto be set.
Variable permissionsConst
permissions: {
auto: 6;
autoEnabled: 7;
disabled: 0;
enabled: 1;
goal: 2;
} = ...
auto: 6;
autoEnabled: 7;
disabled: 0;
enabled: 1;
goal: 2;
} = ...
A const containing the possible command permissions, for commands that may be restricted.
+Type declaration
Readonlyauto: 6Forces players to use this command after they have completed their goal.
+ReadonlyautoEnabled: 7 Allows players to use this command manually at any time and forces them to use this command after they have +completed their goal.
+Readonlydisabled: 0Prevents players from using this command at any time.
+Readonlyenabled: 1Allows players to use this command manually at any time.
+Readonlygoal: 2Allows players to use this command manually after they have completed their goal.
+
Variable slotTypesConst
slot
group: 2;
player: 1;
spectator: 0;
} = ...
group: 2;
player: 1;
spectator: 0;
} = ...
An enumeration representing the nature of the slot.
+Type declaration
Readonlygroup: 2This client is an item links group containing at least 1 player with active item links.
+Readonlyplayer: 1This client is a player and is participating in the current game.
+Readonlyspectator: 0This client is a spectator and not participating in the current game.
+
-
-
-
-
-
-
-Variable CLIENT_PACKET_TYPE
-Variable CLIENT_PACKET_TYPEConst
CLIENT_
BOUNCE: "Bounce";
CONNECT: "Connect";
CONNECT_UPDATE: "ConnectUpdate";
GET: "Get";
GET_DATA_PACKAGE: "GetDataPackage";
LOCATION_CHECKS: "LocationChecks";
LOCATION_SCOUTS: "LocationScouts";
SAY: "Say";
SET: "Set";
SET_NOTIFY: "SetNotify";
STATUS_UPDATE: "StatusUpdate";
SYNC: "Sync";
} = ...
-BOUNCE: "Bounce";
CONNECT: "Connect";
CONNECT_UPDATE: "ConnectUpdate";
GET: "Get";
GET_DATA_PACKAGE: "GetDataPackage";
LOCATION_CHECKS: "LocationChecks";
LOCATION_SCOUTS: "LocationScouts";
SAY: "Say";
SET: "Set";
SET_NOTIFY: "SetNotify";
STATUS_UPDATE: "StatusUpdate";
SYNC: "Sync";
} = ...
A const of all possible packet types the client can send to the server. See each packet's documentation page for -additional information on each packet type.
-
-
-Type declaration
--
-
-
-
ReadonlyBOUNCE: "Bounce"
- -
-
ReadonlyCONNECT: "Connect"
- -
-
ReadonlyCONNECT_UPDATE: "ConnectUpdate"
- -
-
ReadonlyGET: "Get"
- -
-
ReadonlyGET_DATA_ PACKAGE: "GetDataPackage"
- -
-
ReadonlyLOCATION_CHECKS: "LocationChecks"
- -
-
ReadonlyLOCATION_SCOUTS: "LocationScouts"
- -
-
ReadonlySAY: "Say"
- -
-
ReadonlySET: "Set"
- -
-
ReadonlySET_NOTIFY: "SetNotify"
- -
-
ReadonlySTATUS_UPDATE: "StatusUpdate"
- -
-
ReadonlySYNC: "Sync"
-
-
\ No newline at end of file
diff --git a/variables/CLIENT_STATUS.html b/variables/CLIENT_STATUS.html
deleted file mode 100644
index 0904f34..0000000
--- a/variables/CLIENT_STATUS.html
+++ /dev/null
@@ -1,194 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable CLIENT_STATUS
-Variable CLIENT_STATUSConst
CLIENT_
CONNECTED: 5;
GOAL: 30;
PLAYING: 20;
READY: 10;
UNKNOWN: 0;
} = ...
-CONNECTED: 5;
GOAL: 30;
PLAYING: 20;
READY: 10;
UNKNOWN: 0;
} = ...
An enumeration containing the possible client states that may be used to inform the server in -StatusUpdatePacket.
-
-
-Type declaration
--
-
-
-
-ReadonlyCONNECTED: 5-Client is currently connected.
-
- -
-
-ReadonlyGOAL: 30-Client has completed their goal.
-
- -
-
-ReadonlyPLAYING: 20-Client is currently playing.
-
- -
-
-ReadonlyREADY: 10-Client is current ready to start.
-
- -
-
-ReadonlyUNKNOWN: 0-Client is in an unknown state.
-
-
-
\ No newline at end of file
diff --git a/variables/COMMON_TAGS.html b/variables/COMMON_TAGS.html
deleted file mode 100644
index 692a398..0000000
--- a/variables/COMMON_TAGS.html
+++ /dev/null
@@ -1,192 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable COMMON_TAGS
-Variable COMMON_TAGSConst
COMMON_
DEATH_LINK: "DeathLink";
REFERENCE_CLIENT: "AP";
TEXT_ONLY: "TextOnly";
TRACKER: "Tracker";
} = ...
-DEATH_LINK: "DeathLink";
REFERENCE_CLIENT: "AP";
TEXT_ONLY: "TextOnly";
TRACKER: "Tracker";
} = ...
Tags are represented as a list of strings, these are some of the most common tags.
-
-
-Type declaration
--
-
-
-
-ReadonlyDEATH_LINK: "DeathLink" -Client participates in the DeathLink mechanic, therefore will send and receive DeathLink BouncePackets.
-
- -
-
-ReadonlyREFERENCE_CLIENT: "AP" -Signifies that this client is a reference client, its usefulness is mostly in debugging to compare client -behaviours more easily.
-This tag should only be utilized by clients that come pre-packaged with Archipelago.
-
- -
-
-ReadonlyTEXT_ONLY: "TextOnly" -Tells the server that this client will not send locations and is intended for chat. When specified and used with -an empty
-gamein the ConnectPacket,gameandgame's version validation will be skipped.
- -
-
-ReadonlyTRACKER: "Tracker"-Tells the server that this client will not send locations and is actually a Tracker. When specified and used with -an empty
-gamein the ConnectPacket,gameandgame's version validation will be skipped.
-
-
\ No newline at end of file
diff --git a/variables/CONNECTION_ERROR.html b/variables/CONNECTION_ERROR.html
deleted file mode 100644
index 59b7b40..0000000
--- a/variables/CONNECTION_ERROR.html
+++ /dev/null
@@ -1,194 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable CONNECTION_ERROR
-Variable CONNECTION_ERRORConst
CONNECTION_
INCOMPATIBLE_VERSION: "IncompatibleVersion";
INVALID_GAME: "InvalidGame";
INVALID_ITEMS_HANDLING: "InvalidItemsHandling";
INVALID_PASSWORD: "InvalidPassword";
INVALID_SLOT: "InvalidSlot";
} = ...
-INCOMPATIBLE_VERSION: "IncompatibleVersion";
INVALID_GAME: "InvalidGame";
INVALID_ITEMS_HANDLING: "InvalidItemsHandling";
INVALID_PASSWORD: "InvalidPassword";
INVALID_SLOT: "InvalidSlot";
} = ...
An enumeration of known errors the Archipelago server can send back to the client when they receive a -ConnectionRefusedPacket.
-
-
-Type declaration
--
-
-
-
-ReadonlyINCOMPATIBLE_VERSION: "IncompatibleVersion" -Indicates a version mismatch or an unsupported client version number.
-
- -
-
-ReadonlyINVALID_GAME: "InvalidGame" -Indicates that a correctly named slot was found, but the game for it mismatched.
-
- -
-
-ReadonlyINVALID_ITEMS_ HANDLING: "InvalidItemsHandling" -Indicates a wrong value type or flag combination was sent.
-
- -
-
-ReadonlyINVALID_PASSWORD: "InvalidPassword" -Indicates the wrong, or no password when it was required, was sent.
-
- -
-
-ReadonlyINVALID_SLOT: "InvalidSlot" -Indicates that the
-namefield did not match any auth entry on the server.
-
-
\ No newline at end of file
diff --git a/variables/CONNECTION_STATUS.html b/variables/CONNECTION_STATUS.html
deleted file mode 100644
index 31eb4a7..0000000
--- a/variables/CONNECTION_STATUS.html
+++ /dev/null
@@ -1,188 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable CONNECTION_STATUS
-Variable CONNECTION_STATUSConst
CONNECTION_
CONNECTED: "Connected";
CONNECTING: "Connecting";
DISCONNECTED: "Disconnected";
WAITING_FOR_AUTH: "Waiting For Authentication";
} = ...
-CONNECTED: "Connected";
CONNECTING: "Connecting";
DISCONNECTED: "Disconnected";
WAITING_FOR_AUTH: "Waiting For Authentication";
} = ...
A const of the current Client connection status to the Archipelago server.
-
-
-Type declaration
--
-
-
-
-ReadonlyCONNECTED: "Connected"-Connected to the Archipelago server and authenticated to the current room.
-
- -
-
-ReadonlyCONNECTING: "Connecting"-Attempting to establish a connection to the Archipelago server.
-
- -
-
-ReadonlyDISCONNECTED: "Disconnected"-Currently not connected to any Archipelago server.
-
- -
-
-ReadonlyWAITING_FOR_ AUTH: "Waiting For Authentication" -Connected to the Archipelago server, but awaiting to authenticate to join the room.
-
-
-
\ No newline at end of file
diff --git a/variables/CREATE_AS_HINT_MODE.html b/variables/CREATE_AS_HINT_MODE.html
deleted file mode 100644
index ddb8dc5..0000000
--- a/variables/CREATE_AS_HINT_MODE.html
+++ /dev/null
@@ -1,183 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable CREATE_AS_HINT_MODE
-Variable CREATE_AS_HINT_MODEConst
CREATE_
HINT_EVERYTHING: 1;
HINT_ONLY_NEW: 2;
NO_HINT: 0;
} = ...
-HINT_EVERYTHING: 1;
HINT_ONLY_NEW: 2;
NO_HINT: 0;
} = ...
The hint type for create_as_hint in LocationScoutsPacket.
-
-Type declaration
--
-
-
-
-ReadonlyHINT_EVERYTHING: 1 -Mark all locations as hinted and show to all relevant clients.
-
- -
-
-ReadonlyHINT_ONLY_ NEW: 2 -Mark all locations as hinted and show only newly hinted locations to relevant clients.
-
- -
-
-ReadonlyNO_HINT: 0 -Does not mark any location to be hinted and broadcast to clients.
-
-
-
\ No newline at end of file
diff --git a/variables/ITEMS_HANDLING_FLAGS.html b/variables/ITEMS_HANDLING_FLAGS.html
deleted file mode 100644
index be712dc..0000000
--- a/variables/ITEMS_HANDLING_FLAGS.html
+++ /dev/null
@@ -1,193 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable ITEMS_HANDLING_FLAGS
-Variable ITEMS_HANDLING_FLAGSConst
ITEMS_
LOCAL_ONLY: 0;
REMOTE_ALL: 7;
REMOTE_DIFFERENT_WORLDS: 1;
REMOTE_OWN_WORLD: 2;
REMOTE_STARTING_INVENTORY: 4;
} = ...
-LOCAL_ONLY: 0;
REMOTE_ALL: 7;
REMOTE_DIFFERENT_WORLDS: 1;
REMOTE_OWN_WORLD: 2;
REMOTE_STARTING_INVENTORY: 4;
} = ...
Bit flags configuring which items should be sent by the server to this client.
-
-
-Type declaration
--
-
-
-
-ReadonlyLOCAL_ONLY: 0 -No ReceivedItems is sent to you, ever.
-
- -
-
-ReadonlyREMOTE_ALL: 7 -Shorthand for
-REMOTE_DIFFERENT_WORLDS,REMOTE_OWN_WORLD, andREMOTE_STARTING_INVENTORY.
- -
-
-ReadonlyREMOTE_DIFFERENT_ WORLDS: 1 -Indicates you get items sent from other worlds.
-
- -
-
-ReadonlyREMOTE_OWN_ WORLD: 2 -Indicates you get items sent from your own world. Requires
-REMOTE_DIFFERENT_WORLDSto be set.
- -
-
-ReadonlyREMOTE_STARTING_ INVENTORY: 4 -Indicates you get your starting inventory sent. Requires
-REMOTE_DIFFERENT_WORLDSto be set.
-
-
\ No newline at end of file
diff --git a/variables/ITEM_FLAGS.html b/variables/ITEM_FLAGS.html
deleted file mode 100644
index e14bd65..0000000
--- a/variables/ITEM_FLAGS.html
+++ /dev/null
@@ -1,188 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable ITEM_FLAGS
-Variable ITEM_FLAGSConst
ITEM_
FILLER: 0;
NEVER_EXCLUDE: 2;
PROGRESSION: 1;
TRAP: 4;
} = ...
-FILLER: 0;
NEVER_EXCLUDE: 2;
PROGRESSION: 1;
TRAP: 4;
} = ...
Bit flags that determine if an item is progression, "nice to have", filler, or a trap.
-
-
-Type declaration
--
-
-
-
-ReadonlyFILLER: 0-Nothing special about this item.
-
- -
-
-ReadonlyNEVER_EXCLUDE: 2 -If set, indicates the item is important but not in a way that unlocks advancement.
-
- -
-
-ReadonlyPROGRESSION: 1-If set, indicates the item can unlock logical advancement.
-
- -
-
-ReadonlyTRAP: 4-If set, indicates the item is a trap that can inconvenience the player.
-
-
-
\ No newline at end of file
diff --git a/variables/MINIMUM_SUPPORTED_AP_VERSION.html b/variables/MINIMUM_SUPPORTED_AP_VERSION.html
deleted file mode 100644
index 9a7148c..0000000
--- a/variables/MINIMUM_SUPPORTED_AP_VERSION.html
+++ /dev/null
@@ -1,165 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable MINIMUM_SUPPORTED_AP_VERSION
-
-Variable MINIMUM_SUPPORTED_AP_VERSIONConst
Minimum supported version of Archipelago this library supports.
-
-
-
\ No newline at end of file
diff --git a/variables/PACKET_PROBLEM_TYPE.html b/variables/PACKET_PROBLEM_TYPE.html
deleted file mode 100644
index a349baf..0000000
--- a/variables/PACKET_PROBLEM_TYPE.html
+++ /dev/null
@@ -1,179 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable PACKET_PROBLEM_TYPE
-Variable PACKET_PROBLEM_TYPEConst
PACKET_
ARGUMENTS: "arguments";
CMD: "cmd";
} = ...
-ARGUMENTS: "arguments";
CMD: "cmd";
} = ...
PacketProblemType indicates the type of problem that was detected in the faulty packet, the known problem types are -below but others may be added in the future.
-
-
-Type declaration
--
-
-
-
-ReadonlyARGUMENTS: "arguments"-Arguments of the faulty packet which were not correct.
-
- -
-
-ReadonlyCMD: "cmd"-
-cmdargument of the faulty packet that could not be parsed correctly.
-
-
\ No newline at end of file
diff --git a/variables/PERMISSION-1.html b/variables/PERMISSION-1.html
deleted file mode 100644
index 68a55c7..0000000
--- a/variables/PERMISSION-1.html
+++ /dev/null
@@ -1,194 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable PERMISSION
-Variable PERMISSIONConst
PERMISSION: {
AUTO: 6;
AUTO_ENABLED: 7;
DISABLED: 0;
ENABLED: 1;
GOAL: 2;
} = ...
-AUTO: 6;
AUTO_ENABLED: 7;
DISABLED: 0;
ENABLED: 1;
GOAL: 2;
} = ...
A const containing the possible command permissions, for commands that may be restricted.
-
-
-Type declaration
--
-
-
-
-ReadonlyAUTO: 6-Forces players to use this command after they have completed their goal. Only works for
-!releaseand!collect
- -
-
-ReadonlyAUTO_ENABLED: 7 -Allows players to use this command manually at any time and forces them to use this command after they have -completed their goal.
-
- -
-
-ReadonlyDISABLED: 0-Prevents players from using this command at any time.
-
- -
-
-ReadonlyENABLED: 1-Allows players to use this command manually at any time.
-
- -
-
-ReadonlyGOAL: 2-Allows players to use this command manually after they have completed their goal.
-
-
-
\ No newline at end of file
diff --git a/variables/PRINT_JSON_TYPE.html b/variables/PRINT_JSON_TYPE.html
deleted file mode 100644
index b9cee22..0000000
--- a/variables/PRINT_JSON_TYPE.html
+++ /dev/null
@@ -1,243 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable PRINT_JSON_TYPE
-Variable PRINT_JSON_TYPEConst
PRINT_
ADMIN_COMMAND_RESULT: "AdminCommandResult";
CHAT: "Chat";
COLLECT: "Collect";
COMMAND_RESULT: "CommandResult";
COUNTDOWN: "Countdown";
GOAL: "Goal";
HINT: "Hint";
ITEM_CHEAT: "ItemCheat";
ITEM_SEND: "ItemSend";
JOIN: "Join";
PART: "Part";
RELEASE: "Release";
SERVER_CHAT: "ServerChat";
TAGS_CHANGED: "TagsChanged";
TUTORIAL: "Tutorial";
} = ...
-ADMIN_COMMAND_RESULT: "AdminCommandResult";
CHAT: "Chat";
COLLECT: "Collect";
COMMAND_RESULT: "CommandResult";
COUNTDOWN: "Countdown";
GOAL: "Goal";
HINT: "Hint";
ITEM_CHEAT: "ItemCheat";
ITEM_SEND: "ItemSend";
JOIN: "Join";
PART: "Part";
RELEASE: "Release";
SERVER_CHAT: "ServerChat";
TAGS_CHANGED: "TagsChanged";
TUTORIAL: "Tutorial";
} = ...
A const of known PrintJSONPacket types.
-
-
-Type declaration
--
-
-
-
-ReadonlyADMIN_COMMAND_ RESULT: "AdminCommandResult" -The client entered an
-!admincommand.
- -
-
-ReadonlyCHAT: "Chat"-A player sent a chat message.
-
- -
-
-ReadonlyCOLLECT: "Collect"-A player collected the remaining items for their world.
-
- -
-
-ReadonlyCOMMAND_RESULT: "CommandResult" -Someone (usually the client) entered an
-!command.
- -
-
-ReadonlyCOUNTDOWN: "Countdown"-The current server countdown has progressed.
-
- -
-
-ReadonlyGOAL: "Goal"-A player reached their goal.
-
- -
-
-ReadonlyHINT: "Hint"-A player hinted.
-
- -
-
-ReadonlyITEM_CHEAT: "ItemCheat" -A player used the
-!getitemcommand.
- -
-
-ReadonlyITEM_SEND: "ItemSend" -A player received an item.
-
- -
-
-ReadonlyJOIN: "Join"-A player connected.
-
- -
-
-ReadonlyPART: "Part"-A player disconnected.
-
- -
-
-ReadonlyRELEASE: "Release"-A player released the remaining items in their world.
-
- -
-
-ReadonlySERVER_CHAT: "ServerChat" -The server broadcast a message.
-
- -
-
-ReadonlyTAGS_CHANGED: "TagsChanged" -A player changed their tags.
-
- -
-
-ReadonlyTUTORIAL: "Tutorial"-The client has triggered a tutorial message, such as when first connecting.
-
-
-
\ No newline at end of file
diff --git a/variables/REDUCED_PERMISSION.html b/variables/REDUCED_PERMISSION.html
deleted file mode 100644
index f1332cc..0000000
--- a/variables/REDUCED_PERMISSION.html
+++ /dev/null
@@ -1,184 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable REDUCED_PERMISSION
-Variable REDUCED_PERMISSIONConst
REDUCED_
DISABLED: 0;
ENABLED: 1;
GOAL: 2;
} = ...
-DISABLED: 0;
ENABLED: 1;
GOAL: 2;
} = ...
A const containing the possible command permissions, for commands that may be restricted and do not support auto -modes.
-
-
-Type declaration
--
-
-
-
-ReadonlyDISABLED: 0-Prevents players from using this command at any time.
-
- -
-
-ReadonlyENABLED: 1-Allows players to use this command manually at any time.
-
- -
-
-ReadonlyGOAL: 2-Allows players to use this command manually after they have completed their goal.
-
-
-
\ No newline at end of file
diff --git a/variables/SERVER_PACKET_TYPE.html b/variables/SERVER_PACKET_TYPE.html
deleted file mode 100644
index b8bfb52..0000000
--- a/variables/SERVER_PACKET_TYPE.html
+++ /dev/null
@@ -1,193 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable SERVER_PACKET_TYPE
-Variable SERVER_PACKET_TYPEConst
SERVER_
BOUNCED: "Bounced";
CONNECTED: "Connected";
CONNECTION_REFUSED: "ConnectionRefused";
DATA_PACKAGE: "DataPackage";
INVALID_PACKET: "InvalidPacket";
LOCATION_INFO: "LocationInfo";
PRINT_JSON: "PrintJSON";
RECEIVED_ITEMS: "ReceivedItems";
RETRIEVED: "Retrieved";
ROOM_INFO: "RoomInfo";
ROOM_UPDATE: "RoomUpdate";
SET_REPLY: "SetReply";
} = ...
-BOUNCED: "Bounced";
CONNECTED: "Connected";
CONNECTION_REFUSED: "ConnectionRefused";
DATA_PACKAGE: "DataPackage";
INVALID_PACKET: "InvalidPacket";
LOCATION_INFO: "LocationInfo";
PRINT_JSON: "PrintJSON";
RECEIVED_ITEMS: "ReceivedItems";
RETRIEVED: "Retrieved";
ROOM_INFO: "RoomInfo";
ROOM_UPDATE: "RoomUpdate";
SET_REPLY: "SetReply";
} = ...
A const of all possible packet types the server can send to the client. See each packet's documentation page for -additional information on each packet type.
-
-
-Type declaration
--
-
-
-
ReadonlyBOUNCED: "Bounced"
- -
-
ReadonlyCONNECTED: "Connected"
- -
-
ReadonlyCONNECTION_REFUSED: "ConnectionRefused"
- -
-
ReadonlyDATA_PACKAGE: "DataPackage"
- -
-
ReadonlyINVALID_PACKET: "InvalidPacket"
- -
-
ReadonlyLOCATION_INFO: "LocationInfo"
- -
-
ReadonlyPRINT_JSON: "PrintJSON"
- -
-
ReadonlyRECEIVED_ITEMS: "ReceivedItems"
- -
-
ReadonlyRETRIEVED: "Retrieved"
- -
-
ReadonlyROOM_INFO: "RoomInfo"
- -
-
ReadonlyROOM_UPDATE: "RoomUpdate"
- -
-
ReadonlySET_REPLY: "SetReply"
-
-
\ No newline at end of file
diff --git a/variables/SLOT_TYPE.html b/variables/SLOT_TYPE.html
deleted file mode 100644
index 5574640..0000000
--- a/variables/SLOT_TYPE.html
+++ /dev/null
@@ -1,183 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable SLOT_TYPE
-Variable SLOT_TYPEConst
SLOT_
GROUP: 2;
PLAYER: 1;
SPECTATOR: 0;
} = ...
-GROUP: 2;
PLAYER: 1;
SPECTATOR: 0;
} = ...
A const representing the nature of the slot.
-
-
-Type declaration
--
-
-
-
-ReadonlyGROUP: 2-This client is an item links group containing at least 1 player with active item links.
-
- -
-
-ReadonlyPLAYER: 1-This client is a player and is participating in the current game.
-
- -
-
-ReadonlySPECTATOR: 0-This client is a spectator and not participating in the current game.
-
-
-
\ No newline at end of file
diff --git a/variables/VALID_JSON_COLOR_TYPE.html b/variables/VALID_JSON_COLOR_TYPE.html
deleted file mode 100644
index 57c5cf0..0000000
--- a/variables/VALID_JSON_COLOR_TYPE.html
+++ /dev/null
@@ -1,207 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable VALID_JSON_COLOR_TYPE
-Variable VALID_JSON_COLOR_TYPEConst
VALID_
BLACK: "black";
BLACK_BACKGROUND: "black_bg";
BLUE: "blue";
BLUE_BACKGROUND: "blue_bg";
BOLD: "bold";
CYAN: "cyan";
CYAN_BACKGROUND: "cyan_bg";
GREEN: "green";
GREEN_BACKGROUND: "green_bg";
MAGENTA: "magenta";
PURPLE_BACKGROUND: "purple_bg";
RED: "red";
RED_BACKGROUND: "red_bg";
UNDERLINE: "underline";
WHITE: "white";
WHITE_BACKGROUND: "white_bg";
YELLOW: "yellow";
YELLOW_BACKGROUND: "yellow_bg";
} = ...
-BLACK: "black";
BLACK_BACKGROUND: "black_bg";
BLUE: "blue";
BLUE_BACKGROUND: "blue_bg";
BOLD: "bold";
CYAN: "cyan";
CYAN_BACKGROUND: "cyan_bg";
GREEN: "green";
GREEN_BACKGROUND: "green_bg";
MAGENTA: "magenta";
PURPLE_BACKGROUND: "purple_bg";
RED: "red";
RED_BACKGROUND: "red_bg";
UNDERLINE: "underline";
WHITE: "white";
WHITE_BACKGROUND: "white_bg";
YELLOW: "yellow";
YELLOW_BACKGROUND: "yellow_bg";
} = ...
This is a const of all supported "colors" denoting a console color to display the message part with and is only
-sent if the type is color. This is limited to console colors due to backwards compatibility needs with games such
-as A Link to the Past. Although background colors as well as foreground colors are listed, only one may be applied
-to a JSONMessagePart at a time.
-
-Type declaration
--
-
-
-
ReadonlyBLACK: "black"
- -
-
ReadonlyBLACK_BACKGROUND: "black_bg"
- -
-
ReadonlyBLUE: "blue"
- -
-
ReadonlyBLUE_BACKGROUND: "blue_bg"
- -
-
ReadonlyBOLD: "bold"
- -
-
ReadonlyCYAN: "cyan"
- -
-
ReadonlyCYAN_BACKGROUND: "cyan_bg"
- -
-
ReadonlyGREEN: "green"
- -
-
ReadonlyGREEN_BACKGROUND: "green_bg"
- -
-
ReadonlyMAGENTA: "magenta"
- -
-
ReadonlyPURPLE_BACKGROUND: "purple_bg"
- -
-
ReadonlyRED: "red"
- -
-
ReadonlyRED_BACKGROUND: "red_bg"
- -
-
ReadonlyUNDERLINE: "underline"
- -
-
ReadonlyWHITE: "white"
- -
-
ReadonlyWHITE_BACKGROUND: "white_bg"
- -
-
ReadonlyYELLOW: "yellow"
- -
-
ReadonlyYELLOW_BACKGROUND: "yellow_bg"
-
-
\ No newline at end of file
diff --git a/variables/VALID_JSON_MESSAGE_TYPE.html b/variables/VALID_JSON_MESSAGE_TYPE.html
deleted file mode 100644
index 5bb02b3..0000000
--- a/variables/VALID_JSON_MESSAGE_TYPE.html
+++ /dev/null
@@ -1,198 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Variable VALID_JSON_MESSAGE_TYPE
-Variable VALID_JSON_MESSAGE_TYPEConst
VALID_
COLOR: "color";
ENTRANCE_NAME: "entrance_name";
ITEM_ID: "item_id";
ITEM_NAME: "item_name";
LOCATION_ID: "location_id";
LOCATION_NAME: "location_name";
PLAYER_ID: "player_id";
PLAYER_NAME: "player_name";
TEXT: "text";
} = ...
-COLOR: "color";
ENTRANCE_NAME: "entrance_name";
ITEM_ID: "item_id";
ITEM_NAME: "item_name";
LOCATION_ID: "location_id";
LOCATION_NAME: "location_name";
PLAYER_ID: "player_id";
PLAYER_NAME: "player_name";
TEXT: "text";
} = ...
This is a const of all supported message types for denoting the intent of the message part. This can be used to -indicate special information which may be rendered differently depending on client.
--
-
text: Regular text content. Is the default type and as such may be omitted.
-player_id: Player id of someone on your team, should be resolved to player Name.
-player_name: Player Name, could be a player within a multiplayer game or from another team, not id resolvable.
-item_id: Item id, should be resolved to an item name.
-item_name: Item name, not currently used over network, but supported by reference clients.
-location_id: Location id, should be resolved to a location name.
-location_name: Location name, not currently used over network, but supported by reference clients.
-entrance_name: Entrance name. No id mapping exists.
-color: Regular text that should be colored. Only type that will contain color data.
-
-
-Type declaration
--
-
-
-
ReadonlyCOLOR: "color"
- -
-
ReadonlyENTRANCE_NAME: "entrance_name"
- -
-
ReadonlyITEM_ID: "item_id"
- -
-
ReadonlyITEM_NAME: "item_name"
- -
-
ReadonlyLOCATION_ID: "location_id"
- -
-
ReadonlyLOCATION_NAME: "location_name"
- -
-
ReadonlyPLAYER_ID: "player_id"
- -
-
ReadonlyPLAYER_NAME: "player_name"
- -
-
ReadonlyTEXT: "text"
-
-
\ No newline at end of file
diff --git a/variables/libraryVersion.html b/variables/libraryVersion.html
new file mode 100644
index 0000000..c2a1c36
--- /dev/null
+++ b/variables/libraryVersion.html
@@ -0,0 +1 @@
+Generated using TypeDoc
Variable libraryVersionConst
library
Variable targetVersionConst
target
build: number;
major: number;
minor: number;
} = ...
build: number;
major: number;
minor: number;
} = ...
Archipelago version this library attempts to target. Support for older versions of the Archipelago API is not +guarenteed and some newer enhancements may no longer work or be supported.
+
The client that connects to an Archipelago server and facilitates communication, listens for events, and manages -data.
-