ffxivlib.FFXIVLIB Class Reference

Public Member Functions
Chatlog	GetChatlog ()
	This function instantiates a Chatlog object More...
Player	GetCompanionInfo ()
Entity	GetEntityById (int id)
	This function build an Entity object according to the position in the Entity array You may effectively loop by yourself on this function. More...
Entity	GetEntityInfo (int id)
	Deprecated, use getEntityById More...
IEnumerable< Entity >	GetEntityByName (string name)
	This function attempts to retrieve a list of Entity by its name in the Entity array This is potentially a costly call as we build a complete list to look for the Entity. This doesn't include Gathering nodes at the moment. To be fixed. More...
IEnumerable< Entity >	GetEntityByType (TYPE type)
	Retrieves a list of Entity corresponding to the given TYPE Needs to be refactored. More...
	FFXIVLIB (int pid=0)
	Instantiates a FFXIVLIB instance. PID is optionnal but required if multiple FFXIV process are running. More...
List< Inventory.ITEM >	GetSelfInventory ()
	This returns your inventory, extra inventory (gil, crystals, tomes, seals), key items, calamity salvager and currently equipped items More...
List< Inventory.ITEM >	GetCurrentEquipment ()
	This returns your currently equipped items. See EQUIP_POS enum. More...
List< Inventory.ITEM >	GetRetainerInventory ()
	This returns your retainer inventory, extra inventory (gil, crystals) and what is up for sale. This only works while checking a retainer. More...
List< Inventory.ITEM >	GetArmoryChest ()
	This returns your whole Armory Chest. More...
List< Inventory.ITEM >	GetCompanyInventory ()
	This returns your Free Company inventory, extra inventory (currency, crystals) This only works while checking the Free Company chest. More...
byte[]	ReadMemory (IntPtr pointer, uint count)
MovementHelper	GetMovementHelper (SendKeyInput.VKKeys leftKey=SendKeyInput.VKKeys.KEY_A, SendKeyInput.VKKeys rightKey=SendKeyInput.VKKeys.KEY_D, SendKeyInput.VKKeys forwardKey=SendKeyInput.VKKeys.KEY_W)
	Returns a MovementHelper instance ready for work. More...
PartyMember	GetPartyMemberInfo (int id)
	Deprecated, use getPartyMemberById More...
PartyMember	GetPartyMemberById (int id)
	This function retrieves a PartyMember by its id in the PartyMember array The result might be empty, there is no sanity check at the time More...
string	GetServerName ()
	TL;DR : Returns current server, testing, might not work reliably. Longer version : This is set by the Lobby widgets, which no longer exist while in-game, as such the memory space they used can be under some condition garbage collected/wiped. More...
Player	GetPlayerInfo ()
	This function retrieves the current Player info More...
void	SendKey (IntPtr key, bool keyup=true, int delay=100)
	This function sends a keystroke to the Final Fantasy XIV window More...
IntPtr	GetSigScan (byte[] signature)
	Finds address of specified signature This hasnt been tested in a long time More...
Target	GetTargets ()
	This function retrieves the target array More...
Entity	GetPreviousTarget ()
	This function retrieves the previous target More...
Entity	GetMouseoverTarget ()
	This function retrieves the current Mouseover target More...
Entity	GetCurrentTarget ()
	This function retrieves the current target More...
Entity	GetFocusTarget ()
	This function retrieves the focus target More...

Constructor & Destructor Documentation

ffxivlib.FFXIVLIB.FFXIVLIB

(

int

pid = 0

)

Instantiates a FFXIVLIB instance. PID is optionnal but required if multiple FFXIV process are running.

Parameters

pid	FFXIV PID (optionnal)

Member Function Documentation

List<Inventory.ITEM> ffxivlib.FFXIVLIB.GetArmoryChest

(

)

This returns your whole Armory Chest.

Returns

List of items

Chatlog ffxivlib.FFXIVLIB.GetChatlog

(

)

This function instantiates a Chatlog object

Returns

Chatlog instance

List<Inventory.ITEM> ffxivlib.FFXIVLIB.GetCompanyInventory

(

)

This returns your Free Company inventory, extra inventory (currency, crystals) This only works while checking the Free Company chest.

Returns

List of items

List<Inventory.ITEM> ffxivlib.FFXIVLIB.GetCurrentEquipment

(

)

This returns your currently equipped items. See EQUIP_POS enum.

Returns

List of items

Entity ffxivlib.FFXIVLIB.GetCurrentTarget

(

)

This function retrieves the current target

Returns

Entity object or null

Entity ffxivlib.FFXIVLIB.GetEntityById

(

int

id

)

This function build an Entity object according to the position in the Entity array You may effectively loop by yourself on this function.

Parameters

id	Position in the Entity Array, use Constants.ENTITY_ARRAY_SIZE as your max (exclusive)

Returns

Entity object or null

Exceptions

System.IndexOutOfRangeException

Out of range

IEnumerable<Entity> ffxivlib.FFXIVLIB.GetEntityByName

(

string

name

)

This function attempts to retrieve a list of Entity by its name in the Entity array This is potentially a costly call as we build a complete list to look for the Entity. This doesn't include Gathering nodes at the moment. To be fixed.

Parameters

name	Name of the Entity to be retrieved

Returns

Enumerable list of Entity object or

IEnumerable<Entity> ffxivlib.FFXIVLIB.GetEntityByType

(

TYPE

type

)

Retrieves a list of Entity corresponding to the given TYPE Needs to be refactored.

Parameters

type	Type of entity

Returns

Enumerable list of Entity objects

Entity ffxivlib.FFXIVLIB.GetEntityInfo

(

int

id

)

Deprecated, use getEntityById

Parameters

id

Returns

Entity ffxivlib.FFXIVLIB.GetFocusTarget

(

)

This function retrieves the focus target

Returns

Entity object or null

Entity ffxivlib.FFXIVLIB.GetMouseoverTarget

(

)

This function retrieves the current Mouseover target

Returns

Entity object or null

MovementHelper ffxivlib.FFXIVLIB.GetMovementHelper	(	SendKeyInput.VKKeys	leftKey = SendKeyInput.VKKeys.KEY_A,
		SendKeyInput.VKKeys	rightKey = SendKeyInput.VKKeys.KEY_D,
		SendKeyInput.VKKeys	forwardKey = SendKeyInput.VKKeys.KEY_W
	)

Returns a MovementHelper instance ready for work.

Parameters

leftKey	Left key (default: A)
rightKey	Right key (default: D)
forwardKey	Forward key (default: W)

Returns

MovementHelper instance

PartyMember ffxivlib.FFXIVLIB.GetPartyMemberById

(

int

id

)

This function retrieves a PartyMember by its id in the PartyMember array The result might be empty, there is no sanity check at the time

Parameters

id	Position in the PartyMember Array, use Constants.PARTY_MEMBER_ARRAY_SIZE as your max (exclusive)

Returns

PartyMember object

Exceptions

System.IndexOutOfRangeException

Out of range

PartyMember ffxivlib.FFXIVLIB.GetPartyMemberInfo

(

int

id

)

Deprecated, use getPartyMemberById

Parameters

id

Returns

Player ffxivlib.FFXIVLIB.GetPlayerInfo

(

)

This function retrieves the current Player info

Returns

Player object

Entity ffxivlib.FFXIVLIB.GetPreviousTarget

(

)

This function retrieves the previous target

Returns

Entity object or null

List<Inventory.ITEM> ffxivlib.FFXIVLIB.GetRetainerInventory

(

)

This returns your retainer inventory, extra inventory (gil, crystals) and what is up for sale. This only works while checking a retainer.

Returns

List of items

List<Inventory.ITEM> ffxivlib.FFXIVLIB.GetSelfInventory

(

)

This returns your inventory, extra inventory (gil, crystals, tomes, seals), key items, calamity salvager and currently equipped items

Returns

List of items

string ffxivlib.FFXIVLIB.GetServerName

(

)

TL;DR : Returns current server, testing, might not work reliably. Longer version : This is set by the Lobby widgets, which no longer exist while in-game, as such the memory space they used can be under some condition garbage collected/wiped.

Returns

IntPtr ffxivlib.FFXIVLIB.GetSigScan

(

byte[]

signature

)

Finds address of specified signature This hasnt been tested in a long time

Parameters

signature

Signature to look for

Returns

IntPtr of address found or IntPtr.Zero

Target ffxivlib.FFXIVLIB.GetTargets

(

)

This function retrieves the target array

Returns

Target object

void ffxivlib.FFXIVLIB.SendKey	(	IntPtr	key,
		bool	keyup = true,
		int	delay = 100
	)

This function sends a keystroke to the Final Fantasy XIV window

Parameters

key	Key to press (see Virtual Key Codes for information)
keyup	Should we keyup after keydown (default: true)
delay	(Optional) Delay between keypress down and keypress up

---

The documentation for this class was generated from the following files:

• Chatlog.cs
• FFXIVLIB.cs
• Companion.cs
• Entity.cs
• Inventory.cs
• MemoryReader.cs
• MovementHelper.cs
• PartyMember.cs
• Player.cs
• SendKeyInput.cs
• SigScanner.cs
• Target.cs