sprite_get_speed_type

This function can be used to retrieve the sprite animation type as defined for the sprite resource in the Sprite Editor. The value returned will be one of the following constants:

The following two examples illustrate the difference this can make when calculating animation speeds for the sprite:

• If you have a sprite that draws 1 frame per second and set the image speed to 0.5 it will draw at 0.5 frames per second. If your game frame rate is 60 frames per second then the sprite will draw 1 frame for every 120 game frames.
• If you have a sprite that draws 1 frame per game frame and set the image speed to 0.5 it will draw 0.5 frames per game frame. If your game frame rate is 60 frames per second then the sprite will draw 30 frames for every 60 game frames.

You can find out what the speed value used for the sprite animation was using the function sprite_get_speed(), and you can set the animation speed and type using the function sprite_set_speed().

Syntax:

sprite_get_speed_type(index)

Returns:

Constant (see above)

Example:

s_speed = sprite_get_speed(sprite_index);
s_type = sprite_get_speed_type(sprite_index);

The above code gets the sprite speed and the sprite animation type and stores them in instance variables for future use.