DPB2Class · Game state and actions

Entity

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

Namespace: DreamPoeBot.Loki

public class Entity
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

18 declared here

Entity

MethodLink ↗
public Entity.Entity()

Creates a new Entity instance.

ClearSharedCaches

MethodLink ↗
public static void Entity.ClearSharedCaches()

Clears layouts shared between entities. Call this whenever DreamPoeBot detaches from the game process or attaches to a new PathOfExile process.

Return type: voidNo return value.

GetComponent

MethodLink ↗
public T Entity.GetComponent<T>() where T : Component, new()

Returns component.

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

Returns: The T result.

GetEffectManager

MethodLink ↗
public long Entity.GetEffectManager(short id)

Calls GetEffectManager on Entity with id and returns long. Open the return contract below before using the result.

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

Parameters

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

Specifies id.

Returns: The long result.

HasComponent

MethodLink ↗
public bool Entity.HasComponent<T>() where T : Component, new()

Checks for component.

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

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

ToString

MethodLink ↗
public override string Entity.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.

TryGetComponent

MethodLink ↗
public bool Entity.TryGetComponent<T>(out T component) where T : Component, new()

Calls TryGetComponent on Entity with component and returns bool. Open the return contract below before using the result.

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

Parameters

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

Receives component.

Returns: True when the request succeeds; read any out parameters only after checking the result.

BuildComponentIndices

PropertyLink ↗
public Dictionary<string, long> Entity.BuildComponentIndices { get; }

Preserves the original public API. Unlike ComponentIndices, this property always builds a new snapshot.

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

ComponentIndices

PropertyLink ↗
public Dictionary<string, long> Entity.ComponentIndices { get; }

Gets the component indices collection. Its element types are linked below.

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

Id

PropertyLink ↗
public int Entity.Id { get; }

Reads id on Entity 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.

IsValid

PropertyLink ↗
public override bool Entity.IsValid { get; }

Whether this entity is valid.

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

Metadata

PropertyLink ↗
public string Entity.Metadata { get; }

Reads metadata on Entity 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.

Name

PropertyLink ↗
public string Entity.Name { get; }

Reads name on Entity 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.

Reaction

PropertyLink ↗
public byte Entity.Reaction { get; }

Reads reaction on Entity as byte. The exact type and accessors are shown below.

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

Rotation

PropertyLink ↗
public float Entity.Rotation { get; }

Reads rotation on Entity as float. The exact type and accessors are shown below.

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

Type

PropertyLink ↗
public string Entity.Type { get; }

Reads type on Entity 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.

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.