audio_sound_get_listener_mask

Gets the listener bit-mask data for a sound being played.

Syntax:

audio_sound_get_listener_mask(soundID);


Argument Description
soundID The unique ID of the sound to get the mask of


Returns: Real


Description

This function will return the bit-mask data that defines which audio listeners a sound should be played from.




Example:

var snd = audio_play_sound(snd_PlayerDead, 10, false);
if audio_sound_get_listener_mask(snd) != global.PlayerMask
   {
   audio_sound_set_listener_mask(snd, global.PlayerMask);
   }

The above code plays a sound then checks the listener mask data for the sound, and if it's not the same as that which is stored in a global variable, it sets the listener(s) to play from using the mask data stored in the global variable.


Back: Audio Listeners
Next: audio_emitter_get_listener_mask
© Copyright YoYo Games Ltd. 2015 All Rights Reserved