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 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.
Defines the authored 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.
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 content 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 tem evaluator contract. Implement the listed members to provide this capability.
Defines the logic provider contract. Implement the listed members to provide this capability.
Defines the message handler contract. Implement the listed members to provide this capability.
Defines the mouse handler contract. Implement the listed members to provide this capability.
Provides incursion temple data and the operations listed below. Related types link to the values this API consumes or returns.
Reads incursion ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides indexadle support gems dat data and the operations listed below. Related types link to the values this API consumes or returns.
Provides indexadle support gems record data and the operations listed below. Related types link to the values this API consumes or returns.
Provides indexed list data and the operations listed below. Related types link to the values this API consumes or returns.
Represents ingame data in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents portal object in the current game state. Obtain the object from its owning API and refresh it after an area change.
This is an internal data class, you usually don't directly access this data.
Represents ingame ui elements in the current game state. Obtain the object from its owning API and refresh it after an area change.
Coordinates instance. Use its members to discover the current selection and supported operations.
Provides int range data and the operations listed below. Related types link to the values this API consumes or returns.
Provides inventories data and the operations listed below. Related types link to the values this API consumes or returns.
Provides inventory data and the operations listed below. Related types link to the values this API consumes or returns.
Represents inventory in the current game state. Obtain the object from its owning API and refresh it after an area change.
Reads inventory element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Represents inventory holder 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.