Firelight Technologies FMOD Studio API
Studio::EventInstance::setListenerMask
Set the mask of what listeners apply to this event instance.
C++ Syntax
FMOD_RESULT Studio::EventInstance::setListenerMask(
unsigned int mask
);
C Syntax
FMOD_RESULT FMOD_Studio_EventInstance_SetListenerMask(
FMOD_STUDIO_EVENTINSTANCE *eventinstance,
unsigned int mask
);
C# Syntax
RESULT Studio.EventInstance.setListenerMask(
uint mask
);
JavaScript Syntax
EventInstance.setListenerMask(
mask
);
Parameters
- mask
- Mask of listeners that apply to this event instance.
Return Values
If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.
Remarks
The default mask is 0xffffffff, which is for all listeners to be enabled.
NOTE: It is an error to set a mask that does not include at least one active listener.
See Also
Version 1.10.03 Built on Feb 1, 2018