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 recipe data and the operations listed below. Related types link to the values this API consumes or returns.
Provides recipe data and the operations listed below. Related types link to the values this API consumes or returns.
Provides price data and the operations listed below. Related types link to the values this API consumes or returns.
Provides price data and the operations listed below. Related types link to the values this API consumes or returns.
Provides hotkey data and the operations listed below. Related types link to the values this API consumes or returns.
Provides hotkey data and the operations listed below. Related types link to the values this API consumes or returns.
Provides hotkeys data and the operations listed below. Related types link to the values this API consumes or returns.
Provides hotkeys data and the operations listed below. Related types link to the values this API consumes or returns.
Reads hud ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Reads hud ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides hull data and the operations listed below. Related types link to the values this API consumes or returns.
Provides hull data and the operations listed below. Related types link to the values this API consumes or returns.
Defines the authored contract. Implement the listed members to provide this capability.
Defines the authored contract. Implement the listed members to provide this capability.
Defines the base contract. Implement the listed members to provide this capability.
Defines the base contract. Implement the listed members to provide this capability.
Contract for a complete bot. Follow the inherited lifecycle, task and configuration contracts when implementing your bot.
Contract for a complete bot. Follow the inherited lifecycle, task and configuration contracts when implementing your bot.
Represents ice tempest storm in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents ice tempest storm in the current game state. Obtain the object from its owning API and refresh it after an area change.
Defines the configurable contract. Implement the listed members to provide this capability.
Defines the configurable contract. Implement the listed members to provide this capability.
Defines the content contract. Implement the listed members to provide this capability.
Defines the content contract. Implement the listed members to provide this capability.
Defines the enableable contract. Implement the listed members to provide this capability.
Defines the enableable contract. Implement the listed members to provide this capability.
Defines the explorer contract. Implement the listed members to provide this capability.
Defines the explorer contract. Implement the listed members to provide this capability.
Defines the hidable contract. Implement the listed members to provide this capability.
Defines the tem evaluator contract. Implement the listed members to provide this capability.
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.