Interface IObjectTable

This collection represents the currently spawned FFXIV game objects.

Assembly: Dalamud.dll

Declaration

public interface IObjectTable : IDalamudService, IEnumerable<IGameObject>, IEnumerable

Properties

Address

Gets the address of the object table.

Declaration

nint Address { get; }

Length

Gets the length of the object table.

Declaration

int Length { get; }

LocalPlayer

Gets the local player character, if one is present.

Declaration

IPlayerCharacter? LocalPlayer { get; }

PlayerObjects

Gets an enumerator for accessing player objects. This will only contain BattleChara objects. Does not contain any mounts, minions, or accessories.

Declaration

IEnumerable<IBattleChara> PlayerObjects { get; }

CharacterManagerObjects

Gets an enumerator for accessing character manager objects. Contains all objects in indexes [0, 199]. Includes mounts, minions, accessories, and players.

Declaration

IEnumerable<IGameObject> CharacterManagerObjects { get; }

ClientObjects

Gets an enumerator for accessing client objects. Contains all objects in indexes [200, 448].

Declaration

IEnumerable<IGameObject> ClientObjects { get; }

EventObjects

Gets an enumerator for accessing event objects. Contains all objects in indexes [449, 488].

Declaration

IEnumerable<IGameObject> EventObjects { get; }

StandObjects

Gets an enumerator for accessing stand objects. Contains all objects in indexes [489, 628].

Declaration

IEnumerable<IGameObject> StandObjects { get; }

ReactionEventObjects

Gets an enumerator for accessing reaction event objects. Contains all objects in indexes [629, 728].

Declaration

IEnumerable<IGameObject> ReactionEventObjects { get; }

this[int]

Get an object at the specified spawn index.

Declaration

IGameObject? this[int index] { get; }

Methods

SearchById(ulong)

Search for a game object by their Object ID.

Declaration

IGameObject? SearchById(ulong gameObjectId)

Returns

Dalamud.Game.ClientState.Objects.Types.IGameObject: A game object or null.

Parameters

Type	Name	Description
System.UInt64	gameObjectId	Object ID to find.

SearchByEntityId(uint)

Search for a game object by the Entity ID.

Declaration

IGameObject? SearchByEntityId(uint entityId)

Returns

Dalamud.Game.ClientState.Objects.Types.IGameObject: A game object or null.

Parameters

Type	Name	Description
System.UInt32	entityId	Entity ID to find.

GetObjectAddress(int)

Gets the address of the game object at the specified index of the object table.

Declaration

nint GetObjectAddress(int index)

Returns

System.IntPtr: The memory address of the object.

Parameters

Type	Name	Description
System.Int32	index	The index of the object.

CreateObjectReference(nint)

Create a reference to an FFXIV game object.

Declaration

IGameObject? CreateObjectReference(nint address)

Returns

Dalamud.Game.ClientState.Objects.Types.IGameObject: Dalamud.Game.ClientState.Objects.Types.GameObject object or inheritor containing the requested data.

Parameters

Type	Name	Description
System.IntPtr	address	The address of the object in memory.