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 sacred grove data class data and the operations listed below. Related types link to the values this API consumes or returns.
Provides sanctum data class data and the operations listed below. Related types link to the values this API consumes or returns.
Provides syndacate data class data and the operations listed below. Related types link to the values this API consumes or returns.
Provides syndicate data class data and the operations listed below. Related types link to the values this API consumes or returns.
Provides synthesis data class data and the operations listed below. Related types link to the values this API consumes or returns.
Provides ultimatum data class data and the operations listed below. Related types link to the values this API consumes or returns.
Represents grotto mirror in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground blind smoke in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides ground effect data and the operations listed below. Related types link to the values this API consumes or returns.
Provides ground effects dat data and the operations listed below. Related types link to the values this API consumes or returns.
Represents ground evil in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground evil red in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground fire in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground fire white in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground holy in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground ice in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground lightning in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground poison in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground spike in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground tar in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ground vaal cloud in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides gui data and the operations listed below. Related types link to the values this API consumes or returns.
Represents guild stash in the current game state. Obtain the object from its owning API and refresh it after an area change.
Information supplied when the gui tick event is raised.
Provides heist blueprint data and the operations listed below. Related types link to the values this API consumes or returns.
Provides room data and the operations listed below. Related types link to the values this API consumes or returns.
Provides heist contract data and the operations listed below. Related types link to the values this API consumes or returns.
Item preview owned by a world object, including the Abyss crafting device.
Reads hidden skill bar element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Reads hideout selection element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
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.