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

Whether aspect spider buff is present.

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

Whether atziris promise is present.

public bool Actor.HasAura(IEnumerable<string> names) Declared by Actor

Checks for aura using the supplied arguments.

public bool Actor.HasAura(string name) Declared by Actor

Checks for aura using the supplied arguments.

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

Whether blood of the karui is present.

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

Whether blood rage buff is present.

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

Whether bone offering is present.

public bool Actor.HasBuff(BuffDefinitionsEnum @enum) Declared by Actor

Checks for buff using the supplied arguments.

public bool Actor.HasBuff(string aura) Declared by Actor

Checks for buff using the supplied arguments.

public bool Actor.HasBuffFromOther(BuffDefinitionsEnum @enum) Declared by Actor

Checks for buff from other using the supplied arguments.

public bool Actor.HasBuffFromSelf(BuffDefinitionsEnum @enum) Declared by Actor

Checks for buff from self using the supplied arguments.

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

Whether clarity buff is present.

public bool Actor.HasConsideredAuraFrom(ActiveSkillsEnum @enum) Declared by Actor

Checks for considered aura from using the supplied arguments.

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

Whether contagion is present.

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

Whether current action is present.

public bool Actor.HasCurseFrom(ActiveSkillsEnum @enum) Declared by Actor

Checks for curse from using the supplied arguments.

public bool Actor.HasCurseFrom(string skillName) Declared by Actor

Checks for curse from using the supplied arguments.

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

Whether divination distillate is present.

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

Whether endurance charge is present.

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

Return true if Npc for currency exchange of shop, has floating icon indicating a complete sell.

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

Whether flesh offering is present.

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

Whether frenzy charge is present.

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

Whether gluttony of elements buff is present.

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

Whether herald of agony buff is present.

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

Whether herald of ash buff is present.

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

Whether herald of ice buff is present.

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

Whether herald of purity buff is present.

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

Whether herald of thunder buff is present.

public bool Player.HasHideout { get; } Declared by Player

Whether hideout is present.

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

Whether hull is present.

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.