FrameworkZ::Items Class Reference

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

Public Member Functions
void	AddInstance (item, isoPlayer, worldItem, callback)
boolean	CreateItem (uniqueID, isoPlayer, callback)
	Creates an item instance and links it to a world item.
void	CreateWorldItem (isoPlayer, fullItemID)
void	FindFirstInstanceByID (owner, uniqueID)
void	GetInstance (instanceID)
void	GetItemByUniqueID (uniqueID)
void	GetStoredData (worldItem)
void	Initialize (data)
void	LinkWorldItemToInstanceData (worldItem, instanceData)
void	New (uniqueID, itemID, isBase)
void	OnDropItemCallback (parameters)
void	OnEquipItemCallback (parameters)
void	OnExamineItemCallback (parameters)
void	OnFillInventoryObjectContextMenu (player, context, items)
void	OnUnequipItemCallback (parameters)
void	OnUseItemCallback (parameters)
boolean	RemoveInstance (instanceID, username)
	Removes an item instance from the game world and the item instance list.
void	RemoveItemInstanceByUniqueID (owner, uniqueID)

Data Fields
FrameworkZ Items	__index
ITEM	__index
FrameworkZ Items	Bases
ITEM	category
ITEM	description
ITEM	equipTime
	FZ_EQUIP_TYPE_BOTH_HANDS
	FZ_EQUIP_TYPE_CLOTHING
	FZ_EQUIP_TYPE_IDEAL
	FZ_EQUIP_TYPE_PRIMARY
	FZ_EQUIP_TYPE_SECONDARY
FrameworkZ Items	InstanceMap
	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.
FrameworkZ Items	Instances
local	ITEM
FrameworkZ	Items
FrameworkZ Items	List
ITEM	name
ITEM	shouldConsume
ITEM	unequipTime
ITEM	useText
ITEM	useTime
ITEM	weight

Detailed Description

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

Definition at line 18 of file Items.lua.

Member Function Documentation

AddInstance()

void AddInstance	(	item	,
		isoPlayer	,
		worldItem	,
		callback	)

CreateItem()

boolean CreateItem	(	uniqueID	,
		isoPlayer	,
		callback	)

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.

CreateWorldItem()

void CreateWorldItem	(	isoPlayer	,
		fullItemID	)

FindFirstInstanceByID()

void FindFirstInstanceByID	(	owner	,
		uniqueID	)

GetInstance()

void GetInstance

(

instanceID

)

GetItemByUniqueID()

void GetItemByUniqueID

(

uniqueID

)

GetStoredData()

void GetStoredData

(

worldItem

)

Initialize()

void Initialize

(

data

)

LinkWorldItemToInstanceData()

void LinkWorldItemToInstanceData	(	worldItem	,
		instanceData	)

New()

void New	(	uniqueID	,
		itemID	,
		isBase	)

OnDropItemCallback()

void OnDropItemCallback

(

parameters

)

OnEquipItemCallback()

void OnEquipItemCallback

(

parameters

)

OnExamineItemCallback()

void OnExamineItemCallback

(

parameters

)

OnFillInventoryObjectContextMenu()

void OnFillInventoryObjectContextMenu	(	player	,
		context	,
		items	)

OnUnequipItemCallback()

void OnUnequipItemCallback

(

parameters

)

OnUseItemCallback()

void OnUseItemCallback

(

parameters

)

RemoveInstance()

boolean RemoveInstance	(	instanceID	,
		username	)

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.

RemoveItemInstanceByUniqueID()

void RemoveItemInstanceByUniqueID	(	owner	,
		uniqueID	)

Field Documentation

__index [1/2]

FrameworkZ Items __index

Definition at line 20 of file Items.lua.

__index [2/2]

ITEM __index

Definition at line 47 of file Items.lua.

Bases

FrameworkZ Items Bases

Definition at line 34 of file Items.lua.

category

ITEM category

Definition at line 53 of file Items.lua.

description

ITEM description

Definition at line 51 of file Items.lua.

equipTime

ITEM equipTime

Definition at line 55 of file Items.lua.

FZ_EQUIP_TYPE_BOTH_HANDS

FrameworkZ::Items::FZ_EQUIP_TYPE_BOTH_HANDS

Definition at line 30 of file Items.lua.

FZ_EQUIP_TYPE_CLOTHING

FrameworkZ::Items::FZ_EQUIP_TYPE_CLOTHING

Definition at line 24 of file Items.lua.

FZ_EQUIP_TYPE_IDEAL

FrameworkZ::Items::FZ_EQUIP_TYPE_IDEAL

Definition at line 22 of file Items.lua.

FZ_EQUIP_TYPE_PRIMARY

FrameworkZ::Items::FZ_EQUIP_TYPE_PRIMARY

Definition at line 26 of file Items.lua.

FZ_EQUIP_TYPE_SECONDARY

FrameworkZ::Items::FZ_EQUIP_TYPE_SECONDARY

Definition at line 28 of file Items.lua.

InstanceMap

FrameworkZ Items InstanceMap

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.

Definition at line 41 of file Items.lua.

Instances

FrameworkZ Items Instances

Definition at line 36 of file Items.lua.

ITEM

local ITEM

Definition at line 45 of file Items.lua.

Items

FrameworkZ Items

Definition at line 43 of file Items.lua.

List

FrameworkZ Items List

Definition at line 32 of file Items.lua.

name

ITEM name

Definition at line 49 of file Items.lua.

shouldConsume

ITEM shouldConsume

Definition at line 65 of file Items.lua.

unequipTime

ITEM unequipTime

Definition at line 57 of file Items.lua.

useText

ITEM useText

Definition at line 59 of file Items.lua.

useTime

ITEM useTime

Definition at line 61 of file Items.lua.

weight

ITEM weight

Definition at line 63 of file Items.lua.

---

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

• Items.lua