Home > Commands > Sprite > SetSpriteSpeed

SetSpriteSpeed

Description

Sets the sprite animation to a specified speed, can be used whilst the animation is running. Can be set to 0 to temporarily pause the animation.

Definition

SetSpriteSpeed( iSpriteIndex, fFps )

Parameters

iSpriteIndex - The ID of the sprite to modify.
fFps - the rate at which the sprite should update, sprite frames will be skipped if the sprite frame rate is too high compared to the game frame rate.