Local player object. More...

Inheritance diagram for ff14bot.Objects.LocalPlayer:

Public Member Functions
float	GetDesynthesisLevel (ClassJobType job)
	Gets the Desynthesis level for the provided job.
void	SetFacing (float rotation)
	Sets the players rotation.
void	Face (Vector3 position)
	Face the player twoards the given vector.
void	Face (GameObject gameObject)
	Face the player to the passed gameobject.
void	ClearTarget ()
	Clears the Active target.
Public Member Functions inherited from ff14bot.Objects.Character
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.

Properties
override bool	IsValid `[get]`
	Checks if the player object is valid.
BattleCharacter	Pet `[get]`
	Gets the players currently active battle pet.
bool	DesynthesisUnlocked `[get]`
	Checks if the player has unlocked Desynthesis.
bool	AetherialReductionUnlocked `[get]`
	Checks if the player has unlocked Aetherial Reduction.
GrandCompany	GrandCompany `[get]`
	Gets the active GrandCompany
AetheryteResult	HomePoint `[get]`
	Gets the aetheryte the player will return to.
override bool	HasTarget `[get]`
	Checks if the player currently has a target.
new Character	Mount `[get]`
	Notimplemented.
bool	IsLevelSynced `[get]`
	Checks if the player is currently level synced.
Stats	Stats `[get]`
	Stat array.
Dictionary< ClassJobType, ushort >	Levels `[get]`
	Dictionary of current levels for localplayers classes.
IntPtr	PrimaryTargetPtr `[get]`
	Gets the IntPtr of the currently targeted unit.
uint	CurrentTargetObjId `[get]`
	Object id of the current target, 0 if no target.
GameObject	CurrentTarget `[get]`
	Currently targeted GameObject
Properties inherited from ff14bot.Objects.BattleCharacter
override uint	NpcId `[get]`
bool	IsFate `[get]`
	Check if the unit is considered part of a fate.
bool	IsMounted `[get]`
	Check if the unit is currently mounted.
Character	Mount `[get]`
	Get the units mount object.
PlayerIcon	Icon `[get]`
	Get the icon next to the players name.
byte	RawDifficulty `[get]`
	Gets the raw icon value used to declare how difficult a mob is.
DifficultyEstimate	DifficultyEstimate `[get]`
	Gets a basic description of how difficult a mob is, based off the icon type.
bool	IsDOW `[get]`
	Checks if the unit is a disciple of war / disciple of magic.
bool	IsDOL `[get]`
	Checks if the unit is a disciple of the land.
bool	IsDOH `[get]`
	Checks if the unit is a disciple of the hand.
int	ElementalLevel `[get]`
	Return the ElementalLevel for a unit.
EurekaElement	Element `[get]`
	Return the EurekaElement for a unit.
override string	EnglishName `[get]`
Properties inherited from ff14bot.Objects.Character
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.
Protected Member Functions inherited from ff14bot.Objects.Character
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.

Detailed Description

Local player object.

Member Function Documentation

◆ ClearTarget()

void ff14bot.Objects.LocalPlayer.ClearTarget ( )

Clears the Active target.

◆ Face() [1/2]

void ff14bot.Objects.LocalPlayer.Face ( GameObject gameObject )

Face the player to the passed gameobject.

Parameters

gameObject

◆ Face() [2/2]

void ff14bot.Objects.LocalPlayer.Face ( Vector3 position )

Face the player twoards the given vector.

Parameters

position

◆ GetDesynthesisLevel()

float ff14bot.Objects.LocalPlayer.GetDesynthesisLevel ( ClassJobType job )

Gets the Desynthesis level for the provided job.

Parameters

job

Returns

◆ SetFacing()

void ff14bot.Objects.LocalPlayer.SetFacing ( float rotation )

Sets the players rotation.

Parameters

rotation in radians

Property Documentation

◆ AetherialReductionUnlocked

bool ff14bot.Objects.LocalPlayer.AetherialReductionUnlocked

get

Checks if the player has unlocked Aetherial Reduction.

◆ CurrentTarget

GameObject ff14bot.Objects.LocalPlayer.CurrentTarget

get

Currently targeted GameObject

◆ CurrentTargetObjId

uint ff14bot.Objects.LocalPlayer.CurrentTargetObjId

get

Object id of the current target, 0 if no target.

◆ DesynthesisUnlocked

bool ff14bot.Objects.LocalPlayer.DesynthesisUnlocked

get

Checks if the player has unlocked Desynthesis.

◆ GrandCompany

GrandCompany ff14bot.Objects.LocalPlayer.GrandCompany

get

Gets the active GrandCompany

◆ HasTarget

override bool ff14bot.Objects.LocalPlayer.HasTarget

get

Checks if the player currently has a target.

◆ HomePoint

AetheryteResult ff14bot.Objects.LocalPlayer.HomePoint

get

Gets the aetheryte the player will return to.

◆ IsLevelSynced

bool ff14bot.Objects.LocalPlayer.IsLevelSynced

get

Checks if the player is currently level synced.

◆ IsValid

override bool ff14bot.Objects.LocalPlayer.IsValid

get

Checks if the player object is valid.

◆ Levels

Dictionary<ClassJobType, ushort> ff14bot.Objects.LocalPlayer.Levels

get

Dictionary of current levels for localplayers classes.

◆ Mount

new Character ff14bot.Objects.LocalPlayer.Mount

get

Notimplemented.

◆ Pet

BattleCharacter ff14bot.Objects.LocalPlayer.Pet

get

Gets the players currently active battle pet.

◆ PrimaryTargetPtr

IntPtr ff14bot.Objects.LocalPlayer.PrimaryTargetPtr

get

Gets the IntPtr of the currently targeted unit.

◆ Stats

Stats ff14bot.Objects.LocalPlayer.Stats

get

Stat array.

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearTarget()

◆ Face() [1/2]

◆ Face() [2/2]

◆ GetDesynthesisLevel()

◆ SetFacing()

Property Documentation

◆ AetherialReductionUnlocked

◆ CurrentTarget

◆ CurrentTargetObjId

◆ DesynthesisUnlocked

◆ GrandCompany

◆ HasTarget

◆ HomePoint

◆ IsLevelSynced

◆ IsValid

◆ Levels

◆ Mount

◆ Pet

◆ PrimaryTargetPtr

◆ Stats