FrameworkZ API - INVENTORY

Home / INVENTORY Class

INVENTORY

class

Inventory class for FrameworkZ.

0
Functions
10
Methods
1
Fields

📋 On This Page

Fields

1
INVENTORY 📋 table
Inventory class for FrameworkZ.
Initial value: {}

Methods

10

INVENTORY:AddItem(item)

method
Add an item to the inventory.

Parameters

item 📝 string
The item's ID.

🔗 See Also

  • CHARACTER::GiveItem(uniqueID)

INVENTORY:AddItems(uniqueID, quantity)

method
Add multiple items to the inventory.

Parameters

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

🔗 See Also

  • CHARACTER::GiveItems(uniqueID)

INVENTORY:GetItemByUniqueID(uniqueID)

method
Get an item by its unique ID.

Parameters

uniqueID 📝 string
The item's unique ID.

Returns

📋 table | ✅ boolean
The item object or false if not found.
📝 string
Error message if not found.

INVENTORY:GetItemCountByID(uniqueID)

method
Get the count of items with a specific unique ID.

Parameters

uniqueID 📝 string
The item's unique ID.

Returns

🔢 integer
The count of matching items.

INVENTORY:GetItems()

method
Get all items in the inventory.

Returns

📋 table
The items table.

INVENTORY:GetName()

method
Get the inventory's name.

Returns

📝 string
The inventory's name.

INVENTORY:GetSaveableData()

method
Get filtered saveable data for the inventory.

Returns

📋 table
The processed saveable data.

INVENTORY:Initialize()

method
Initialize an inventory.

Returns

📝 string
The inventory's ID.

INVENTORY:RemoveItem(item)

method
Remove an item from the inventory.

Parameters

item 📋 table
The item object to remove.

Returns

✅ boolean
\string True if successful and a message.

INVENTORY:Save()

method
Save the inventory to character data

Returns

📋 table
The complete inventory data including equipment