itemdata#
Metadata for a specific item type (not an instance of one). Load with Game->LoadItemData().
Variables#
const int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
bool |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
untyped[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
untyped[] |
|
long[] |
|
bool[] |
|
int[] |
|
int |
|
untyped[] |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
bool |
|
int[] |
|
int[] |
|
bool |
|
int |
|
int |
|
int |
|
untyped[] |
|
int |
|
int |
Defence deprecated |
int |
|
int |
|
int |
|
int |
|
int |
|
bool |
|
bool |
|
int |
|
untyped[] |
Functions#
void |
GetName(char32[] buf) |
void |
GetDisplayName(int buf) |
void |
SetDisplayName(int buf) |
void |
GetShownName(int buf) |
void |
RunScript(int mode = |
Enumerations#
Item IDs. Used with Screen->CreateItem() and Hero->Item[]. These are DEFAULT values, and may not be correct for custom quests which have overridden item action data.
ItemID I_AMULET1 = 50
ItemID I_AMULET2 = 63
ItemID I_ARROW1 = 13
ItemID I_ARROW2 = 14
ItemID I_ARROW3 = 57
ItemID I_ARROWAMMO1 = 70
ItemID I_ARROWAMMO10 = 72
ItemID I_ARROWAMMO30 = 73
ItemID I_ARROWAMMO5 = 71
ItemID I_BAIT = 16
ItemID I_BOMB = 3
ItemID I_BOMBAMMO1 = 77
ItemID I_BOMBAMMO30 = 80
ItemID I_BOMBAMMO4 = 78
ItemID I_BOMBAMMO8 = 79
ItemID I_BOMBBAG1 = 81
ItemID I_BOMBBAG2 = 82
ItemID I_BOMBBAG3 = 83
ItemID I_BOMBBAG4 = 106
ItemID I_BOOK = 32
ItemID I_BOOTS = 55
ItemID I_BOSSKEY = 67
ItemID I_BOW1 = 15
ItemID I_BOW2 = 68
ItemID I_BRACELET1 = 107
ItemID I_BRACELET2 = 19
ItemID I_BRACELET3 = 56
ItemID I_BRANG1 = 23
ItemID I_BRANG2 = 24
ItemID I_BRANG3 = 35
ItemID I_CANDLE1 = 10
ItemID I_CANDLE2 = 11
ItemID I_CBYRNA = 88
ItemID I_CHARGERING1 = 101
ItemID I_CHARGERING2 = 102
ItemID I_CLOCK = 4
ItemID I_COMPASS = 22
ItemID I_CROSSSCROLL = 95
ItemID I_DINSFIRE = 64
ItemID I_DUST_PILE = 43
ItemID I_FAIRY = 34
ItemID I_FAIRYSTILL = 69
ItemID I_FARORESWIND = 65
ItemID I_FLIPPERS = 51
ItemID I_HAMMER = 54
ItemID I_HCPIECE = 49
ItemID I_HEART = 2
ItemID I_HEARTCONTAINER = 28
ItemID I_HEARTRING1 = 112
ItemID I_HEARTRING2 = 113
ItemID I_HEARTRING3 = 114
ItemID I_HOOKSHOT1 = 52
ItemID I_HOOKSHOT2 = 89
ItemID I_HOVERBOOTS = 92
ItemID I_KEY = 9
ItemID I_KILLALL = 62
ItemID I_LADDER1 = 27
ItemID I_LADDER2 = 108
ItemID I_LENS = 53
ItemID I_LETTER = 12
ItemID I_LETTERUSED = 90
ItemID I_LEVELKEY = 84
ItemID I_MAGICCONTAINER = 58
ItemID I_MAGICJAR1 = 59
ItemID I_MAGICJAR2 = 60
ItemID I_MAGICKEY = 33
ItemID I_MAGICRING1 = 115
ItemID I_MAGICRING2 = 116
ItemID I_MAGICRING3 = 117
ItemID I_MAGICRING4 = 118
ItemID I_MAP = 21
ItemID I_MISC1 = 46
ItemID I_MISC2 = 47
ItemID I_NAYRUSLOVE = 66
ItemID I_PERILRING = 121
ItemID I_PERILSCROLL = 103
ItemID I_POTION1 = 29
ItemID I_POTION2 = 30
ItemID I_QUAKESCROLL1 = 96
ItemID I_QUAKESCROLL2 = 97
ItemID I_QUIVER1 = 74
ItemID I_QUIVER2 = 75
ItemID I_QUIVER3 = 76
ItemID I_QUIVER4 = 105
ItemID I_RAFT = 26
ItemID I_RING1 = 17
ItemID I_RING2 = 18
ItemID I_RING3 = 61
ItemID I_ROCSFEATHER = 91
ItemID I_RUPEE1 = 0
ItemID I_RUPEE10 = 86
ItemID I_RUPEE100 = 87
ItemID I_RUPEE20 = 38
ItemID I_RUPEE200 = 40
ItemID I_RUPEE5 = 1
ItemID I_RUPEE50 = 39
ItemID I_SBOMB = 48
ItemID I_SELECTA = 45
ItemID I_SELECTB = 85
ItemID I_SHIELD1 = 93
ItemID I_SHIELD2 = 8
ItemID I_SHIELD3 = 37
ItemID I_SPINSCROLL1 = 94
ItemID I_SPINSCROLL2 = 98
ItemID I_STOMPBOOTS = 120
ItemID I_STONEAGONY = 119
ItemID I_SWORD1 = 5
ItemID I_SWORD2 = 6
ItemID I_SWORD3 = 7
ItemID I_SWORD4 = 36
ItemID I_TRIFORCE = 20
ItemID I_TRIFORCEBIG = 44
ItemID I_WALLET500 = 41
ItemID I_WALLET999 = 42
ItemID I_WALLETA = 104
ItemID I_WAND = 25
ItemID I_WEALTHMEDAL = 109
ItemID I_WEALTHMEDAL2 = 110
ItemID I_WEALTHMEDAL3 = 111
ItemID I_WHIMSICALRING = 122
ItemID I_WHISPRING1 = 99
ItemID I_WHISPRING2 = 100
ItemID I_WHISTLE = 31
Item types, used with itemdata::Type.
ItemType IC_SWORD = 0
ItemType IC_BRANG = 1
ItemType IC_ARROW = 2
ItemType IC_CANDLE = 3
ItemType IC_WHISTLE = 4
ItemType IC_BAIT = 5
ItemType IC_LETTER = 6
ItemType IC_POTION = 7
ItemType IC_WAND = 8
ItemType IC_RING = 9
ItemType IC_WALLET = 10
ItemType IC_AMULET = 11
ItemType IC_SHIELD = 12
ItemType IC_BOW = 13
ItemType IC_RAFT = 14
ItemType IC_LADDER = 15
ItemType IC_BOOK = 16
ItemType IC_MAGICKEY = 17
ItemType IC_BRACELET = 18
ItemType IC_FLIPPERS = 19
ItemType IC_BOOTS = 20
ItemType IC_HOOKSHOT = 21
ItemType IC_LENS = 22
ItemType IC_HAMMER = 23
ItemType IC_DINSFIRE = 24
ItemType IC_FARORESWIND = 25
ItemType IC_NAYRUSLOVE = 26
ItemType IC_BOMB = 27
ItemType IC_SBOMB = 28
ItemType IC_CLOCK = 29
ItemType IC_KEY = 30
ItemType IC_MAGICCONTAINER = 31
ItemType IC_TRIFORCE = 32
ItemType IC_MAP = 33
ItemType IC_COMPASS = 34
ItemType IC_BOSSKEY = 35
ItemType IC_QUIVER = 36
ItemType IC_LEVELKEY = 37
ItemType IC_CBYRNA = 38
ItemType IC_RUPEE = 39
ItemType IC_ARROWAMMO = 40
ItemType IC_FAIRY = 41
ItemType IC_MAGIC = 42
ItemType IC_HEART = 43
ItemType IC_HEARTCONTAINER = 44
ItemType IC_HEARTPIECE = 45
ItemType IC_KILLALL = 46
ItemType IC_BOMBAMMO = 47
ItemType IC_BOMBBAG = 48
ItemType IC_ROCS = 49
ItemType IC_HOVERBOOTS = 50
ItemType IC_SPINSCROLL = 51
ItemType IC_CROSSSCROLL = 52
ItemType IC_QUAKESCROLL = 53
ItemType IC_WHISPRING = 54
ItemType IC_CHARGERING = 55
ItemType IC_PERILSCROLL = 56
ItemType IC_WEALTHMEDAL = 57
ItemType IC_HEARTRING = 58
ItemType IC_MAGICRING = 59
ItemType IC_HURRICANESCROLL = 60
ItemType IC_SQUAKESCROLL = 61
ItemType IC_STONEAGONY = 62
ItemType IC_STOMPBOOTS = 63
ItemType IC_WHIMSICALRING = 64
ItemType IC_PERILRING = 65
ItemType IC_MISC = 66
ItemType IC_CUSTOM1 = 67
ItemType IC_CUSTOM2 = 68
ItemType IC_CUSTOM3 = 69
ItemType IC_CUSTOM4 = 70
ItemType IC_CUSTOM5 = 71
ItemType IC_CUSTOM6 = 72
ItemType IC_CUSTOM7 = 73
ItemType IC_CUSTOM8 = 74
ItemType IC_CUSTOM9 = 75
ItemType IC_CUSTOM10 = 76
ItemType IC_CUSTOM11 = 77
ItemType IC_CUSTOM12 = 78
ItemType IC_CUSTOM13 = 79
ItemType IC_CUSTOM14 = 80
ItemType IC_CUSTOM15 = 81
ItemType IC_CUSTOM16 = 82
ItemType IC_CUSTOM17 = 83
ItemType IC_CUSTOM18 = 84
ItemType IC_CUSTOM19 = 85
ItemType IC_CUSTOM20 = 86
ItemType IC_BOWANDARROW = 87
ItemType IC_LETTERPOTION = 88
ItemType IC_WPN_CUSTOM_01 = 256
89-255 free use These item classes create a projectile of the type LW_CUSTOM/LW_SCRIPT, 01 to 10
ItemType IC_WPN_SCRIPT_01 = 256
ItemType IC_WPN_CUSTOM_02 = 257
ItemType IC_WPN_SCRIPT_02 = 257
ItemType IC_WPN_CUSTOM_03 = 258
ItemType IC_WPN_SCRIPT_03 = 258
ItemType IC_WPN_CUSTOM_04 = 259
ItemType IC_WPN_SCRIPT_04 = 259
ItemType IC_WPN_CUSTOM_05 = 260
ItemType IC_WPN_SCRIPT_05 = 260
ItemType IC_WPN_CUSTOM_06 = 261
ItemType IC_WPN_SCRIPT_06 = 261
ItemType IC_WPN_CUSTOM_07 = 262
ItemType IC_WPN_SCRIPT_07 = 262
ItemType IC_WPN_CUSTOM_08 = 263
ItemType IC_WPN_SCRIPT_08 = 263
ItemType IC_WPN_CUSTOM_09 = 264
ItemType IC_WPN_SCRIPT_09 = 264
ItemType IC_WPN_CUSTOM_10 = 265
ItemType IC_WPN_SCRIPT_10 = 265
ItemType IC_ICEROD = 266
Not Implemented
ItemType IC_ATKRING = 267
ItemType IC_LANTERN = 268
ItemType IC_PEARL = 269
ItemType IC_BOTTLE = 270
ItemType IC_BOTTLE_FILL = 271
ItemType IC_BUG_NET = 272
ItemType IC_MIRRORS = 273
ItemType IC_SWITCHHOOK = 274
ItemType IC_ITEM_BUNDLE = 275
ItemType IC_PROGRESSIVE = 276
ItemType IC_NOTE = 277
ItemType IC_REFILL = 278
ItemType IC_LIFTGLOVE = 279
ItemType IC_MAXUSABLE = 280
Itemclasses not less than this are reserved for future engine itemclasses
ItemType IC_MAX = 512
Last of enum. All itemclassesare < this.
enum ItemPickupBitflags: 🔗 Source
Item pickup bitflags. Used with item::Pickup. Many values are reserved for internal usage, and have no effect.
ItemPickupBitflags IP_BIGRANGE = 1
INTERNAL Collision rectangle is large.
ItemPickupBitflags IP_HOLDUP = 2
Link holds it up when collecting it.
ItemPickupBitflags IP_ST_ITEM = 4
Sets the screen state “Item” when collected.
ItemPickupBitflags IP_DUMMY = 8
A ‘dummy’ item, such as rupee markers in shops. Can’t be collected and ignores gravity.
ItemPickupBitflags IP_CHECK = 16
INTERNAL Check restrictions (money in a shop, etc.).
ItemPickupBitflags IP_MONEY = 32
INTERNAL This item causes money loss (bomb upgrade, swindle room, etc.).
ItemPickupBitflags IP_FADE = 64
INTERNAL Blinks if fadeclk>0.
ItemPickupBitflags IP_ENEMYCARRIED = 128
The item-carrying NPC carries it. If no NPC has an item, the most recently created NPC carries it.
ItemPickupBitflags IP_TIMEOUT = 256
Disappears after 512 frames. Can be collected by melee weapons if the related quest rule is not set.
ItemPickupBitflags IP_BIGTRIFORCE = 512
INTERNAL Large collision rectangle (used for large triforce).
ItemPickupBitflags IP_NODRAW = 1024
INTERNAL Don’t draw this (for underwater items).
ItemPickupBitflags IP_ST_SPECIALITEM = 2048
Sets the screen state “Special Item” when collected.
ItemPickupBitflags IP_TRIGGERSECRETS = 4096
Triggers screen secrets when collected.
ItemPickupBitflags IP_ALWAYSGRAB = 8192
Item is always able to be picked up (ex. brang/hshot/arrows/melee weapons).
enum BlockBitflagsInt: 🔗 Source
Used with itemdata::Attributes[].
Deprecated: Use BlockBitflags (L_) instead!
BlockBitflagsInt BLOCKFLAG_ROCK = 1
BlockBitflagsInt BLOCKFLAG_ARROW = 2
BlockBitflagsInt BLOCKFLAG_BRANG = 4
BlockBitflagsInt BLOCKFLAG_FIREBALL = 8
BlockBitflagsInt BLOCKFLAG_SWORD = 16
BlockBitflagsInt BLOCKFLAG_MAGIC = 32
BlockBitflagsInt BLOCKFLAG_FLAME = 64
BlockBitflagsInt BLOCKFLAG_SCRIPT = 128
Blocks or reflects ALL script weapons.
BlockBitflagsInt BLOCKFLAG_FIREBALL2 = 256
BlockBitflagsInt BLOCKFLAG_LIGHTBEAM = 512
BlockBitflagsInt BLOCKFLAG_SCRIPT1 = 1024
BlockBitflagsInt BLOCKFLAG_SCRIPT2 = 2048
BlockBitflagsInt BLOCKFLAG_SCRIPT3 = 4096
BlockBitflagsInt BLOCKFLAG_SCRIPT4 = 8192
BlockBitflagsInt BLOCKFLAG_SCRIPT5 = 16384
BlockBitflagsInt BLOCKFLAG_SCRIPT6 = 32768
BlockBitflagsInt BLOCKFLAG_SCRIPT7 = 65536
Used with itemdata::LAttributes[].
BlockBitflags L_BLOCKFLAG_ROCK = 1L
BlockBitflags L_BLOCKFLAG_ARROW = 2L
BlockBitflags L_BLOCKFLAG_BRANG = 4L
BlockBitflags L_BLOCKFLAG_FIREBALL = 8L
BlockBitflags L_BLOCKFLAG_SWORD = 16L
BlockBitflags L_BLOCKFLAG_MAGIC = 32L
BlockBitflags L_BLOCKFLAG_FLAME = 64L
BlockBitflags L_BLOCKFLAG_SCRIPT = 128L
Blocks or reflects ALL script weapons.
BlockBitflags L_BLOCKFLAG_FIREBALL2 = 256L
BlockBitflags L_BLOCKFLAG_LIGHTBEAM = 512L
BlockBitflags L_BLOCKFLAG_SCRIPT1 = 1024L
BlockBitflags L_BLOCKFLAG_SCRIPT2 = 2048L
BlockBitflags L_BLOCKFLAG_SCRIPT3 = 4096L
BlockBitflags L_BLOCKFLAG_SCRIPT4 = 8192L
BlockBitflags L_BLOCKFLAG_SCRIPT5 = 16384L
BlockBitflags L_BLOCKFLAG_SCRIPT6 = 32768L
BlockBitflags L_BLOCKFLAG_SCRIPT7 = 65536L
BlockBitflags L_BLOCKFLAG_SCRIPT8 = 131072L
BlockBitflags L_BLOCKFLAG_SCRIPT9 = 262144L
BlockBitflags L_BLOCKFLAG_SCRIPT10 = 524288L
enum ItemMiscBitflags: 🔗 Source
ItemMiscBitflags IMISC_FLASH = 1
ItemMiscBitflags IMISC_TWOHAND = 2
ItemMiscBitflags IMISC_HFLIP = 4
ItemMiscBitflags IMISC_VFLIP = 8
ItemBurnIndex ITM_BURNSPR_NO_BURN = 0
ItemBurnIndex ITM_BURNSPR_ANY_BURN = 1
ItemBurnIndex ITM_BURNSPR_STRONG_BURN = 2
ItemBurnIndex ITM_BURNSPR_MAGIC_BURN = 3
ItemBurnIndex ITM_BURNSPR_DIVINE_BURN = 4
ItemBurnIndex ITM_BURNSPR_MAX = 5
enum ItemScriptRunMode: 🔗 Source
ItemScriptRunMode ISCR_KILL = 0
ItemScriptRunMode ISCR_RUN = 1
ItemScriptRunMode ISCR_PERPETUAL = 2
Variable descriptions#
value ItemType (IC_)
Exactly the same as Type - use that instead.
value -9999 to 16383
The amount of the Counter to increase when this item is picked up.
The ‘…But not above’ field- the amount the max of Counter will not be increased above.
How much to increase the max of the Counter by
If the item is an equipment item or not. Items which are not equipment items cannot be “owned” by the Hero or put on buttons.
value CounterIndex (CR_)
The counter to increase when this item is picked up.
The sound to play when the item is picked up.
The item’s usage sound. If/how this is used depends on itemclass.
The item’s second usage sound. If/how this is used depends on itemclass.
The item power. Usage depends on itemclass.
The item power. Usage depends on itemclass.
The 8 InitD values shared by the item’s Action, Pickup, and Sprite scripts.
The Hero Tile Modifier associated with this item.
The item’s Action Script
The item’s Pickup Script
The item’s ItemSprite Script
The message string to display upon picking up the item.
The message string to display upon picking up the item.
int PickupStringFlags 🔗 Source
value PickupStringBitflags (IPSTR_)
The bitflags associated with the pickup string.
The Use Cost/Use Cost 2 of the item.
The Use Cost/Use Cost 2 of the item.
The counter for the Use Cost/Use Cost 2 of the item.
The counter for the Use Cost/Use Cost 2 of the item.
The number of max hearts required to pick up the item.
The starting tile of the item’s animation
value ItemMiscBitflags (IMISC_)
Misc bitflags for the item graphics.
The CSet the item sprite uses.
The Flash CSet the item sprite uses.
The number of frames in the animation.
The speed of the animation, in frames per frame.
The number of delay frames at the start of the animation.
The Upgrade When Collected Twice flag
The Remove Item When Used flag.
The Keep Lower Level Items flag
The Gradual flag.
The Can Be Eaten By Enemies flag.
The Gain All Lower Level Items flag
The 10 item attributes.
The item’s Attributes, as long values.
An editor value of 1 will read as 1L, or 0.0001. This allows all
values to “fit”.
The 16 item flags. Flags[0] through Flags[14] change depending on the
item type; Flags[15] is the Constant Script flag.
The 10 sprites used by the item. How they are used depends on the item type.
The overrided weapon type that the weapon will act like.
untyped[] WeaponInitD 🔗 Source
The 8 InitD values for the weapon script.
The item’s lweapon script
The hitbox offset of the sprite, in pixels.
The hitbox offset of the sprite, in pixels.
The hitbox size of the sprite, in pixels.
The hitbox size of the sprite, in pixels.
The Z-Height of the hitbox, in pixels.
int WeaponDrawXOffset 🔗 Source
The visual offset of the sprite, in pixels.
int WeaponDrawYOffset 🔗 Source
The visual offset of the sprite, in pixels.
int WeaponDrawZOffset 🔗 Source
The default DrawZOffset used by this weapon when the item generates it.
The timer for the ‘Use Cost’/’Use Cost 2’ of the item.
The timer for the ‘Use Cost’/’Use Cost 2’ of the item.
The hitbox offset of the sprite, in pixels.
The hitbox offset of the sprite, in pixels.
The visual offset of the sprite, in pixels.
The visual offset of the sprite, in pixels.
The hitbox size of the sprite, in pixels.
The hitbox size of the sprite, in pixels.
The Z-Height of the hitbox, in pixels.
The visual size of the sprite, in tiles.
The visual size of the sprite, in tiles.
value ItemPickupBitflags (IP_)
The item pickup bitflags.
value SizeOverrideBitflags (SZFLAG_)
Bitflags representing all the checkboxes for which sizes to apply from the itemdata.
value SizeOverrideBitflags (SZFLAG_)
Bitflags representing all the checkboxes for which sizes to apply from the itemdata, for any lweapon created by this item.
The visual size of the sprite, in tiles.
The visual size of the sprite, in tiles.
The Only Validate Cost/Only Validate Cost 2 checkboxes
The Only Validate Cost/Only Validate Cost 2 checkboxes
The Constant Script flag.
bool SideSwimDisabled 🔗 Source
The Disabled In Sideview Water flag.
The Usable as a Bunny flag.
The Immune to jinxes flag.
The Uses Other Jinx flag.
If true, the weapon created by this item will update its sprite when lit on fire using BurnSprites[].
index ItemBurnIndex (ITM_)
The sprites used for making the weapon change appearance when lit on fire.
int[] BurnLightRadius 🔗 Source
index ItemBurnIndex (ITM_)
The burning light radii from Graphics->Sprites->Burning.
The cost of the item, in units. Whenever the item is used, this value is decremented from the counter supplied to CostCounter.
If the item runs for more than one frame, this amount will be decremented every CostTimer frames.
The number of frames between counter decrements, when using an item with a perpetual upkeep cost, such as Boots and Cane items.
The Flash value for the CSet
Deprecated: Use Defense instead!
The default defense resolution (e.g. OHKO) that the weapon uses when it strikes an enemy.
If > -1, and the enemy had a defense resolution of None, the default
defense resolution is used in place of None.
The distance that the weapon is allowed to travel.
Not implemented at this time.
The duration of the weapon.
See weapon->Duration.
Not implemented at this time.
The number of extra weapons that this weapon creates.
Not implemented at this time.
The layer used to draw the weapon to the screen.
Not implemented at this time.
The items (in CSV format, using a SCV list ID) that the weapon created by this item, collects on contact.
Not implemented at this time.
An array the 32 Misc[] values used by the weapon.
This may be only partially implemented.
Function descriptions#
void GetName(char32[] buf) 🔗 Source
Fills the buffer with the item’s Name.
void GetDisplayName(int buf) 🔗 Source
Fills the buffer with the item’s Display Name.
void SetDisplayName(int buf) 🔗 Source
Sets the item’s Display Name to the contents of the buffer.
void GetShownName(int buf) 🔗 Source
Fills the buffer with the name of the item as shown on the subscreen. This automatically handles display names, including special instances such as the contents of Bottles.
void RunScript(int mode = ISCR_PERPETUAL) 🔗 Source
param ItemScriptRunMode (ISCR_) mode
Runs or ends the item script, depending on mode.