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 diagnostic element new in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents row graph data in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides dies after time data and the operations listed below. Related types link to the values this API consumes or returns.
Reads display note element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides divination inventory item data and the operations listed below. Related types link to the values this API consumes or returns.
Provides divination stash tab layouts data and the operations listed below. Related types link to the values this API consumes or returns.
Provides divination stash tab layout hardcoded data and the operations listed below. Related types link to the values this API consumes or returns.
Reads divine font ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides transfigure option data and the operations listed below. Related types link to the values this API consumes or returns.
Represents effect in the current game state. Obtain the object from its owning API and refresh it after an area change.
Describe properties of a Ui Element, like its position (X,Y), size (Width,Height), scale (Scale), and many other properties. The whole Game user interface, is a `Matrioska` of Elements and childs element. You usually dont need to care about this informations, the LokiPoe.IngameState, offer convenient wrappers for all the implemented interfaces.
Provides entity data and the operations listed below. Related types link to the values this API consumes or returns.
Provides entity component information data and the operations listed below. Related types link to the values this API consumes or returns.
Provides entity label data and the operations listed below. Related types link to the values this API consumes or returns.
Provides entity wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Provides essence inventory item data and the operations listed below. Related types link to the values this API consumes or returns.
Provides essence stash tab layouts data and the operations listed below. Related types link to the values this API consumes or returns.
Provides essence stash tab layout hardcoded data and the operations listed below. Related types link to the values this API consumes or returns.
Provides essence stash tab layout json data and the operations listed below. Related types link to the values this API consumes or returns.
Provides edited triggerable blokage data and the operations listed below. Related types link to the values this API consumes or returns.
Callback contract for exile pather reload event. The Invoke signature below shows the arguments supplied to the callback.
Provides obstacle data and the operations listed below. Related types link to the values this API consumes or returns.
Callback contract for obstacle update event. The Invoke signature below shows the arguments supplied to the callback.
Callback contract for plot function. The Invoke signature below shows the arguments supplied to the callback.
Callback contract for plot object function. The Invoke signature below shows the arguments supplied to the callback.
Provides raycast network object data and the operations listed below. Related types link to the values this API consumes or returns.
Describes the outcome of raycast. Check the returned outcome before continuing with another action.
Reads expedition dealer element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Reads expedition locker ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Represents expedition placement indicator 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.