Skip to main content

Class GameObject

This class represents a GameObject in FFXIV.

Assembly: Dalamud.dll
View Source
Declaration
public class GameObject : IEquatable<GameObject>

Derived:
Dalamud.Game.ClientState.Objects.SubKinds.EventObj, Dalamud.Game.ClientState.Objects.Types.Character

Implements:
System.IEquatable<Dalamud.Game.ClientState.Objects.Types.GameObject>

Properties

Address

Gets the address of the game object in memory.

View Source
Declaration
public nint Address { get; }

Name

Gets the name of this Dalamud.Game.ClientState.Objects.Types.GameObject.

View Source
Declaration
public SeString Name { get; }

ObjectId

Gets the object ID of this Dalamud.Game.ClientState.Objects.Types.GameObject.

View Source
Declaration
public uint ObjectId { get; }

DataId

Gets the data ID for linking to other respective game data.

View Source
Declaration
public uint DataId { get; }

OwnerId

Gets the ID of this GameObject's owner.

View Source
Declaration
public uint OwnerId { get; }

ObjectIndex

Gets the index of this object in the object table.

View Source
Declaration
public ushort ObjectIndex { get; }

ObjectKind

Gets the entity kind of this Dalamud.Game.ClientState.Objects.Types.GameObject. See Dalamud.Game.ClientState.Objects.Types.GameObject.ObjectKind?text=the+ObjectKind+enum for possible values.

View Source
Declaration
public ObjectKind ObjectKind { get; }

SubKind

Gets the sub kind of this Actor.

View Source
Declaration
public byte SubKind { get; }

YalmDistanceX

Gets the X distance from the local player in yalms.

View Source
Declaration
public byte YalmDistanceX { get; }

YalmDistanceZ

Gets the Y distance from the local player in yalms.

View Source
Declaration
public byte YalmDistanceZ { get; }

IsDead

Gets a value indicating whether the object is dead or alive.

View Source
Declaration
public bool IsDead { get; }

IsTargetable

Gets a value indicating whether the object is targetable.

View Source
Declaration
public bool IsTargetable { get; }

Position

Gets the position of this Dalamud.Game.ClientState.Objects.Types.GameObject.

View Source
Declaration
public Vector3 Position { get; }

Rotation

Gets the rotation of this Dalamud.Game.ClientState.Objects.Types.GameObject. This ranges from -pi to pi radians.

View Source
Declaration
public float Rotation { get; }

HitboxRadius

Gets the hitbox radius of this Dalamud.Game.ClientState.Objects.Types.GameObject.

View Source
Declaration
public float HitboxRadius { get; }

TargetObjectId

Gets the current target of the game object.

View Source
Declaration
public virtual ulong TargetObjectId { get; }

TargetObject

Gets the target object of the game object.

View Source
Declaration
public virtual GameObject? TargetObject { get; }

Struct

Gets the underlying structure.

View Source
Declaration
protected GameObject* Struct { get; }

Fields

InvalidGameObjectId

IDs of non-networked GameObjects.

View Source
Declaration
public const uint InvalidGameObjectId = 3758096384

Methods

IsValid(GameObject?)

Gets a value indicating whether this actor is still valid in memory.

View Source
Declaration
public static bool IsValid(GameObject? actor)
Returns

System.Boolean: True or false.

Parameters
TypeNameDescription
Dalamud.Game.ClientState.Objects.Types.GameObjectactorThe actor to check.

IsValid()

Gets a value indicating whether this actor is still valid in memory.

View Source
Declaration
public bool IsValid()
Returns

System.Boolean: True or false.### Equals(object) Determines whether the specified object is equal to the current object.

View Source
Declaration
public override bool Equals(object obj)
Returns

System.Boolean: true if the specified object is equal to the current object; otherwise, false.

Parameters
TypeNameDescription
System.ObjectobjThe object to compare with the current object.

GetHashCode()

Serves as the default hash function.

View Source
Declaration
public override int GetHashCode()
Returns

System.Int32: A hash code for the current object.### ToString() Returns a string that represents the current object.

View Source
Declaration
public override string ToString()
Returns

System.String: A string that represents the current object.

Implements

  • System.IEquatable<Dalamud.Game.ClientState.Objects.Types.GameObject>