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 · DPB2Start here to check the client state, access the local player and identify the current area. Read in-game data only after checking IsInGame.
Start here to check the client state, access the local player and identify the current area. Read in-game data only after checking IsInGame.
Retrieve informations about all the game Objects, Npcs, Monsters, WorldItems, AreaTransitions, but also interactable objects like Blight Towers, Ultimatum monolith, harmfull effects, etc etc. Litterally all the dynamic objects placed in game by the server. Use this wisely, as even if the ObjectManager have a cache that is refreshed every 30ms, calling it that fast, is really cpu intensive, you should code your components in the most efficent way possible.
Retrieve informations about all the game Objects, Npcs, Monsters, WorldItems, AreaTransitions, but also interactable objects like Blight Towers, Ultimatum monolith, harmfull effects, etc etc. Litterally all the dynamic objects placed in game by the server. Use this wisely, as even if the ObjectManager have a cache that is refreshed every 30ms, calling it that fast, is really cpu intensive, you should code your components in the most efficent way possible.
Asynchronous helpers for timing, interaction and common game actions. Await these helpers within the bot workflow.
Asynchronous helpers for timing, interaction and common game actions. Await these helpers within the bot workflow.
Contract for a unit of asynchronous bot work. Implement Run and the inherited lifecycle and messaging members.
Contract for a unit of asynchronous bot work. Implement Run and the inherited lifecycle and messaging members.
Discover installed bots, inspect the selected bot and observe or control its lifecycle.
Discover installed bots, inspect the selected bot and observe or control its lifecycle.
Contract for an extension that participates in the bot lifecycle. The inherited contracts describe initialization, enablement and cleanup.
Contract for an extension that participates in the bot lifecycle. The inherited contracts describe initialization, enablement and cleanup.
Discover installed plugins and inspect the enabled extensions for the current session.
Discover installed plugins and inspect the enabled extensions for the current session.
The player controlled by the current client. Obtain it through LokiPoe.Me after checking that the client is in game.
The player controlled by the current client. Obtain it through LokiPoe.Me after checking that the client is in game.
Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.
Read an item's identity, rarity, stack and other properties. Use its owning inventory or interface API for item actions.
Work with a specific inventory grid, including selecting and picking up items. Use the local item identifier from that grid.
Work with a specific inventory grid, including selecting and picking up items. Use the local item identifier from that grid.
Query routes and path distances in the current area. Route calculation and issuing movement commands are separate operations.
Query routes and path distances in the current area. Route calculation and issuing movement commands are separate operations.
This is one of the most important class of the Framework, its purpose, is to offer easy to use wrappers members and methods to retrieve informations and interact with the game intefraces.
This is one of the most important class of the Framework, its purpose, is to offer easy to use wrappers members and methods to retrieve informations and interact with the game intefraces.
Represents abyss crack spawner in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss crack spawner in the current game state. Obtain the object from its owning API and refresh it after an area change.
The Abyss pinnacle device that displays and allows taking or returning its reward item.
The Abyss crafting device's item preview and take/return controls.
Represents abyss final node chest in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents abyss final node chest 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.