Ferret Laboratories : Yassa : Documentation

Command Reference


Command: sprite

Draws a sprite.

Parameters:

filename = <filename>

Required.
The filename of the spritefile to be displayed, within the presentation folder.

spritename = <name>

Optional.
The name of the sprite within the spritefile to use. If not defined, the first sprite will be used.

style = centred | tiled | scaled | stretched

Optional. Defaults to centred.
How the image should be displayed.
See notes about style.

bgcolour = <colour>

Optional. Defaults to none.
What colour to set the background to before plotting the image.
See notes about colour.

Notes:

I haven't yet implemented the code for plotting a sprite regardless of screen depth. So a sprite will plot incorrectly (or not at all) in such cases. It's on my to-do list!


E-mail me!
This page was last updated March 2005.