DPB2Class · Game state and actions

LokiPoe.ClientFunctions

This is a convenient class to perform various action on the game client, and retrieve informations.

Namespace: DreamPoeBot.Loki.Game

public static class LokiPoe.ClientFunctions
Reference: DPB2 0.4.5.103Compare the DPB1 reference → Check signatures and usage notes separately; a matching type is not a compatibility guarantee.

Members and overloads

11 declared here

DisableRender

MethodLink ↗
public static void LokiPoe.ClientFunctions.DisableRender()

Desable the game rendering.

Return type: voidNo return value.

EnableRender

MethodLink ↗
public static void LokiPoe.ClientFunctions.EnableRender()

Enable the game rendering.

Return type: voidNo return value.

GetBackgroundFps

MethodLink ↗
public static int LokiPoe.ClientFunctions.GetBackgroundFps()

Get the current Backgroud FPS setted.

Return type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Returns: The int result.

GetHeightAt

MethodLink ↗
public static float LokiPoe.ClientFunctions.GetHeightAt(int x, int y)

Returns the current area's terrain height at grid coordinates, including cell zero.

Return type: floatNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

x
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies x.

y
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies y.

Returns: The float result.

DPB2 0.4.5.91 rejects invalid terrain coordinates with ArgumentOutOfRangeException and unavailable or changed-area terrain with InvalidOperationException. For coordinate conversions this applies when checkZ is true. Abort the pending action on failure; do not catch and continue with a click or key press. Discard saved targets when changing areas and reacquire them before a later attempt.

MousePosToScreenPos2

MethodLink ↗
public static Vector2i LokiPoe.ClientFunctions.MousePosToScreenPos2(Vector2i pos)

Internal method used for debugging purpose.

Return type: Vector2i
Explore Vector2i → members & methods

A two-dimensional integer position. Used by grid-position and pathfinding APIs; screen-position APIs may expect a different coordinate type.

Parameters

pos

Specifies pos.

Returns: The Vector2i result.

SetBackgroundFps

MethodLink ↗
public static void LokiPoe.ClientFunctions.SetBackgroundFps(int fps, bool force = false)

Set the current Backgroud FPS.

Return type: voidNo return value.

Parameters

fps
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

The desired FPS.

force
Parameter type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

If `IsBackgroundFpsActive` this set is ignored, unless you set this option to true.

UpdateQuestState

MethodLink ↗
public static DatQuestStateWrapper LokiPoe.ClientFunctions.UpdateQuestState(DatQuestWrapper quest)

Updates quest state using the supplied arguments.

Return type: DatQuestStateWrapper
Explore DatQuestStateWrapper → members & methods

Game-data record for quest state. Use its identifiers and properties to look up game definitions.

Parameters

quest
Parameter type: DatQuestWrapper

Specifies quest.

Returns: The DatQuestStateWrapper result.

UpdateQuestState

MethodLink ↗
public static DatQuestStateWrapper LokiPoe.ClientFunctions.UpdateQuestState(string questId)

Updates quest state using the supplied arguments.

Return type: DatQuestStateWrapper
Explore DatQuestStateWrapper → members & methods

Game-data record for quest state. Use its identifiers and properties to look up game definitions.

Parameters

questId
Parameter type: stringNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies quest id.

Returns: The DatQuestStateWrapper result.

WorldToScreen

MethodLink ↗
public static void LokiPoe.ClientFunctions.WorldToScreen(Vector3 position, out int cx, out int cy)

Convert World coordinates to screen coordinates based on the actual camera settings.

Return type: voidNo return value.

Parameters

position

Specifies position.

cx
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives cx.

cy
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives cy.

WorldToScreen

MethodLink ↗
public static void LokiPoe.ClientFunctions.WorldToScreen(float x, float y, float z, out int cx, out int cy)

Convert World coordinates to screen coordinates based on the actual camera settings.

Return type: voidNo return value.

Parameters

x
Parameter type: floatNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies x.

y
Parameter type: floatNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies y.

z
Parameter type: floatNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Specifies z.

cx
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives cx.

cy
Parameter type: intNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

Receives cy.

IsRenderEnabled

PropertyLink ↗
public static bool LokiPoe.ClientFunctions.IsRenderEnabled { get; }

Return true if the game Rendering is Enabled.

Value type: boolNo current DPB page is linked for this built-in, external, generic or compatibility-only type.

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.