Table of Contents

 
GetFrameDelay
 

Purpose

Returns the frame delay for the animation in milliseconds

 

Protoype

int CSpriteMngr::GetFrameDelay (string str_anim_id = "")
 

Parameters

anim_id the ID of the animation to access
 

Description

This function extracts the frame delay assigned to this animation. The returned value is in milliseconds. If there is already an animation loaded with LoadAnimation(), then you can extract the value from that animation without having to specify it. However if there is no loaded animation or you want to access an animation not loaded, then you must pass in its ID for str_anim_id.

NOTE: There must be a locked sprite object in order for this function to work

 

Use

CSpriteMngr sprite;
// access loaded animation
int i_frame_delay = sprite.GetFrameDelay();
// access another animation
int i_frame_delay = sprite.GetFrameDelay("nuther_anim");
 

Prev: GetDirection