Purpose

Determines whether a sprite object is locked or not

Protoype

bool CSpriteMngr::IsLocked (string str_sprite_id)

Parameters

Description

This function tests the sprite object passed in via str_sprite_id to see whether or not it is locked or not. A boolean value of TRUE or FALSE will be returned indicating the result of the test. If a sprite object is locked that means you can use the various animation access functions to extract data from its animations. Trying to do so without first locking a sprite object with LockSprite() will cause an error.

Use

CSpriteMngr sprite;

if (sprite.IsLocked("my_sprite"))
    // access sprite animation data