Spriteh

Spriteh (Function)

Format

spriteh ( sprite_number )

returns integer_expression

Description

Returns the height, in pixels, of a loaded sprite as it appears on the screen.

If the sprite has been scaled or rotated by Spriteplace or Spritemove, this is the height of the sprite as transformed and not the height of the picture it was made from. A sprite 40 pixels tall measures 120 at a scale of 3 and 20 at a scale of 0.5.

A rotated sprite is as tall as the upright box that encloses it once it has been turned, so the same 40 pixel sprite measures about 57 turned an eighth of a turn, and 40 again at a half turn. That box is what Spritecollide works from, so a test such as if y > graphheight - spriteh(n) / 2 keeps a scaled or turned sprite inside the graphics area.

See Also

Spritecollide, Spritedim, Spriteh, Spritehide, Spriteload, Spritemove, Spriteo, Spritepoly, Spriteplace, Spriter, Sprites, Spriteshow, Spriteslice, Spritetext, Spritev, Spritew, Spritex, Spritey

History

0.9.6n	New To Version
2.3	Follows the scale and rotation the sprite was placed with