Item Class Reference [Server API]

List of all members.

Public Member Functions
Scripts and events
bool	SetScript (string@+ script)
uint	GetScriptId ()
void	SetEvent (int eventType, string& funcName)
Invoking events
bool	EventFinish (bool toDelete)
	Invokes ITEM_EVENT_FINISH event.
bool	EventAttack (Critter& attacker, Critter& target)
	Invokes ITEM_EVENT_ATTACK event.
bool	EventUse (Critter& cr, Critter@ onCritter, Item@ onItem, Scenery@ onScenery)
	Invokes ITEM_EVENT_USE event.
bool	EventUseOnMe (Critter& cr, Item@ usedItem)
	Invokes ITEM_EVENT_USE_ON_ME event.
bool	EventSkill (Critter& cr, int skill)
	Invokes ITEM_EVENT_SKILL event.
void	EventDrop (Critter& cr)
	Invokes ITEM_EVENT_DROP event.
void	EventMove (Critter& cr, uint8 fromSlot)
	Invokes ITEM_EVENT_MOVE event.
void	EventWalk (Critter& cr, bool entered, uint8 dir)
	Invokes ITEM_EVENT_WALK event.
General
void	Animate (uint8 fromFrame, uint8 toFrame)
bool	ChangeProto (uint16 protoId)
uint8	GetType ()
uint16	GetProtoId ()
uint	GetCost ()
uint	GetCount ()
void	SetCount (uint count)
Map	GetMapPosition (uint16& hexX, uint16& hexY)
bool	IsGrouped ()
bool	IsWeared ()
void	Update ()
void	SetLexems (string@+ lexems)
For the cars
bool	IsCar ()
Item	CarGetBag (int numBag)
For containers
Item	AddItem (uint16 protoId, uint count, uint specialId)
Item	GetItem (uint16 protoId, uint specialId)
uint	GetItems (uint specialId, Item@[]@+ items)
Public Attributes
General fields
const uint	Id
const bool	IsNotValid
	Allows to check whether underlying object is valid.
const ProtoItem	Proto
uint	Cost
uint	Flags
uint16	RadioFlags
uint16	Info
uint	PicInv
uint	PicMap
uint16	SortValue
Access
const uint8	Accessory
const uint	MapId
const uint16	HexX
const uint16	HexY
const uint	CritId
const uint8	CritSlot
const uint	ContainerId
const uint	StackId
	(?)
uint	SpecialId
Various (Misc2)
uint	Val1
uint	Val2
uint	Val3
uint	Val4
uint	Val5
For the wearing items (weapon, armor)
int8	BrokenFlags
	(?)
uint8	BrokenCount
	(?)
uint16	BrokenWear
	(?)
For locks (keys, containers, doors)
uint	LockerId
uint16	LockerCondition
uint16	LockerComplexity
For animations
uint16	AnimWaitBase
	(?)
uint8	AnimStayBegin
	(?)
uint8	AnimStayEnd
	(?)
uint8	AnimShowBegin
	(?)
uint8	AnimShowEnd
	(?)
uint8	AnimHideBegin
	(?)
uint8	AnimHideEnd
	(?)
Weapons
uint16	Weapon_AmmoPid
uint16	Weapon_AmmoCount
uint8	Mode
Lightness
int8	LightIntensity
	(?)
uint8	LightRadius
	(?)
uint8	LightFlags
	(?)
uint	LightColor
	(?)

---

Member Function Documentation

bool SetScript

(

string@+

script

)

uint GetScriptId

(

)

void SetEvent	(	int	eventType,
		string&	funcName
	)

bool EventFinish

(

bool

toDelete

)

Invokes ITEM_EVENT_FINISH event.

bool EventAttack	(	Critter&	attacker,
		Critter&	target
	)

Invokes ITEM_EVENT_ATTACK event.

bool EventUse	(	Critter&	cr,
		Critter@	onCritter,
		Item@	onItem,
		Scenery@	onScenery
	)

Invokes ITEM_EVENT_USE event.

bool EventUseOnMe	(	Critter&	cr,
		Item@	usedItem
	)

Invokes ITEM_EVENT_USE_ON_ME event.

bool EventSkill	(	Critter&	cr,
		int	skill
	)

Invokes ITEM_EVENT_SKILL event.

void EventDrop

(

Critter&

cr

)

Invokes ITEM_EVENT_DROP event.

void EventMove	(	Critter&	cr,
		uint8	fromSlot
	)

Invokes ITEM_EVENT_MOVE event.

void EventWalk	(	Critter&	cr,
		bool	entered,
		uint8	dir
	)

Invokes ITEM_EVENT_WALK event.

void Animate	(	uint8	fromFrame,
		uint8	toFrame
	)

bool ChangeProto

(

uint16

protoId

)

uint8 GetType

(

)

uint16 GetProtoId

(

)

uint GetCost

(

)

uint GetCount

(

)

void SetCount

(

uint

count

)

Map GetMapPosition	(	uint16&	hexX,
		uint16&	hexY
	)

bool IsGrouped

(

)

bool IsWeared

(

)

void Update

(

)

void SetLexems

(

string@+

lexems

)

bool IsCar

(

)

Item CarGetBag

(

int

numBag

)

Item AddItem	(	uint16	protoId,
		uint	count,
		uint	specialId
	)

Item GetItem	(	uint16	protoId,
		uint	specialId
	)

uint GetItems	(	uint	specialId,
		Item@[]@+	items
	)

---

Member Data Documentation

const uint Id

const bool IsNotValid

Allows to check whether underlying object is valid.

const ProtoItem Proto

uint Cost

uint Flags

uint16 RadioFlags

uint16 Info

uint PicInv

uint PicMap

uint16 SortValue

const uint8 Accessory

const uint MapId

const uint16 HexX

const uint16 HexY

const uint CritId

const uint8 CritSlot

const uint ContainerId

const uint StackId

(?)

uint SpecialId

uint Val1

uint Val2

uint Val3

uint Val4

uint Val5

int8 BrokenFlags

(?)

uint8 BrokenCount

(?)

uint16 BrokenWear

(?)

uint LockerId

uint16 LockerCondition

uint16 LockerComplexity

uint16 AnimWaitBase

(?)

uint8 AnimStayBegin

(?)

uint8 AnimStayEnd

(?)

uint8 AnimShowBegin

(?)

uint8 AnimShowEnd

(?)

uint8 AnimHideBegin

(?)

uint8 AnimHideEnd

(?)

uint16 Weapon_AmmoPid

uint16 Weapon_AmmoCount

uint8 Mode

int8 LightIntensity

(?)

uint8 LightRadius

(?)

uint8 LightFlags

(?)

uint LightColor

(?)