Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Notice
This set of functions is available when the FMOD plugin is loaded.
Represents a global mixer bus.
Bus Class
Members
void setPaused ( int paused ) #
Sets the pause state for the bus.Arguments
- int paused - 1 to pause the bus, 0 to unpause it.
int isPaused ( ) #
Returns the pause state.Return value
1 if the bus is paused, otherwise, 0.void setVolume ( float volume ) #
Sets the volume level.Arguments
- float volume - Volume level in range [-inf; inf].
float getVolume ( ) #
Returns the current volume level.Return value
Volume level.void setMuted ( int muted ) #
Sets the mute state.Arguments
- int muted - 1to mute the bus, 0 to unmute it.
int isMuted ( ) #
Returns the mute state.Return value
1 if the bus is muted, otherwise, 0.void stopAllEvents ( ) #
Stops all event instances that are routed into the bus.void release ( ) #
Releases the bus object.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)