Purpose

Returns the frame currently being used for display when the animation is stopped

Protoype

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

Parameters

Description

This function extracts the frame number that the animation reverts to when it is stopped. The function will return NO_DEF_FRAME if there is no default frame set for this animation. 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_def = sprite.GetDefaultFrame();

// access another animation
int i_def2 = sprite.GetDefaultFrame("nuther_anim");