ff14bot.Objects.Character Class Reference

Base character object. More...

Inheritance diagram for ff14bot.Objects.Character:

Classes
struct	PointStruct

Public Member Functions
bool	HasMyAura (string AuraName)
	Checks if a unit has an aura cast by the player with a name provided in english.
bool	HasMyAura (uint AuraId)
	Checks if a unit has an aura cast by the player with a given id.
bool	HasAura (string AuraName)
	Checks if a unit has an aura with a name provided in english.
bool	HasAura (uint AuraId)
	Checks if a unit has an aura with a given id.
Aura	GetAuraByName (string AuraName)
	Checks if the unit has an aura by english name.
Aura	GetAuraById (uint AuraId)
	Checks if the unit has an aura by id.
Public Member Functions inherited from ff14bot.Objects.GameObject
override string	ToString ()
void	Interact ()
	Attempts to interact with the unit.
bool	InLineOfSight ()
	Checks if the unit is in line-of-sight of the player.
void	Target ()
	Attempts to target the given object.
void	Face ()
	Face this object on all axises.
void	Face2D ()
	Face the players in 2d towards this object.
bool	IsFacing (Vector3 position)
	Checks if the unit is facing the supplied vector.
bool	IsFacing (GameObject gameObject)
	Checks if the unit is facing the passed game object.
bool	IsFacing ()
	Checks if the unit is facing the player.
float	DistanceSqr (Vector3 vector)
	3D Distance Squared
float	DistanceSqr ()
	3D Distance Squared
float	Distance (Vector3 vector)
	3D Distance
float	Distance2D (Vector3 vector)
	2D Distance
float	Distance2D (GameObject gameObject)
	2D Distance
float	Distance (GameObject gameObject)
	3D Distance
float	Distance2D ()
	Distance 2D to the player.
float	Distance ()
	Distance 3D to the player.
bool	SetMark (Mark mark)
	Attempts to set the objects mark or clear it.
Public Member Functions inherited from ff14bot.Objects.RemoteObject
void	UpdatePointer (IntPtr newptr)
	Updates the pointer to a new value and triggers any necessary update mechanisms.

Protected Member Functions
override void	OnUpdatePointer (IntPtr ptr)
	Invoked when the pointer to external memory is updated.
Protected Member Functions inherited from ff14bot.Objects.RemoteObject
	RemoteObject (IntPtr pointer)
	Represents the base class for objects that manage pointers to external memory in the game or application.

Properties
VfxContainer	VfxContainer [get]
	Get the VfxContainer for the given object.
Matrix44	OmenMatrix [get]
	Omen projection matrix used for aoe attacks that display a omen.
Matrix44	AVFX [get]
	Omen projection matrix used for aoe attacks that display a omen.
Matrix44	LockOn [get]
bool	IsCasting [get]
	Checks if the character is currently casting.
SpellCastInfo	SpellCastInfo [get]
	Information about the active spell cast being performed by a character.
uint	CastingSpellId [get]
	ActionId of the currently being cast spell.
Auras	Auras [get]
	Get a list of the active auras on a character.
Auras	CharacterAuras [get]
	Get a list of the active auras on a character.
byte	ClassLevel [get]
	Get the characters level.
ClassJobType	CurrentJob [get]
	Currently active job of a character.
virtual bool	HasTarget [get]
	Checks if the given unit has an active target.
uint	CurrentTargetId [get]
	The ObjectId of the currently targeted unit.
ulong	TaggerObjectId [get]
	Returns the objectId of the player that tagged the target, if the player is in a party it returns the partyId.
byte	TaggerType [get]
	Returns 2 if tagger is in a party, 1 if not, 0 if not yet tagged.
StatusFlags	StatusFlags [get]
	Checks if unit is hostile or incombat.
CharacterStatus	CharacterStatusFlags [get]
	Gets some details about the character, if weapon out, in downed state etc.
bool	IsDying [get]
	Returns true if unit is in a 'downed' state and is unable to be attacked.
bool	InCombat [get]
	Checks if the unit is in combat.
bool	IsAlive [get]
	Check if the unit is currently alive.
bool	IsDead [get]
	Check if the unit is currently dead.
bool	Tapped [get]
	Returns true if target has been tapped.
bool	TappedByOther [get]
	Checks if the given unit has been tagged by another player or another party.
bool	IsNpc [get]
	Check if the unit is a npc or a player.
override uint	CurrentHealth [get]
	Get the current health points.
override uint	MaxHealth [get]
	Get the max health points.
override float	CurrentHealthPercent [get]
	Get the current health percent.
ushort	CurrentTP [get]
ushort	MaxTP [get]
float	CurrentTPPercent [get]
uint	CurrentMana [get]
	Get the current mana points.
uint	MaxMana [get]
	Get the max mana points.
float	CurrentManaPercent [get]
	Get the current mana percent.
ushort	CurrentGP [get]
ushort	MaxGP [get]
float	CurrentGPPercent [get]
ushort	CurrentCP [get]
ushort	MaxCP [get]
float	CurrentCPPercent [get]
override uint	NpcId [get]
Character	TargetCharacter [get]
GameObject	TargetGameObject [get]
Properties inherited from ff14bot.Objects.GameObject
uint	ObjectId [get]
	Gets the ObjectId of the unit. This is value will change between each run of the game and should not be stored.
uint	IdLocation [get]
	Gets the ObjectId id index location.
string	LuaString [get]
	Get the LuaString for the unit.
override bool	IsValid [get]
	Checks if the unit is still inside the object manager.
virtual bool	IsFateGone [get]
	Returns false is target is not a fatemob. Otherwise returns true if mob has fateid and fateid is no longer active.
bool	CanAttack [get]
	Checks if the player can attack the unit.
uint	FateId [get]
	Returns the ID of the fate the object belongs to. returns 0 if no fate associated.
float	CombatReach [get]
	Gets the combatreach for the unit in yalms.
bool	IsBehind [get]
	Checks if the player is currently behind this unit.
bool	IsFlanking [get]
	Checks if the player is currently flanking this unit.
bool	IsMe [get]
	Checks if the GameObject is the player.
float	Heading [get]
	Returns current heading in radians.
GameObject	SummonerGameObject [get]
	Gets the GameObject of the unit who summoned this unit.
uint	SummonerObjectId [get]
	Gets the ObjectId of the unit who summoned this unit.
virtual uint	NpcId [get]
	Gets the NPC Id of the game object, NPC Ids are not unique, and represent.
float	X [get]
	Get the objects X axis.
float	Y [get]
	Get the objects Y axis.
float	Z [get]
	Get the objects Z axis.
virtual Vector3	Location [get]
	Gets the objects location.
bool	IsVisible [get]
	Checks if the unit is currently visible or not.
virtual string	EnglishName [get]
	Gets the english name for the unit.
bool	IsTargetable [get]
	Checks if the unit is able to be targeted.
Mark	Mark [get]
	Get the units mark/sign.
string	Name [get]
	Gets the name of the unit in the games current locale.
virtual uint	CurrentHealth [get]
	Gets the health of the unit.
virtual uint	MaxHealth [get]
	Gets the max health of the unit.
virtual float	CurrentHealthPercent [get]
	Gets the health percent of the unit.
virtual bool	IsWithinInteractRange [get]
	Checks if the player is within range to interact with a given object Tries to be more restrictive so that the server does not reply with out of range.
GameObjectType	Type [get]
	Get the GameObjectType of the object.
Properties inherited from ff14bot.Objects.RemoteObject
virtual bool	IsValid [get]
	Indicates whether the instance is valid and points to a valid reference or object.
IntPtr	VTable [get]
	Gets the virtual function table (VTable) pointer for the remote object.
IntPtr	Pointer [get, set]
	Gets or sets the memory pointer for the associated object or entity.

Additional Inherited Members
Static Public Member Functions inherited from ff14bot.Objects.GameObject
static bool	operator== (GameObject a, GameObject b)
	Checks if two gameobjects reference the same object.
static bool	operator!= (GameObject a, GameObject b)
	Checks if two gameobjects reference different objects.

Detailed Description

Base character object.

Member Function Documentation

GetAuraById()

Aura ff14bot.Objects.Character.GetAuraById

(

uint

AuraId

)

Checks if the unit has an aura by id.

Parameters

AuraId

Returns

aura if it exists, null otherwise

GetAuraByName()

Aura ff14bot.Objects.Character.GetAuraByName

(

string

AuraName

)

Checks if the unit has an aura by english name.

Parameters

AuraName

Returns

aura if it exists, null otherwise

HasAura() [1/2]

bool ff14bot.Objects.Character.HasAura

(

string

AuraName

)

Checks if a unit has an aura with a name provided in english.

Parameters

AuraName

Returns

HasAura() [2/2]

bool ff14bot.Objects.Character.HasAura

(

uint

AuraId

)

Checks if a unit has an aura with a given id.

Parameters

AuraId

Returns

HasMyAura() [1/2]

bool ff14bot.Objects.Character.HasMyAura

(

string

AuraName

)

Checks if a unit has an aura cast by the player with a name provided in english.

Parameters

AuraName

Returns

HasMyAura() [2/2]

bool ff14bot.Objects.Character.HasMyAura

(

uint

AuraId

)

Checks if a unit has an aura cast by the player with a given id.

Parameters

AuraId

Returns

OnUpdatePointer()

override void ff14bot.Objects.Character.OnUpdatePointer ( IntPtr ptr )

protectedvirtual

Invoked when the pointer to external memory is updated.

Parameters

ptr	The new pointer to external memory.

This method is called internally whenever the pointer associated with the instance is updated. Derived classes can override this method to handle specific logic or perform additional actions when the pointer is reassigned or modified.

Reimplemented from ff14bot.Objects.RemoteObject.

Property Documentation

Auras

Auras ff14bot.Objects.Character.Auras

get

Get a list of the active auras on a character.

AVFX

Matrix44 ff14bot.Objects.Character.AVFX

get

Omen projection matrix used for aoe attacks that display a omen.

Summary> Contains the matrix data for the active lockon. Note that the Lockon id is not stored by the client. You'll have to figure out a way to identify a specific lockon on your own. /Summary>

CastingSpellId

uint ff14bot.Objects.Character.CastingSpellId

get

ActionId of the currently being cast spell.

CharacterAuras

Auras ff14bot.Objects.Character.CharacterAuras

get

Get a list of the active auras on a character.

CharacterStatusFlags

CharacterStatus ff14bot.Objects.Character.CharacterStatusFlags

get

Gets some details about the character, if weapon out, in downed state etc.

ClassLevel

byte ff14bot.Objects.Character.ClassLevel

get

Get the characters level.

CurrentCP

ushort ff14bot.Objects.Character.CurrentCP

get

CurrentCPPercent

float ff14bot.Objects.Character.CurrentCPPercent

get

CurrentGP

ushort ff14bot.Objects.Character.CurrentGP

get

CurrentGPPercent

float ff14bot.Objects.Character.CurrentGPPercent

get

CurrentHealth

override uint ff14bot.Objects.Character.CurrentHealth

get

Get the current health points.

CurrentHealthPercent

override float ff14bot.Objects.Character.CurrentHealthPercent

get

Get the current health percent.

CurrentJob

ClassJobType ff14bot.Objects.Character.CurrentJob

get

Currently active job of a character.

CurrentMana

uint ff14bot.Objects.Character.CurrentMana

get

Get the current mana points.

CurrentManaPercent

float ff14bot.Objects.Character.CurrentManaPercent

get

Get the current mana percent.

CurrentTargetId

uint ff14bot.Objects.Character.CurrentTargetId

get

The ObjectId of the currently targeted unit.

CurrentTP

ushort ff14bot.Objects.Character.CurrentTP

get

CurrentTPPercent

float ff14bot.Objects.Character.CurrentTPPercent

get

HasTarget

virtual bool ff14bot.Objects.Character.HasTarget

get

Checks if the given unit has an active target.

InCombat

bool ff14bot.Objects.Character.InCombat

get

Checks if the unit is in combat.

IsAlive

bool ff14bot.Objects.Character.IsAlive

get

Check if the unit is currently alive.

IsCasting

bool ff14bot.Objects.Character.IsCasting

get

Checks if the character is currently casting.

IsDead

bool ff14bot.Objects.Character.IsDead

get

Check if the unit is currently dead.

IsDying

bool ff14bot.Objects.Character.IsDying

get

Returns true if unit is in a 'downed' state and is unable to be attacked.

IsNpc

bool ff14bot.Objects.Character.IsNpc

get

Check if the unit is a npc or a player.

LockOn

Matrix44 ff14bot.Objects.Character.LockOn

get

MaxCP

ushort ff14bot.Objects.Character.MaxCP

get

MaxGP

ushort ff14bot.Objects.Character.MaxGP

get

MaxHealth

override uint ff14bot.Objects.Character.MaxHealth

get

Get the max health points.

MaxMana

uint ff14bot.Objects.Character.MaxMana

get

Get the max mana points.

MaxTP

ushort ff14bot.Objects.Character.MaxTP

get

NpcId

override uint ff14bot.Objects.Character.NpcId

get

OmenMatrix

Matrix44 ff14bot.Objects.Character.OmenMatrix

get

Omen projection matrix used for aoe attacks that display a omen.

SpellCastInfo

SpellCastInfo ff14bot.Objects.Character.SpellCastInfo

get

Information about the active spell cast being performed by a character.

StatusFlags

StatusFlags ff14bot.Objects.Character.StatusFlags

get

Checks if unit is hostile or incombat.

TaggerObjectId

ulong ff14bot.Objects.Character.TaggerObjectId

get

Returns the objectId of the player that tagged the target, if the player is in a party it returns the partyId.

TaggerType

byte ff14bot.Objects.Character.TaggerType

get

Returns 2 if tagger is in a party, 1 if not, 0 if not yet tagged.

Tapped

bool ff14bot.Objects.Character.Tapped

get

Returns true if target has been tapped.

TappedByOther

bool ff14bot.Objects.Character.TappedByOther

get

Checks if the given unit has been tagged by another player or another party.

TargetCharacter

Character ff14bot.Objects.Character.TargetCharacter

get

TargetGameObject

GameObject ff14bot.Objects.Character.TargetGameObject

get

VfxContainer

VfxContainer ff14bot.Objects.Character.VfxContainer

get

Get the VfxContainer for the given object.