Start with the client state
Check that the client is in game before reading player or area data.
Client state · DPB1Client state · DPB2Explore DPB1 and DPB2 by type, member or use case. Every reference includes its signatures, arguments, available results and links to related APIs.
Check that the client is in game before reading player or area data.
Client state · DPB1Client state · DPB2Discover typed objects and refresh their state after interaction or travel.
Object discovery · DPB1Object discovery · DPB2Use the bot, plugin and task contracts to integrate your own behavior.
Task contract · DPB1Task contract · DPB2Provides currency info data and the operations listed below. Related types link to the values this API consumes or returns.
Provides currency info data and the operations listed below. Related types link to the values this API consumes or returns.
Provides currency inventory item data and the operations listed below. Related types link to the values this API consumes or returns.
Provides currency inventory item data and the operations listed below. Related types link to the values this API consumes or returns.
Provides currency stash tab layouts data and the operations listed below. Related types link to the values this API consumes or returns.
Exposes the live contents of Data/Balance/CurrencyStashTabLayout.dat.
Provides currency stash tab layout data and the operations listed below. Related types link to the values this API consumes or returns.
Provides currency stash tab layout hardcoded data and the operations listed below. Related types link to the values this API consumes or returns.
A currency stash slot definition. The historical type name is preserved for API compatibility.
Provides currency stash tab layout json data and the operations listed below. Related types link to the values this API consumes or returns.
Provides currency stash tab layout json data and the operations listed below. Related types link to the values this API consumes or returns.
Reads cursor element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Reads cursor element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides custom logger data and the operations listed below. Related types link to the values this API consumes or returns.
Provides custom logger data and the operations listed below. Related types link to the values this API consumes or returns.
Represents dark shrine in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents dark shrine in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides dat data and the operations listed below. Related types link to the values this API consumes or returns.
Provides dat data and the operations listed below. Related types link to the values this API consumes or returns.
Game-data record for quest reward. Use its identifiers and properties to look up game definitions.
Game-data record for quest reward. Use its identifiers and properties to look up game definitions.
Provides runtime data and the operations listed below. Related types link to the values this API consumes or returns.
Provides runtime data and the operations listed below. Related types link to the values this API consumes or returns.
Game-data record for active skill. Use its identifiers and properties to look up game definitions.
Game-data record for active skill. Use its identifiers and properties to look up game definitions.
Game-data record for archnemesis mod. Use its identifiers and properties to look up game definitions.
Game-data record for archnemesis mod. Use its identifiers and properties to look up game definitions.
Game-data record for base item type. Use its identifiers and properties to look up game definitions.
Game-data record for base item type. Use its identifiers and properties to look up game definitions.
Game-data record for bestiary recipe component. Use its identifiers and properties to look up game definitions.
This reference covers the developer-facing declarations in the reviewed Release source snapshot, including inherited APIs through their base-type links. Product versions are documented separately so differences remain visible.