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 · DPB2Reads timers pannel element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Callback contract for time selected changed event handler. The Invoke signature below shows the arguments supplied to the callback.
Information supplied when the time selected changed routed event is raised.
Provides tincture data and the operations listed below. Related types link to the values this API consumes or returns.
Provides toggleable data and the operations listed below. Related types link to the values this API consumes or returns.
Reads toggle explosive placement element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides trade control wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Reads trade price item dialog element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Reads trade ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides transitionable data and the operations listed below. Related types link to the values this API consumes or returns.
The Trial of the Sekhemas floor map, its room controls and displayed resources.
A room control on the Trial of the Sekhemas floor map.
Provides triggerable blockage data and the operations listed below. Related types link to the values this API consumes or returns.
Represents triggerable blockage in the current game state. Obtain the object from its owning API and refresh it after an area change.
Reads ui quest states element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides map content data and the operations listed below. Related types link to the values this API consumes or returns.
Provides map objective data and the operations listed below. Related types link to the values this API consumes or returns.
Reads ultimatum challenge element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Represents ultimatum challenge interactable in the current game state. Obtain the object from its owning API and refresh it after an area change.
Reads ultimatum reward ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides ultimatum trial data and the operations listed below. Related types link to the values this API consumes or returns.
Provides universal file wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Provides usable data and the operations listed below. Related types link to the values this API consumes or returns.
Provides util data and the operations listed below. Related types link to the values this API consumes or returns.
Provides utility data and the operations listed below. Related types link to the values this API consumes or returns.
Provides vector2 data and the operations listed below. Related types link to the values this API consumes or returns.
A two-dimensional integer position. Used by grid-position and pathfinding APIs; screen-position APIs may expect a different coordinate type.
Provides vector3 data and the operations listed below. Related types link to the values this API consumes or returns.
Provides wait function data and the operations listed below. Related types link to the values this API consumes or returns.
Provides wait render data and the operations listed below. Related types link to the values this API consumes or returns.
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.