DPB2Class · World, character and items

LocalPlayer

The player controlled by the current client. Obtain it through LokiPoe.Me after checking that the client is in game.

Namespace: DreamPoeBot.Loki.Game.Objects

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

Use this API

Useful members available through base types — open a member to read its exact contract:

Members and overloads

30 declared here

Search includes inherited members below. 256 matching inherited members →

FromActionKey

MethodLink ↗
public Skill LocalPlayer.FromActionKey(ActionKeys key)

Calls FromActionKey on LocalPlayer with key and returns Skill. Open the return contract below before using the result.

Return type: Skill
Explore Skill → members & methods

Inspect an available skill, its readiness and related properties. Check the appropriate skill-bar action before attempting to use it.

Parameters

key

Specifies key.

Returns: The Skill result.

FromKey

MethodLink ↗
public Skill LocalPlayer.FromKey(Keys key)

Calls FromKey on LocalPlayer with key and returns Skill. Open the return contract below before using the result.

Return type: Skill
Explore Skill → members & methods

Inspect an available skill, its readiness and related properties. Check the appropriate skill-bar action before attempting to use it.

Parameters

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

Specifies key.

Returns: The Skill result.

FromKeyCombo

MethodLink ↗
public Skill LocalPlayer.FromKeyCombo(LokiPoe.Input.KeysCombo key)

Calls FromKeyCombo on LocalPlayer with key and returns Skill. Open the return contract below before using the result.

Return type: Skill
Explore Skill → members & methods

Inspect an available skill, its readiness and related properties. Check the appropriate skill-bar action before attempting to use it.

Parameters

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

Specifies key.

Returns: The Skill result.

GetKeyComboForSkill

MethodLink ↗
public LokiPoe.Input.KeysCombo LocalPlayer.GetKeyComboForSkill(Skill skill)

Calls GetKeyComboForSkill on LocalPlayer with skill and returns LokiPoe.Input.KeysCombo. Open the return contract below before using the result.

Return type: LokiPoe.Input.KeysCombo
Explore LokiPoe.Input.KeysCombo → members & methods

Provides keys combo data and the operations listed below. Related types link to the values this API consumes or returns.

Parameters

skill

Specifies skill.

Returns: The KeysCombo result.

GetKeyForSkill

MethodLink ↗
public Keys LocalPlayer.GetKeyForSkill(Skill skill)

Calls GetKeyForSkill on LocalPlayer with skill and returns Keys. Open the return contract below before using the result.

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

Parameters

skill

Specifies skill.

Returns: The Keys result.

GetKeysComboForSkill

MethodLink ↗
public IEnumerable<LokiPoe.Input.KeysCombo> LocalPlayer.GetKeysComboForSkill(Skill skill)

Calls GetKeysComboForSkill on LocalPlayer with skill and returns IEnumerable<LokiPoe.Input.KeysCombo>. Open the return contract below before using the result.

Return type: IEnumerable<LokiPoe.Input.KeysCombo>
Explore LokiPoe.Input.KeysCombo → members & methods

Provides keys combo data and the operations listed below. Related types link to the values this API consumes or returns.

Parameters

skill

Specifies skill.

Returns: The IEnumerable<KeysCombo> result.

GetKeysForSkill

MethodLink ↗
public IEnumerable<Keys> LocalPlayer.GetKeysForSkill(Skill skill)

Calls GetKeysForSkill on LocalPlayer with skill and returns IEnumerable<Keys>. Open the return contract below before using the result.

Return type: IEnumerable<Keys>No current DPB page is linked for this built-in, external, generic or compatibility-only type.

Parameters

skill

Specifies skill.

Returns: The IEnumerable<Keys> result.

GetSpirit

MethodLink ↗
public SpiritData LocalPlayer.GetSpirit(int weaponSet)

Spirit budget for a one-based weapon set (1..3), independent of the selected set. A zero total does not indicate whether that set is unlocked. Invalid reads throw.

Return type: SpiritData
Explore SpiritData → members & methods

A read-only snapshot of the player's Spirit budget for one weapon set.

Parameters

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

Specifies weapon set.

Returns: The SpiritData result.

HasPassive

MethodLink ↗
public bool LocalPlayer.HasPassive(string value)

Checks for passive using the supplied arguments.

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

Parameters

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

Specifies value.

Returns: A Boolean result. The member description explains the condition being checked.

HasSkillOnBarByName

MethodLink ↗
public bool LocalPlayer.HasSkillOnBarByName(string name)

Checks for skill on bar by name using the supplied arguments.

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

Parameters

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

Specifies name.

Returns: A Boolean result. The member description explains the condition being checked.

ToString

MethodLink ↗
public override string LocalPlayer.ToString()

Returns a text representation of this value.

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

Returns: The string result.

AscendencySkillPointsAvailable

PropertyLink ↗
public uint LocalPlayer.AscendencySkillPointsAvailable { get; }

Reads ascendency skill points available on LocalPlayer as uint. The exact type and accessors are shown below.

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

BestiaryNetVariation

PropertyLink ↗
public int LocalPlayer.BestiaryNetVariation { get; }

Reads bestiary net variation on LocalPlayer as int. The exact type and accessors are shown below.

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

IsInCorruptedArea

PropertyLink ↗
public bool LocalPlayer.IsInCorruptedArea { get; }

Whether this local player is in corrupted area.

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

IsInHideout

PropertyLink ↗
public bool LocalPlayer.IsInHideout { get; }

Whether this local player is in hideout.

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

IsInMapRoom

PropertyLink ↗
public bool LocalPlayer.IsInMapRoom { get; }

Whether this local player is in map room.

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

IsInOverworld

PropertyLink ↗
public bool LocalPlayer.IsInOverworld { get; }

Whether this local player is in overworld.

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

IsInTown

PropertyLink ↗
public bool LocalPlayer.IsInTown { get; }

Whether this local player is in town.

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

League

PropertyLink ↗
public string LocalPlayer.League { get; }

Reads league on LocalPlayer as string. The exact type and accessors are shown below.

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

NumberOfDeployedBrand

PropertyLink ↗
public int LocalPlayer.NumberOfDeployedBrand { get; }

Reads number of deployed brand on LocalPlayer as int. The exact type and accessors are shown below.

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

PassiveSkillPointsAvailable

PropertyLink ↗
public int LocalPlayer.PassiveSkillPointsAvailable { get; }

Reads passive skill points available on LocalPlayer as int. The exact type and accessors are shown below.

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

SkillBarIds

PropertyLink ↗
public List<uint> LocalPlayer.SkillBarIds { get; }

Gets the skill bar ids collection. Its element types are linked below.

Value type: List<uint>No current DPB page is linked for this built-in, external, generic or compatibility-only type.

TotalCursesAllowed

PropertyLink ↗
public int LocalPlayer.TotalCursesAllowed { get; }

Reads total curses allowed on LocalPlayer as int. The exact type and accessors are shown below.

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

TownPortal

PropertyLink ↗
public Portal LocalPlayer.TownPortal { get; }

Reads town portal on LocalPlayer as Portal. Open the value type below for its members and accepted values.

Value type: Portal
Explore Portal → members & methods

Represents portal in the current game state. Obtain the object from its owning API and refresh it after an area change.

Inherited members and contracts

256 public members from documented base types and interfaces. Links open the original declaration; overrides are shown only once. Search using the member field above.

public ActorFlags Actor.ActorFlags { get; } Declared by Actor

Reads actor flags on Actor as ActorFlags. Open the value type below for its members and accepted values.

public NetworkObject NetworkObject.AnimatedProperties { get; } Declared by NetworkObject

Reads animated properties on NetworkObject as NetworkObject. Open the value type below for its members and accepted values.

public string NetworkObject.AnimatedPropertiesMetadata { get; } Declared by NetworkObject

Reads animated properties metadata on NetworkObject as string. The exact type and accessors are shown below.

public bool NetworkObject.ArchnemesisIsTrapped { get; } Declared by NetworkObject

Reads archnemesis is trapped on NetworkObject as bool. The exact type and accessors are shown below.

public AscendancyClass Player.AscendencyClass { get; } Declared by Player

Reads ascendency class on Player as AscendancyClass. Open the value type below for its members and accepted values.

public List<Aura> Actor.Auras { get; } Declared by Actor

Gets the auras collection. Its element types are linked below.

public IEnumerable<Skill> Actor.AvailableSkills { get; } Declared by Actor

Gets the available skills collection. Its element types are linked below.

public bool NetworkObject.BaseHashChanged { get; } Declared by NetworkObject

Reads base hash changed on NetworkObject as bool. The exact type and accessors are shown below.

public string Actor.BeltVisual { get; } Declared by Actor

Reads belt visual on Actor as string. The exact type and accessors are shown below.

public int Actor.BladeFlurryCharges { get; } Declared by Actor

Reads blade flurry charges on Actor as int. The exact type and accessors are shown below.

public int Actor.BladeVortexCharges { get; } Declared by Actor

Reads blade vortex charges on Actor as int. The exact type and accessors are shown below.

public string Actor.BootsVisual { get; } Declared by Actor

Reads boots visual on Actor as string. The exact type and accessors are shown below.

public int NetworkObject.CharacterSize { get; } Declared by NetworkObject

Current object extent in grid cells, or zero if Positioned is absent. Uses Positioned's frame cache; visual scaling does not define this size.

public string Actor.ChestVisual { get; } Declared by Actor

Reads chest visual on Actor as string. The exact type and accessors are shown below.

public CharacterClass Player.Class { get; } Declared by Player

Reads class on Player as CharacterClass. Open the value type below for its members and accepted values.

public bool NetworkObject.ClickUi() Declared by NetworkObject

Clicks the centre of this object's main world-label UI once.

public EntityComponentInformation NetworkObject.Components { get; } Declared by NetworkObject

Reads components on NetworkObject as EntityComponentInformation. Open the value type below for its members and accepted values.

public bool Actor.CorpseUsable { get; } Declared by Actor

Reads corpse usable on Actor as bool. The exact type and accessors are shown below.

public Actor.ActionWrapper Actor.CurrentAction { get; } Declared by Actor

Return a class that describe the current skill in use, or null if no action are in place, this does not include movement.

public Actor.ActionWrapper Actor.CurrentMoveAction { get; } Declared by Actor

Return a class that describe the current Move skill, or null if no action are in place.

public int Actor.CurseCount { get; } Declared by Actor

Reads curse count on Actor as int. The exact type and accessors are shown below.

public List<NetworkObject> Actor.DeployedMines { get; } Declared by Actor

Gets the deployed mines collection. Its element types are linked below.

public List<NetworkObject> Actor.DeployedMinions { get; } Declared by Actor

Gets the deployed minions collection. Its element types are linked below.

public IEnumerable<NetworkObject> Actor.DeployedObjects { get; } Declared by Actor

Gets the deployed objects collection. Its element types are linked below.

public List<NetworkObject> Actor.DeployedTotems { get; } Declared by Actor

Gets the deployed totems collection. Its element types are linked below.

public List<NetworkObject> Actor.DeployedTraps { get; } Declared by Actor

Gets the deployed traps collection. Its element types are linked below.

public float NetworkObject.Distance { get; } Declared by NetworkObject

Reads distance on NetworkObject as float. The exact type and accessors are shown below.

public float NetworkObject.DistanceSqr { get; } Declared by NetworkObject

Reads distance sqr on NetworkObject as float. The exact type and accessors are shown below.

public string NetworkObject.Dump() Declared by NetworkObject

Explicit diagnostic read; never enumerates arbitrary getters or follows object graphs.

public Aura Actor.EnduranceChargeAura { get; } Declared by Actor

Reads endurance charge aura on Actor as Aura. Open the value type below for its members and accepted values.

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.