INVENTORY Class Reference

Inventory class for FrameworkZ. More...

Public Member Functions
void	AddItem (item)
	Add an item to the inventory.
void	AddItems (uniqueID, quantity)
	Add multiple items to the inventory.
void	GetItemByID (uniqueID)
void	GetItemCountByID (uniqueID)
void	GetItems ()
string	GetName ()
	Get the inventory's name.
string	Initialize ()
	Initialize an inventory.

Data Fields
INVENTORY	__index

Detailed Description

Inventory class for FrameworkZ.

Definition at line 15 of file Inventories.lua.

Member Function Documentation

AddItem()

void AddItem

(

item

)

Add an item to the inventory.

Note: This does not add a world item, it simply adds it to the inventory's object. Please use CHARACTER::GiveItem(uniqueID) to add an item to a character's inventory along with the world item.

Parameters

item	string The item's ID.

See also

CHARACTER::GiveItem(uniqueID)

AddItems()

void AddItems	(	uniqueID	,
		quantity	)

Add multiple items to the inventory.

Note: This does not add a world item, it simply adds it to the inventory's object. Please use CHARACTER::GiveItems(uniqueID) to add an items to a character's inventory along with the world item.

Parameters

uniqueID	string The item's ID.
quantity	integer The quantity of the item to add.

See also

CHARACTER::GiveItems(uniqueID)

GetItemByID()

void GetItemByID

(

uniqueID

)

GetItemCountByID()

void GetItemCountByID

(

uniqueID

)

GetItems()

void GetItems

(

)

GetName()

string GetName

(

)

Get the inventory's name.

Returns

string The inventory's name.

Initialize()

string Initialize

(

)

Initialize an inventory.

Returns

string The inventory's ID.

Field Documentation

__index

INVENTORY __index

Definition at line 17 of file Inventories.lua.

---

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

• Inventories.lua