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 · DPB2This class give informations about the ritual in the current zone.
Provides scourge data and the operations listed below. Related types link to the values this API consumes or returns.
Reports affinities assigned across the personal stash and the supported lockers.
Contains informations about the actual Area instance. for exemple this contain the informations about the Labyrinth, or the actual area Mods.
This class describe informations about The Labyrinth and is only aviable while inside a Labyrinth.
Provides labyrinth override data and the operations listed below. Related types link to the values this API consumes or returns.
Aclass that describe a Labyrinth room.
Provides labyrinth secret data and the operations listed below. Related types link to the values this API consumes or returns.
This class retive informations and perform tasks on the Login State Ui, the menu can be open with the 'Esc' key.
This class retive informations and perform tasks on the Unlock Account Ui.
Provides mastery skill ids data and the operations listed below. Related types link to the values this API consumes or returns.
Callback contract for paste text failed event. The Invoke signature below shows the arguments supplied to the callback.
The PreGameState rapresent the state right after the login button is been pressed
This class retive informations and perform tasks on the Select Character State Ui.
Retrieve information about the actual game state (are we in the login state?, char selection, loading etc etc) Use this class to know in witch state you are, to handle proper logic (should we log in? select a char, create one etc etc). For the InGameState, pls use `LokiPoe.IsIngame`
Temporary Performance Profiler used for internal performance test purpose.
This class let you retrieve information about the Terrain layout in the current area. This is exactly how the game use some specific graphic elements, to draw the area map. This graphic elements are placed in the zone as you enter the area, for the entire zone and are static elements. This mean that you can know where exactly they are (theyr coordinates), without exploring the area. You can use this information to recognize specific spot in a zone, since some special graphic elements, always describe a specific game element, like a stair, a gate, a special door. Please bear in mind that usually there are more than 1 elements of the same kinde placed in a area, and not all of them are placed in walkable space, so you need to iterate all the specific element you want, and check if a path exist to them.
Provides terrain data entry data and the operations listed below. Related types link to the values this API consumes or returns.
Provides terrain data entry wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Topologies seem to be a big area composed of squares, rooms, that somehow give dettails about the surrounding.
TopologieRoom is a square, described by its MinCoord and MaxCoord, suggesting dettails trought a Name.
Provides ui dump data data and the operations listed below. Related types link to the values this API consumes or returns.
This are Generic utility functions used mainly for debug purpose.
Provides magnetic data and the operations listed below. Related types link to the values this API consumes or returns.
Reads main ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides map data and the operations listed below. Related types link to the values this API consumes or returns.
Represents map in the current game state. Obtain the object from its owning API and refresh it after an area change.
Reads map device element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Reads map element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides map key 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.