itemsprite

Inherits: sprite

An active item on the screen.

Load with Screen->Items[], Screen->LoadItem(), or Screen->CreateItem().

Variables

int	ID
int	Type
int	Max
int	Level
int	OriginalTile
int	FlashCSet
int	NumFrames
int	Frame
int	ASpeed
int	Delay
bool	Flash
int	Pickup
bool	NoSound
bool	NoHoldSound
untyped[]	InitD
int	AClock
int	PickupString
int	PickupStringFlags
int	Script
int	DroppedBy
int	PickupExState
bool	ForceGrab
const int	UID deprecated
int	Family deprecated

Functions

void	Max(int value) deprecated
bool	isValid()
void	Explode(int mode)
void	Remove()
bool	Switch(int effect)

Variable descriptions

int ID 🔗 Source

value ItemID (I_)

---

int Type 🔗 Source

value ItemType (IC_)

---

int Max 🔗 Source

Max number of itemsprites currently allowed.

Note: There is also a deprecated getter function ->Max(), which returns the same value. Prefer this variable.

---

int Level 🔗 Source

The item’s level

---

int OriginalTile 🔗 Source

The starting tile of the itemsprite’s animation.

---

int FlashCSet 🔗 Source

The secondary CSet used for flashing.

---

int NumFrames 🔗 Source

The number of frames in the itemsprite’s animation.

---

int Frame 🔗 Source

The current frame number that the animation is on.

---

int ASpeed 🔗 Source

The speed of the animation, in frames per frame.

---

int Delay 🔗 Source

The number of delay frames at the start of the itemsprite’s animation.

---

bool Flash 🔗 Source

If the itemsprite is flashing or not. When flashing, it changes between its’ CSet and FlashCSet.

---

int Pickup 🔗 Source

value ItemPickupBitflags (IP_)

The item pickup bitflags.

---

bool NoSound 🔗 Source

If true, picking up the item does not play it’s usual pickup sound assigned in the item editor. Does not affect holdup sound.

---

bool NoHoldSound 🔗 Source

If true, picking up the item does not play the screen’s holdup sound. Does not affect the usual pickup sound assigned in the item editor.

---

untyped[] InitD 🔗 Source

The 8 InitD[] arguments for the itemsprite script.

---

int AClock 🔗 Source

The timer that ASpeed is used with.

---

int PickupString 🔗 Source

The message string to display upon picking up the item.

---

int PickupStringFlags 🔗 Source

value PickupStringBitflags (IPSTR_)

The bitflags associated with the pickup string.

---

int Script 🔗 Source

The itemsprite script running on this itemsprite.

---

int DroppedBy 🔗 Source

The dropset that this item was dropped by. Will be set for engine-dropped items, can be written by scripts as well.

---

int PickupExState 🔗 Source

Added in version 3.0.

If >-1, this ExState will be set when the item is collected, on the screen the item spawned on (sprite::SpawnScreen).

---

bool ForceGrab 🔗 Source

If set to true, the item will automatically be collected by the Hero as soon as possible.

---

const int UID 🔗 Source

Deprecated:

• This is now just the internal engine ID, which is the same as doing <int>some_sprite.

---

int Family 🔗 Source

Deprecated: Exactly the same as Type, use that instead.

---

Function descriptions

void Max(int value) 🔗 Source

Deprecated: Use Max instead!

Sets the max number of itemsprites allowed to a new value. Range 1-1024.

---

bool isValid() 🔗 Source

Returns true if this pointer points to a valid itemsprite. If this returns false, using any other value of this pointer will error.

---

void Explode(int mode) 🔗 Source

Creates an explosion particle effect in mode 0, 1, or 2 of the sprite.

---

void Remove() 🔗 Source

Instantly deletes the itemsprite.

---

bool Switch(int effect) 🔗 Source

Switch the Hero with this sprite.

Valid values for effect: SwitchEffect (SW_EFF_) (SW_EFF_).