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 · DPB2Represents abyss final node sub area in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss final node sub area in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss node large in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss node large in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss node mini in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss node mini in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss node small in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss node small in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss start node in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss start node in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides abyss stash tab layout data and the operations listed below. Related types link to the values this API consumes or returns.
Provides abyss stash tab layout hardcoded data and the operations listed below. Related types link to the values this API consumes or returns.
Provides abyss stash tab layout json data and the operations listed below. Related types link to the values this API consumes or returns.
Represents abyss well of souls in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides action helper data and the operations listed below. Related types link to the values this API consumes or returns.
The current action's optional two-rate timing adjustment, not a rendered animation or a list of clips.
Provides active skills dat data and the operations listed below. Related types link to the values this API consumes or returns.
Represents active skill wrapper in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents active skill wrapper in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides actor data and the operations listed below. Related types link to the values this API consumes or returns.
Represents actor in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides actor data and the operations listed below. Related types link to the values this API consumes or returns.
Represents actor in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides action wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Provides action wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Represents actor vaal skill in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents actor vaal skill in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides affinitie checkbox data and the operations listed below. Related types link to the values this API consumes or returns.
Provides affinitie checkbox data and the operations listed below. Related types link to the values this API consumes or returns.
Represents afliction initiator in the current game state. Obtain the object from its owning API and refresh it after an area change.
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.