FrameworkZ API Documentation - FrameworkZ.Items

Home / FrameworkZ.Items Module

FrameworkZ.Items

module

Items module for FrameworkZ. Defines and interacts with ITEM \object.

0
Functions
18
Methods
2
Fields

📋 On This Page

Fields

2
FrameworkZ.Items 📋 table
Items module for FrameworkZ. Defines and interacts with ITEM \object.
Initial value: {}
FrameworkZ.Items.InstanceMap 📋 table
An instance map. Contains references to item instances indexed by an item's unique ID and instance ID as a string for optimized lookups. Instance Map is structured as follows: [uniqueID][username][#index] = instance
Initial value: {}

Methods

18

FrameworkZ.Items:AddInstance(item, isoPlayer, worldItem, callback)

method undocumented
No documentation available

Parameters (inferred)

item ❓ unknown
Parameter inferred from function signature
isoPlayer ❓ unknown
Parameter inferred from function signature
worldItem ❓ unknown
Parameter inferred from function signature
callback ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Items:CreateItem(uniqueID, isoPlayer, callback)

method
Creates an item instance and links it to a world item.

Parameters

uniqueID 📝 string
The unique ID of the item to create.
isoPlayer 📦 object
The ISO Player to create the item for.
callback ⚡ function
(Optional) A callback function to execute after the item is created but before OnInstanced is called.

Returns

✅ boolean
\string \object \object Success status and message, also the item instance and world item.

FrameworkZ.Items:CreateWorldItem(isoPlayer, fullItemID)

method undocumented
No documentation available

Parameters (inferred)

isoPlayer ❓ unknown
Parameter inferred from function signature
fullItemID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Items:FindFirstInstanceByID(owner, uniqueID)

method undocumented
No documentation available

Parameters (inferred)

owner ❓ unknown
Parameter inferred from function signature
uniqueID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:GetInstance(instanceID)

method undocumented
No documentation available

Parameters (inferred)

instanceID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:GetItemByUniqueID(uniqueID)

method undocumented
No documentation available

Parameters (inferred)

uniqueID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:GetStoredData(worldItem)

method undocumented
No documentation available

Parameters (inferred)

worldItem ❓ unknown
Parameter inferred from function signature

Returns (inferred)

❓ unknown
Return type inferred from function name pattern

FrameworkZ.Items:Initialize(data)

method undocumented
No documentation available

Parameters (inferred)

data ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern

FrameworkZ.Items:LinkWorldItemToInstanceData(worldItem, instanceData)

method undocumented
No documentation available

Parameters (inferred)

worldItem ❓ unknown
Parameter inferred from function signature
instanceData ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:New(uniqueID, itemID, isBase)

method undocumented
No documentation available

Parameters (inferred)

uniqueID ❓ unknown
Parameter inferred from function signature
itemID ❓ unknown
Parameter inferred from function signature
isBase ❓ unknown
Parameter inferred from function signature

Returns (inferred)

📦 object
Return type inferred from function name pattern

FrameworkZ.Items:OnDropItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnEquipItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnExamineItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnFillInventoryObjectContextMenu(player, context, items)

method undocumented
No documentation available

Parameters (inferred)

player ❓ unknown
Parameter inferred from function signature
context ❓ unknown
Parameter inferred from function signature
items ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnUnequipItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:OnUseItemCallback(parameters)

method undocumented
No documentation available

Parameters (inferred)

parameters ❓ unknown
Parameter inferred from function signature

FrameworkZ.Items:RemoveInstance(instanceID, username)

method
Removes an item instance from the game world and the item instance list.

Parameters

instanceID 🔢 integer
The instance ID of the item to remove.
username 📦 object
(Optional) The player's username whose inventory the item should be removed from.

Returns

✅ boolean
\string Success status and message.

FrameworkZ.Items:RemoveItemInstanceByUniqueID(owner, uniqueID)

method undocumented
No documentation available

Parameters (inferred)

owner ❓ unknown
Parameter inferred from function signature
uniqueID ❓ unknown
Parameter inferred from function signature

Returns (inferred)

⭕ void
Return type inferred from function name pattern