ff14bot.Objects.HousingObject Class Reference

Game object for most housing objects. More...

Inheritance diagram for ff14bot.Objects.HousingObject:

Properties
override uint	NpcId [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
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.
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.RemoteObject
	RemoteObject (IntPtr pointer)
	Represents the base class for objects that manage pointers to external memory in the game or application.
virtual void	OnUpdatePointer (IntPtr ptr)
	Invoked when the pointer to external memory is updated.

Detailed Description

Game object for most housing objects.

Property Documentation

NpcId

override uint ff14bot.Objects.HousingObject.NpcId

get