public static EventHandler<GuiTickEventArgs> LokiPoe.OnGuiTick
an event fired at every Gui Tick.
EventHandler<GuiTickEventArgs>Information supplied when the gui tick event is raised.
Start here to check the client state, access the local player and identify the current area. Read in-game data only after checking IsInGame.
Namespace: DreamPoeBot.Loki.Game
public static class LokiPoeClass usage example: Check the client before reading →
public static EventHandler<GuiTickEventArgs> LokiPoe.OnGuiTick
an event fired at every Gui Tick.
EventHandler<GuiTickEventArgs>Information supplied when the gui tick event is raised.
public static LokiPoe.PasteTextFailedEvent LokiPoe.OnPasteTextFailed
Raised for on paste text failed. Subscribe with the callback type shown in the signature.
staticNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static readonly Stopwatch LokiPoe.ApplicationRuntime
Return a StopWatch representing the current application runtime.
StopwatchNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static readonly Random LokiPoe.Random
Return a global Random number generator class
RandomNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static Dictionary<string, StatTypeGGG> LokiPoe.StringStatTypeGGG
Return a dictionary containing all the StatTypeGGG contained in the game data file.
Dictionary<string, StatTypeGGG>Named values for stat type ggg. Select a value when an API accepts or returns StatTypeGGG.
public static void LokiPoe.BeginDispatchIfNecessary(Dispatcher dispatcher, Action action)
Utility to Dispatcher.BeginInvoke Actions only if necessary using a specific Dispatcher.
voidNo return value.dispatcherDispatcherNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies dispatcher.
actionActionNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies action.
public static void LokiPoe.BeginDispatchIfNecessary(Action action)
Utility to Dispatcher.BeginInvoke Actions only if necessary.
voidNo return value.actionActionNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies action.
public static void LokiPoe.DispatchIfNecessary(Dispatcher dispatcher, Action action)
Utility to Dispatcher.Invoke Actions only if necessary using a specific Dispatcher.
voidNo return value.dispatcherDispatcherNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies dispatcher.
actionActionNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies action.
public static void LokiPoe.DispatchIfNecessary(Action action)
Utility to Dispatcher.Invoke Actions only if necessary.
voidNo return value.actionActionNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies action.
public static string LokiPoe.GetDescriptionFromStatTypeGGG(StatTypeGGG stat)
Calls GetDescriptionFromStatTypeGGG on LokiPoe with stat and returns string. Open the return contract below before using the result.
stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.statStatTypeGGGSpecifies stat.
Returns: The string result.
public static Element LokiPoe.GetElement<Element>(long address) where Element : RemoteMemoryObject, new()
Calls GetElement on LokiPoe with address and returns Element. Open the return contract below before using the result.
ElementNo current DPB page is linked for this built-in, external, generic or compatibility-only type.addresslongNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies address.
Returns: The Element result.
public static List<Element> LokiPoe.GetGuiElements()
Return a List of Elements that rapresent the entire game Gui.
List<Element>A game-interface element. Inspect text, visibility, geometry and child elements; follow the individual members for their signatures and result types. Prefer a named panel wrapper when one is available.
Returns: The List<Element> result.
public static void LokiPoe.InvokeEvent(Delegate d, params object[] args)
EventsInvoker.
voidNo return value.dDelegateNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies d.
argsobject[]No current DPB page is linked for this built-in, external, generic or compatibility-only type.Specifies args.
public static bool LokiPoe.MatchesSocketColors(string filterFormat, SocketColor[] itemSocketColors, byte[] itemSocketLinks)
Return a bool representing if a conbination of SocketColors and SoocketLinks array, contain a specific sockets patterns.
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.filterFormatstringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.A specific socket pattern that we are looking for: "R-G-B", "G-G R-B"
itemSocketColorsSocketColor[]An array of SocketColor representing the colors in the item.
itemSocketLinksbyte[]No current DPB page is linked for this built-in, external, generic or compatibility-only type.An array of byte representing the Links in the item.
Returns: A Boolean result. The member description explains the condition being checked.
public static bool LokiPoe.MatchesSocketLayout(Item item, string filterFormat)
Return a bool representing if a specific Item contain a specific sockets patterns. Ex "B W-B-B".
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.itemItemThe item that will be checked.
filterFormatstringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.A specific socket pattern that we are looking for: "R-G-B", "G-G R-B"
Returns: A Boolean result. The member description explains the condition being checked.
public static void LokiPoe.ScrapUI()
Calls ScrapUI on LokiPoe without arguments. This overload has no return value.
voidNo return value.public static void LokiPoe.SignalPasteTextFailed()
Calls SignalPasteTextFailed on LokiPoe without arguments. This overload has no return value.
voidNo return value.public static Window LokiPoe.BotWindow { get; internal set; }
Return a Window object representing this application main window.
WindowNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static LokiPoe.PoeVersion LokiPoe.ClientVersion { get; internal set; }
Game client Type of the selected instance of the game, only the Official Type is supported. ///
staticNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static DatWorldAreaWrapper LokiPoe.CurrentWorldArea { get; }
Return a DatWorldAreaWrapper object, representing the current world area.
DatWorldAreaWrapperGame-data record for world area. Use its identifiers and properties to look up game definitions.
public static bool LokiPoe.Initialized { get; set; }
Return a bool indicating the this application finished the initialization stag.
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static bool LokiPoe.IsBotFullyLoaded { get; internal set; }
Return a bool indicatinf if this application has finished the loading stage and is ready to be used.
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static bool LokiPoe.IsInCharacterSelectionScreen { get; }
Return a bool indicating if we are in the Character Selection Screen.
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static bool LokiPoe.IsInCreateCharacterScreen { get; }
Return a bool indicating if we are in the Create Character Screen.
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static bool LokiPoe.IsInGame { get; }
Return a bool indicating if we are in game and ready to accept commands.
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.Public DPB2 0.4.5.92 fixes a startup initialization failure in 0.4.5.91 that could prevent this property and other game-data APIs from working. Update and restart the client if affected. The public signature is unchanged; continue checking IsInGame before reading game objects.
public static bool LokiPoe.IsInLoginScreen { get; }
Return a bool indicating if we are in the Login Screen.
boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static LocalPlayer LokiPoe.Me { get; }
Return a LocalPlayer object representing the Playing character.
LocalPlayerThe player controlled by the current client. Obtain it through LokiPoe.Me after checking that the client is in game.
public static float LokiPoe.MyCharacterSize { get; }
Return a float representing the Playing character size.
floatNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static int LokiPoe.MyId { get; }
Return the Playing character Id.
intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.public static Vector2i LokiPoe.MyPosition { get; }
Return a Vector2i representing the Playing character position.
Vector2iA two-dimensional integer position. Used by grid-position and pathfinding APIs; screen-position APIs may expect a different coordinate type.
These examples demonstrate the class, not every member listed above. Each example links the declarations it teaches.
using System;
using System.Linq;
using DreamPoeBot.Loki.Game;
using DreamPoeBot.Loki.Game.Objects;
using DreamPoeBot.Loki.Bot;
using DreamPoeBot.Loki.Bot.Pathfinding;
using DreamPoeBot.Loki.Common;if (!LokiPoe.IsInGame || LokiPoe.Me == null)
return;
var player = LokiPoe.Me;
var area = LokiPoe.CurrentWorldArea;Run this guard in the bot workflow before reading character or area data.
See how these APIs fit together. Labs include complete source; the FollowBot walkthrough teaches you to build your own bot from selected fragments and checkpoints.
DPB2 0.4.5.103 · Reference reviewed 2026-10-30. Descriptions use source summaries where available, otherwise concise signature-based descriptions. Examples illustrate usage; they are not a live-game test.