FrameworkZ::Items Class Reference

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

Public Member Functions
void	AddInstance (item, isoPlayer, worldItem)
void	CreateItem (itemID, isoPlayer)
void	CreateWorldItem (isoPlayer, fullItemID)
void	GetInstance (id)
void	GetItemByID (uniqueID)
void	Initialize (data)
void	LinkWorldItemToInstanceData (worldItem, instanceData)
void	New (uniqueID, itemID, username)
void	OnDropItemCallback (parameters)
void	OnExamineItemCallback (parameters)
void	OnFillInventoryObjectContextMenu (player, context, items)
void	OnUseItemCallback (parameters)
void	RemoveInstance (id)

Data Fields
FrameworkZ Items	__index
ITEM	__index
ITEM	category
ITEM	description
FrameworkZ Items	Instances
local	ITEM
FrameworkZ	Items
FrameworkZ Items	List
ITEM	name
ITEM	shouldConsume
ITEM	useText
ITEM	useTime
ITEM	weight

Detailed Description

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

Definition at line 5 of file Items.lua.

Member Function Documentation

AddInstance()

void AddInstance	(	item	,
		isoPlayer	,
		worldItem	)

CreateItem()

void CreateItem	(	itemID	,
		isoPlayer	)

CreateWorldItem()

void CreateWorldItem	(	isoPlayer	,
		fullItemID	)

GetInstance()

void GetInstance

(

id

)

GetItemByID()

void GetItemByID

(

uniqueID

)

Initialize()

void Initialize

(

data

)

LinkWorldItemToInstanceData()

void LinkWorldItemToInstanceData	(	worldItem	,
		instanceData	)

New()

void New	(	uniqueID	,
		itemID	,
		username	)

OnDropItemCallback()

void OnDropItemCallback

(

parameters

)

OnExamineItemCallback()

void OnExamineItemCallback

(

parameters

)

OnFillInventoryObjectContextMenu()

void OnFillInventoryObjectContextMenu	(	player	,
		context	,
		items	)

OnUseItemCallback()

void OnUseItemCallback

(

parameters

)

RemoveInstance()

void RemoveInstance

(

id

)

Field Documentation

__index [1/2]

FrameworkZ Items __index

Definition at line 7 of file Items.lua.

__index [2/2]

ITEM __index

Definition at line 17 of file Items.lua.

category

ITEM category

Definition at line 23 of file Items.lua.

description

ITEM description

Definition at line 21 of file Items.lua.

Instances

FrameworkZ Items Instances

Definition at line 11 of file Items.lua.

ITEM

local ITEM

Definition at line 15 of file Items.lua.

Items

FrameworkZ Items

Definition at line 13 of file Items.lua.

List

FrameworkZ Items List

Definition at line 9 of file Items.lua.

name

ITEM name

Definition at line 19 of file Items.lua.

shouldConsume

ITEM shouldConsume

Definition at line 31 of file Items.lua.

useText

ITEM useText

Definition at line 25 of file Items.lua.

useTime

ITEM useTime

Definition at line 27 of file Items.lua.

weight

ITEM weight

Definition at line 29 of file Items.lua.

---

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

• Items.lua