FrameworkZ::Inventories Class Reference

The Inventories module for FrameworkZ. Defines and interacts with INVENTORY object. More...

Public Member Functions
void	GetInventoryByID (id)
void	GetItemByUniqueID (inventoryID, uniqueID)
void	GetItemCountByID (inventoryID, uniqueID)
integer	Initialize (id, object)
	Initialize an inventory.
table	New (username, type, id)
	Create a new inventory object.
table	Rebuild (isoPlayer, inventory, items)
	Recursively traverses the inventory table for missing data while referencing the item definitions to rebuild the inventory.

Data Fields
FrameworkZ Inventories	__index
	Character
	Container
FrameworkZ	Inventories
FrameworkZ Inventories	List
FrameworkZ Inventories	Types
	Vehicle

Detailed Description

The Inventories module for FrameworkZ. Defines and interacts with INVENTORY object.

Definition at line 15 of file Inventories.lua.

Member Function Documentation

GetInventoryByID()

void GetInventoryByID

(

id

)

GetItemByUniqueID()

void GetItemByUniqueID	(	inventoryID	,
		uniqueID	)

GetItemCountByID()

void GetItemCountByID	(	inventoryID	,
		uniqueID	)

Initialize()

integer Initialize	(	id	,
		object	)

Initialize an inventory.

Parameters

id	table The inventory's id.
object	table The inventory's object.

Returns

integer The inventory's ID.

New()

table New	(	username	,
		type	,
		id	)

Create a new inventory object.

Parameters

username	string The owner's username. Can be nil for no owner.
type	string The type of inventory. Can be nil, but creates a character inventory type by default. Refer to FrameworkZ.Inventories.Types table for available types.
id	string The inventory's ID. Can be nil for an auto generated ID (recommended).

Returns

table The new inventory object.

Rebuild()

table Rebuild	(	isoPlayer	,
		inventory	,
		items	)

Recursively traverses the inventory table for missing data while referencing the item definitions to rebuild the inventory.

Parameters

inventory

table The inventory to rebuild.

Returns

table The rebuilt inventory.

Field Documentation

__index

FrameworkZ Inventories __index

Definition at line 17 of file Inventories.lua.

Character

FrameworkZ::Inventories::Character

Definition at line 23 of file Inventories.lua.

Container

FrameworkZ::Inventories::Container

Definition at line 25 of file Inventories.lua.

Inventories

FrameworkZ Inventories

Definition at line 29 of file Inventories.lua.

List

FrameworkZ Inventories List

Definition at line 19 of file Inventories.lua.

Types

FrameworkZ Inventories Types

Definition at line 21 of file Inventories.lua.

Vehicle

FrameworkZ::Inventories::Vehicle

Definition at line 27 of file Inventories.lua.

---

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

• Inventories.lua