sprite library

The sprite library is used to create <sprites>.

Summary

sprite library	The sprite library is used to create <sprites>.
Functions
sprite.newSpriteSheetFromData	Loads a sprite sheet from a data file and creates a texture from the associated image file.
sprite.newSpriteSet	Creates a new sprite set.
sprite.newSprite	Creates a new sprite.
sprite.add(sprite_set, animation_name, start_frame, frame_count, duration, loop_count )	Defines an animation for a given sprite set.

function sprite.newSpriteSheetFromData( file )

Loads a sprite sheet from a data file and creates a texture from the associated image file.

file	The name of the file to load.

The created sprite sheet.

function sprite.newSpriteSet( sprite_sheet,
start_frame,
frame_count )

Creates a new sprite set. A sprite set is a collection of frame sequences for a particular sprite within a sprite sheet.

sprite_sheet	the sprite sheet object containing the sprite set
start_frame	the first frame of the sprite set
frame_count	the number of frames in the sprite set

function sprite.newSprite( sprite_set )

Creates a new sprite. A sprite sprite is the actual on-screen object representing on or more frames in a sprite set.

sprite_set

the sprite set object containing the sprite

function sprite.add( sprite_set,
animation_name,
start_frame,
frame_duration,
loop_count )

Defines an animation for a given sprite set. Sprite sets can contain many animations.

sprite_set	the sprite set object containing the sprite
animation_name	the name of the animation.
start_frame	the first frame of the animation
frame_count	the number of frames in the animation
frame_duration	the duration of on frame in the animation, e.g., 0.1 for 10 fps
loop_count	the number of times the animation should loop.