Item Functions and Variables Documentation

Functions and Properties

Return Type	Function Information
`bool`	`isValid()Returns whether this item pointer is still valid. An item pointer becomes invalid when Link picks up the item, the item fades away or Link leaves the screen. Accessing any variables using an invalid item pointer prints an error message to allegro.log and does nothing.`
`int`	`XThe item's X position on the screen, in pixels. Float values passed to this will be cast to int.`
`int`	`YThe item's Y position on the screen, in pixels. Float values passed to this will be cast to int.`
`int`	`JumpThe item's upward velocity, in pixels. If negative, the item will fall. The downward acceleration of Gravity (in Init Data) modifies this value every frame.`
`int`	`DrawStyleAn integer representing how the item is to be drawn. Use one of the DS_ constants in std.zh to set or compare this value.`
`int`	`IDThis item's ID number. Use the I_ constants to compare this value. The effect of writing to this field is currently undefined.`
`int`	`OriginalTileThe starting tile of the item's animation.`
`int`	`TileThe current tile associated with this item.`
`int`	`CSetThis item's CSet.`
`int`	`FlashCSetThe CSet used during this item's flash frames, if this item flashes.`
`int`	`NumFramesThe number of frames in this item's animation.`
`int`	`FrameThe tile that is this item's current animation frame.`
`int`	`ASpeedThe speed at which this item animates, in screen frames.`
`int`	`DelayThe amount of time the animation is suspended after the last frame before the animation restarts, in item frames. That is, the total number of screen frames of extra wait is Delay*ASpeed.`
`bool`	`FlashWhether or not the item flashes. A flashing item alternates between its CSet and its FlashCSet.`
`int`	`FlipWhether and how the item's tiles should be flipped. 0: No flip 1: Horizontal flip 2: Vertical flip 3: Both (180 degree rotation)`
`int`	PickupThe pickup flags of the item, which determine what happens when Link picks up the item. Its value consists of flags OR'd (\|) together; use the IP_ constants in std.zh to set or compare these values. A special note about IP_ENEMYCARRIED: if the Quest Rule "Hide Enemy- Carried Items" is set, then an item carried by an enemy will have its X and Y values set to -128 while the enemy is carrying it. If this flag is removed from such an item, then it will be moved to the enemy's on-screen location. If you are not comfortable with performing binary operations, use the ItemPickup functions from std.zh.
`int`	`ExtendWhether to extend the sprite of the item.`
`int`	`TileWidthThe number of tile columns composing the sprite. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`TileHeightThe number of tile rows composing the sprite. Writing to this is ignored unless Extend is set to values >=3.`
`int`	`HitWidthThe width of the sprite's hitbox, or collision rectangle.`
`int`	`HitHeightThe height of the sprite's hitbox, or collision rectangle.`
`int`	`HitZHeightThe Z-axis height of the sprite's hitbox, or collision rectangle. The greater it is, the higher Link must jump or fly over the sprite to avoid picking up the item.`
`int`	`HitXOffsetThe X offset of the sprite's hitbox, or collision rectangle. Setting it to positive or negative values will move the sprite's hitbox left or right.`
`int`	`HitYOffsetThe Y offset of the sprite's hitbox, or collision rectangle. Setting it to positive or negative values will move the sprite's hitbox up or down.`
`int`	`DrawXOffsetThe X offset of the sprite. Setting it to positive or negative values will move the sprite's tiles left or right relative to its position.`
`int`	`DrawYOffsetThe Y offset of the sprite. Setting it to positive or negative values will move the sprite's tiles up or down relative to its position.`
`int`	`DrawZOffsetThe Z offset of the sprite.`
`float`	`Misc[]An array of 16 miscellaneous variables for you to use as you please. Note that lweapons and eweapons possess exactly the same attributes although their designation affects how they are treated by the engine. The values here correspond to both the lweapon and eweapon type.`