DPB1Class · 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: DPB1 0.3.29.56Compare the DPB2 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

34 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.

HasAtlasPassive

MethodLink ↗
public bool LocalPlayer.HasAtlasPassive(string value)

Checks for atlas 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.

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 int LocalPlayer.AscendencySkillPointsAvailable { get; }

Reads ascendency 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.

AtlasPassivePointsAvailable

PropertyLink ↗
public int LocalPlayer.AtlasPassivePointsAvailable { get; }

Reads atlas passive 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.

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.

PartyStatus

PropertyLink ↗
public PartyStatus LocalPlayer.PartyStatus { get; }

Reads party status on LocalPlayer as PartyStatus. Open the value type below for its members and accepted values.

Value type: PartyStatus
Explore PartyStatus → members & methods

Named values for party status. Select a value when an API accepts or returns PartyStatus.

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<ushort> LocalPlayer.SkillBarIds { get; }

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

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

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 bool Actor.IsUsingStibniteFlask { get; } Declared by Actor

Whether this actor is using stibnite flask.

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

Whether this actor is using sulphur flask.

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

Whether this actor is using topaz flask.

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

Whether this network object is valid.

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

Reads left hand weapon visual on Actor as string. The exact type and accessors are shown below.

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

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

public int Player.Level { get; } Declared by Player

Reads level on Player as int. The exact type and accessors are shown below.

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

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

public float Actor.ManaPercent { get; } Declared by Actor

Return the Actual pct of mana available, accounting for all the reserved mana (fixed and pct). (please note, if you have 50% of mana ManaReservedPercent, and a total of 1000 mana, this will return 100.0 when you are full mana, and decrease as you cast more spells.)

public float Actor.ManaPercentTotal { get; } Declared by Actor

Return the actual pct of mana available (please note, if you have 50% of mana ManaReservedPercent, and a total of 1000 mana, this will return 500 when you are full mana, and decrease as you cast more spells.)

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

This Return the total ammount of mana Reserved by spells that reserve a fixed account of mana, es. Clarity.

public float Actor.ManaReservedPercent { get; } Declared by Actor

This return the total pct of mana reserved by spells that reserve a percent of mana, es, Puroty of Elements.

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

Reads max health on Actor as int. The exact type and accessors are shown below.

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

Reads max mana on Actor as int. The exact type and accessors are shown below.

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

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

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

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

public Dictionary<StatTypeGGG, int> Actor.ModStats { get; } Declared by Actor

Gets the mod stats collection. Its element types are linked below.

public List<string> Actor.ModStatsList { get; } Declared by Actor

Gets the mod stats list collection. Its element types are linked below.

public virtual string NetworkObject.Name { get; } Declared by NetworkObject

Reads name on NetworkObject as string. The exact type and accessors are shown below.

public NetworkObject.NetworkObject(EntityWrapper entity) Declared by NetworkObject

Creates a new NetworkObject instance using the supplied arguments.

public static bool NetworkObject.operator ==(NetworkObject left, NetworkObject right) Declared by NetworkObject

Applies the equality operation to the supplied values.

public static NetworkObject.implicit operator EntityWrapper(NetworkObject @object) Declared by NetworkObject

Converts this value to the return type shown in the signature.

public static bool NetworkObject.operator !=(NetworkObject left, NetworkObject right) Declared by NetworkObject

Applies the inequality operation to the supplied values.

public PantheonGod Player.PantheonMajor { get; } Declared by Player

Reads pantheon major on Player as PantheonGod. Open the value type below for its members and accepted values.

public PantheonGod Player.PantheonMinor { get; } Declared by Player

Reads pantheon minor on Player as PantheonGod. Open the value type below for its members and accepted values.

public Player.Player(Entity player) Declared by Player

Creates a new Player instance using the supplied arguments.

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

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

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

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

public List<Prophecy> Player.Prophecies { get; } Declared by Player

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

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

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

DPB1 0.3.29.56 · 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.