GetSpriteFrames

Syntax

UINT = GetSpriteFrames(sprite as POINTER)

Description

Returns the number of image frames available in a sprite.

Parameters

sprite - Sprite pointer returned by the LoadSprite function.

Return value

The total number of frames.

Remarks

Sprites can have any number of individual image frames. Set the currently displayed frame with the SPRITEFRAME command.

See Also: SPRITEFRAME, LOADSPRITE

Example usage

total_frames = GetSpriteFrames(goodguy)
IF current_frame < total_frames
    current_frame++
    SPRITEFRAME goodguy, current_frame
ELSE
    current_frame = 0
ENDIF