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 · DPB2Callback contract for finished measuring callback. The Invoke signature below shows the arguments supplied to the callback.
Represents fire tempest storm in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides flask data and the operations listed below. Related types link to the values this API consumes or returns.
Provides folder browser dialog ex data and the operations listed below. Related types link to the values this API consumes or returns.
Provides fragment inventory item data and the operations listed below. Related types link to the values this API consumes or returns.
Provides fragment stash tab layouts data and the operations listed below. Related types link to the values this API consumes or returns.
Provides fragment stash tab layout hardcoded data and the operations listed below. Related types link to the values this API consumes or returns.
Provides fragment stash tab layout json data and the operations listed below. Related types link to the values this API consumes or returns.
Information supplied when the frame release event is raised.
Provides game constants data and the operations listed below. Related types link to the values this API consumes or returns.
Reads gateway combo box element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides gateway combo box entry data and the operations listed below. Related types link to the values this API consumes or returns.
Provides generic checkbox data and the operations listed below. Related types link to the values this API consumes or returns.
Reads generic combo box element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides generic combo box entry data and the operations listed below. Related types link to the values this API consumes or returns.
Callback contract for get settings delegate. The Invoke signature below shows the arguments supplied to the callback.
Configuration for global settings. Properties below describe the available settings.
Reads global warning dialog element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Reads grand heist contract element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides job data and the operations listed below. Related types link to the values this API consumes or returns.
Provides granted effects per level data and the operations listed below. Related types link to the values this API consumes or returns.
Represents granted effects per level in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides granted effects per level dat data and the operations listed below. Related types link to the values this API consumes or returns.
Track explored and unexplored parts of an area to choose where the bot should explore next.
Provides afliction data class data and the operations listed below. Related types link to the values this API consumes or returns.
Provides incursion data class data and the operations listed below. Related types link to the values this API consumes or returns.
Callback contract for location selector delegate. The Invoke signature below shows the arguments supplied to the callback.
Callback contract for location update event. The Invoke signature below shows the arguments supplied to the callback.
Provides node data and the operations listed below. Related types link to the values this API consumes or returns.
Event arguments containing exploration update data
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.