Table of Contents

 
IsReserved
 

Purpose

Returns whether the clip is reserved or not

 

Protoype

bool CSoundMngr::IsReserved (string str_id)
 

Parameters

id the ID of the sound object to query
 

Description

This function returns the value of the sound object's reserve flag. If the sound clip is reserved, then the function returns TRUE, otherwise it returns FALSE.

NOTE: This is a channel function, which means it can be used for both music and sfx objects. The function itself will handle distinguishing between the two.

 

Use

CSoundMngr sound;
if (sound.IsReserved("my_sound"))
    // sound is reserved
 

Prev: IsPlaying
Next: LoadMusic