Itemdata Functions and Variables Documentation

Functions and Properties

Return Type	Function Information
`void`	`GetName(int buffer[])Loads the item this itemdata is attributed to's name into 'buffer'`
`int`	`FamilyThe kind of item to which this class belongs (swords, boomerangs potions, etc.) Use the IC_ constants in std.zh to set or compare this value.`
`int`	`LevelThe level of this item. Higher-level items replace lower-level items when they are picked up.`
`int`	`PowerThe item's power, for most items this is amount of damage dealt but is used for other values in some items (ie. Roc's Feather)`
`int`	AmountCorresponds to the "Increase Amount" entry in the Item Editor. The value of this data member can have two meanings: If Amount & 0x8000 is 1, the drain counter for this item is set to Amount & 0x3FFF. The game then slowly fills the counter of this item (see Counter below) out of the drain counter. Gaining rupees uses the drain counter, for example. is set to Amount when the item is picked up. If Amount & 0x8000 is 0, the counter of this item is increased, if Amount & 0x4000 is 1, or decreased, if Amount & 0x4000 is 0, by Amount & 0x3FFF when the item is picked up.
`int`	MaxCorresponds to the "Full Max" entry in the Item Editor. In conjunction with MaxIncrement (see below) this value controls how the maximum value of the counter of this item (see Counter below) is modified when the item is picked up. If MaxIncrement is nonzero at that time, the counter's new maximum value is at that time set to the minimum of its current value plus MaxIncrement, Max. If Max is less than the current maximum of the counter, Max is ignored and that maximum is used instead. Notice that as a special case, if Max = MaxIncrement, the counter's maximum value will be forced equal to Max.
`int`	MaxIncrementCorresponds to the "+Max" entry in the Item Editor. In conjunction with Max (see above) this value controls how the maximum value of the counter of this item (see Counter below) is modified when the item is picked up. If MaxIncrement is nonzero at that time, the counter's new maximum value is at that time set to the minimum of its current value plus MaxIncrement, and Max. If Max is less than the current maximum of the counter, Max is ignored and that maximum is used instead.
`bool`	`KeepCorresponds to the "Equipment Item" checkbox in the Item Editor. If true, Link will keep the item, and it will show up as an item or equipment in the subscreen. If false, it may modify the current value or maximum value of its counter (see Counter below), then disappear. The White Sword and Raft, for instance, have Keep true, and keys and rupees have Keep false.`
`int`	`CounterCorresponds to the "Counter Reference" entry in the Item Editor. The game counter whose current and modified values might be modified when the item is picked up (see Amount, Max, and MaxIncrement above.) Use the CT_ constants in std.zh to set or compare this value.`
`int`	`UseSoundCorresponds to the "Sound" entry on the action tab in the Item Editor.`