audio_play_sound_on(emitter, sound, loop, priority);
| Argument | Description |
|---|---|
| emitter | The index of the emitter to use. |
| sound | The index of the sound to use. |
| loop | Flags the sound as looping or not. |
| priority | Set the channel priority for the sound. |
Returns: Index
With this function you can play any sound resource through an
emitter, with any changes to the emitter gain, position, pitch or
velocity affecting how the user hears the final sound being played.
You provide the emitter index to use, the sound index of the sound
to be played and then specify whether the sound is to loop or not.
Finally you can assign 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 will prioritize them the same).
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.
if global.SFX
{
audio_play_sound_on(s_emit, snd_Explode, false,
1);
}
The above code checks the global variable "SFX" and if it returns true then the sound indexed in the variable "snd_Explode" will be played through the emitter indexed in the variable "s_emit" with a low priority and no looping.