audio_play_sound


Description

With this function you can play any sound resource in your game. You provide the sound index and assign it a priority, which is then used to determine how sounds are dealt with when the number of sounds playing is over the limit set by the function audio_channel_num. Lower priority sounds will be stopped in favour of higher priority sounds, and the priority value can be any real number (the actual value is arbitrary, and can be from 0 to 1 or 0 to 100, as GameMaker Studio 2 will prioritize them the same). The final argument is for making the sound loop and setting it to true will make the sound loop until it is stopped and setting it to false will play the sound once only.

This function will also return a unique index number for the sound being played which can then be stored in a variable so that you can then pause it or stop it with the appropriate functions. This means that if you have multiple instances of the same sound playing at any one time you can target just one instance of that sound to deal with using the audio functions.


Plays the indicated sound.

Syntax:

audio_play_sound(index, priority, loop);


Argument Description
index The index of the sound to play.
priority Set the channel priority for the sound.
loop Sets the sound to loop or not.


Returns:

Index


Example:

if health <= 0
   {
   lives -= 1;
   audio_play_sound(snd_PlayerDead, 10, false);
   }

The above code checks the "health" global variable and if it is less than or equal to 0, it will remove 1 from the "lives" global variable and play a sound.