Recent Changes - Search:

Documentation

Help

Tutorials

RoadMap

Help Docs for wiki writers:

PmWiki

edit SideBar

CreateSound

Sound* CreateSound(
std::string _GroupName,
std::string _FileName,
int _Channel,
int _NumberOfTimesToLoop,
int _Volume
)

Public function of the Epee Engine Class

Description:
creates a new Sound and adds it to the sound list

Arguments:

Required:
std::string _GroupName
Name of the sound object
used for the find and destroy sound arguments.
not really a group name

std::string _FileName
name of the sound file you want to load and attach to the Sound object for playback later

Optional:
int _Channel
channel the Sound object is attached to
defaults to 0

int _NumberOfTimesToLoop
number of times the sound will play
setting this to zero will cause the sound to loop forever
defaults to 0

int _Volume
sets the volume used when playing the sound
defaults to MIX_MAX_VOLUME

Return Value:
if the sound is created successfully a pointer to the new Sound object is returned other wise a NULL pointer is returned

Edit - History - Print - Recent Changes - Search
Page last modified on April 09, 2007, at 01:51 PM