Class represents an grid slot within a bag Using this class outside a framelock is not supported as the values are not cached. More...

Inheritance diagram for ff14bot.Managers.BagSlot:

Public Member Functions
void	Handover ()
	Tries to hand over the item in the given slot to the currently active npc.
bool	CanUse (GameObject target=null)
	Checks if we can use the provided item.
bool	UseItem (GameObject target=null)
	Attempts to use the item.
bool	UseItem (Vector3 location)
	Attempts to use the item.
bool	Move (BagSlot destination)
	Attempts to move the contents of the current bagslot to the destination.
override string	ToString ()
	Returns a string representation of the bag slot, including the item name and raw item ID.
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]`
	Gets a value indicating whether the current object is valid. This property determines if the corresponding memory reference or data associated with the object is still accurate and usable within the context of the game's framelock or memory structure.
virtual uint	Count `[get]`
	Represents the quantity of items in the current bag slot.
virtual uint	RawItemId `[get]`
	This returns the raw unmodified id of the item in the slot.
uint	TrueItemId `[get]`
	This returns the ID of the item in the slot, modified if it is a HQ item or collectable.
ActionType	ActionType `[get]`
	Gets the associated ActionType of the current BagSlot item. This property determines whether the item is classified as a general item, key item, or any other predefined action type, based on its TrueItemId value.
virtual InventoryBagId	BagId `[get]`
	Gets the bag identifier associated with the current inventory slot. This property represents the specific inventory bag or storage location that the item resides in, such as a player's main inventory, a retainer's storage, or an armory chest.
virtual ushort	Slot `[get]`
	Gets the slot index of the item within its corresponding inventory bag. This property identifies the specific position of the item in the inventory structure, which is used for various inventory management operations such as moving, using, or interacting with the item.
virtual byte	HqFlag `[get]`
	Gets the high-quality flag associated with the bag slot item. This property determines specific attributes of the item, such as whether it is high-quality or collectable, based on its flag state.
bool	IsSellable `[get]`
	Checks if the slot contains an item that isn't collectable and has a value > 0.
bool	IsReducable `[get]`
	This returns true if the item can be reduced, but does not check if the player has the correct skills, use 'CanReduce' for that.
bool	IsDesynthesizable `[get]`
	This returns true if the item can be desynthesized, but does not check if the player has the correct skill level.
bool	CanReduce `[get]`
	Returns true if the item is reduaceable and the player has the correct skill level.
bool	CanDesynthesize `[get]`
	Returns true if the item is desynthesizable and the player has the correct skill level This does not check if the item has a greater than 0 percent chance to be desynthesized.
long	Value `[get]`
	Return the slots item value.
virtual float	Condition `[get]`
	Returns the slots condition.
virtual uint	Collectability `[get]`
	Returns the slots collectability.
virtual float	SpiritBond `[get]`
	Returns the slots spiritbond percentage.
bool	IsFilled `[get]`
	Does the current slot contain a item.
bool	IsHighQuality `[get]`
	Does the slot contain a high quality item.
bool	IsCollectable `[get]`
	Does the slot contain a collectable item.
Item	Item `[get]`
	Get the item data of the slot.
string	EnglishName `[get]`
	Get the english name of an item.
string	Name `[get]`
	Get the localized name of an item.
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
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

Class represents an grid slot within a bag Using this class outside a framelock is not supported as the values are not cached.

Member Function Documentation

◆ CanUse()

bool ff14bot.Managers.BagSlot.CanUse ( GameObject target = null )

Checks if we can use the provided item.

Parameters

target Gameobject to check. If null then we follow the games default item logic.

Returns

◆ Handover()

void ff14bot.Managers.BagSlot.Handover ( )

Tries to hand over the item in the given slot to the currently active npc.

◆ Move()

bool ff14bot.Managers.BagSlot.Move ( BagSlot destination )

Attempts to move the contents of the current bagslot to the destination.

Parameters

destination Where to move

Returns: True if succeded, false otherwise

◆ ToString()

override string ff14bot.Managers.BagSlot.ToString ( )

Returns a string representation of the bag slot, including the item name and raw item ID.

Returns: A string that represents the current bag slot.

◆ UseItem() [1/2]

bool ff14bot.Managers.BagSlot.UseItem ( GameObject target = null )

Attempts to use the item.

Parameters

target Gameobject to use item on. If null then we follow the games default item logic.

Returns

◆ UseItem() [2/2]

bool ff14bot.Managers.BagSlot.UseItem ( Vector3 location )

Attempts to use the item.

Parameters

target location to use item on.

Returns

Property Documentation

◆ ActionType

ActionType ff14bot.Managers.BagSlot.ActionType

get

Gets the associated ActionType of the current BagSlot item. This property determines whether the item is classified as a general item, key item, or any other predefined action type, based on its TrueItemId value.

◆ BagId

virtual InventoryBagId ff14bot.Managers.BagSlot.BagId

get

Gets the bag identifier associated with the current inventory slot. This property represents the specific inventory bag or storage location that the item resides in, such as a player's main inventory, a retainer's storage, or an armory chest.

◆ CanDesynthesize

bool ff14bot.Managers.BagSlot.CanDesynthesize

get

Returns true if the item is desynthesizable and the player has the correct skill level This does not check if the item has a greater than 0 percent chance to be desynthesized.

◆ CanReduce

bool ff14bot.Managers.BagSlot.CanReduce

get

Returns true if the item is reduaceable and the player has the correct skill level.

◆ Collectability

virtual uint ff14bot.Managers.BagSlot.Collectability

get

Returns the slots collectability.

◆ Condition

virtual float ff14bot.Managers.BagSlot.Condition

get

Returns the slots condition.

◆ Count

virtual uint ff14bot.Managers.BagSlot.Count

get

Represents the quantity of items in the current bag slot.

◆ EnglishName

string ff14bot.Managers.BagSlot.EnglishName

get

Get the english name of an item.

◆ HqFlag

virtual byte ff14bot.Managers.BagSlot.HqFlag

get

Gets the high-quality flag associated with the bag slot item. This property determines specific attributes of the item, such as whether it is high-quality or collectable, based on its flag state.

◆ IsCollectable

bool ff14bot.Managers.BagSlot.IsCollectable

get

Does the slot contain a collectable item.

◆ IsDesynthesizable

bool ff14bot.Managers.BagSlot.IsDesynthesizable

get

This returns true if the item can be desynthesized, but does not check if the player has the correct skill level.

◆ IsFilled

bool ff14bot.Managers.BagSlot.IsFilled

get

Does the current slot contain a item.

◆ IsHighQuality

bool ff14bot.Managers.BagSlot.IsHighQuality

get

Does the slot contain a high quality item.

◆ IsReducable

bool ff14bot.Managers.BagSlot.IsReducable

get

This returns true if the item can be reduced, but does not check if the player has the correct skills, use 'CanReduce' for that.

◆ IsSellable

bool ff14bot.Managers.BagSlot.IsSellable

get

Checks if the slot contains an item that isn't collectable and has a value > 0.

◆ IsValid

override bool ff14bot.Managers.BagSlot.IsValid

get

Gets a value indicating whether the current object is valid. This property determines if the corresponding memory reference or data associated with the object is still accurate and usable within the context of the game's framelock or memory structure.

◆ Item

Item ff14bot.Managers.BagSlot.Item

get

Get the item data of the slot.

◆ Name

string ff14bot.Managers.BagSlot.Name

get

Get the localized name of an item.

◆ RawItemId

virtual uint ff14bot.Managers.BagSlot.RawItemId

get

This returns the raw unmodified id of the item in the slot.

◆ Slot

virtual ushort ff14bot.Managers.BagSlot.Slot

get

Gets the slot index of the item within its corresponding inventory bag. This property identifies the specific position of the item in the inventory structure, which is used for various inventory management operations such as moving, using, or interacting with the item.

◆ SpiritBond

virtual float ff14bot.Managers.BagSlot.SpiritBond

get

Returns the slots spiritbond percentage.

◆ TrueItemId

uint ff14bot.Managers.BagSlot.TrueItemId

get

This returns the ID of the item in the slot, modified if it is a HQ item or collectable.

◆ Value

long ff14bot.Managers.BagSlot.Value

get

Return the slots item value.

probably inaccurate

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CanUse()

◆ Handover()

◆ Move()

◆ ToString()

◆ UseItem() [1/2]

◆ UseItem() [2/2]

Property Documentation

◆ ActionType

◆ BagId

◆ CanDesynthesize

◆ CanReduce

◆ Collectability

◆ Condition

◆ Count

◆ EnglishName

◆ HqFlag

◆ IsCollectable

◆ IsDesynthesizable

◆ IsFilled

◆ IsHighQuality

◆ IsReducable

◆ IsSellable

◆ IsValid

◆ Item

◆ Name

◆ RawItemId

◆ Slot

◆ SpiritBond

◆ TrueItemId

◆ Value