Skip to main content

Interface IObjectTable

This collection represents the currently spawned FFXIV game objects.

Assembly: Dalamud.dll
View Source
Declaration
public interface IObjectTable : IEnumerable<IGameObject>, IEnumerable

Properties

Address

Gets the address of the object table.

View Source
Declaration
nint Address { get; }

Length

Gets the length of the object table.

View Source
Declaration
int Length { get; }

PlayerObjects

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

View Source
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.

View Source
Declaration
IEnumerable<IGameObject> CharacterManagerObjects { get; }

ClientObjects

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

View Source
Declaration
IEnumerable<IGameObject> ClientObjects { get; }

EventObjects

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

View Source
Declaration
IEnumerable<IGameObject> EventObjects { get; }

StandObjects

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

View Source
Declaration
IEnumerable<IGameObject> StandObjects { get; }

ReactionEventObjects

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

View Source
Declaration
IEnumerable<IGameObject> ReactionEventObjects { get; }

this[int]

Get an object at the specified spawn index.

View Source
Declaration
IGameObject? this[int index] { get; }

Methods

SearchById(ulong)

Search for a game object by their Object ID.

View Source
Declaration
IGameObject? SearchById(ulong gameObjectId)
Returns

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

Parameters
TypeNameDescription
System.UInt64gameObjectIdObject ID to find.

SearchByEntityId(uint)

Search for a game object by the Entity ID.

View Source
Declaration
IGameObject? SearchByEntityId(uint entityId)
Returns

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

Parameters
TypeNameDescription
System.UInt32entityIdEntity ID to find.

GetObjectAddress(int)

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

View Source
Declaration
nint GetObjectAddress(int index)
Returns

System.IntPtr: The memory address of the object.

Parameters
TypeNameDescription
System.Int32indexThe index of the object.

CreateObjectReference(nint)

Create a reference to an FFXIV game object.

View Source
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
TypeNameDescription
System.IntPtraddressThe address of the object in memory.