TopDown Engine  v3.6
MoreMountains.Tools.MMSoundManagerSettings Class Reference

This class stores MMSoundManager settings and lets you tweak them from the MMSoundManagerSettingsSO's inspector More...

Public Attributes

bool OverrideMixerSettings = true
 whether or not the settings described below should override the ones defined in the AudioMixer More...
 
string MasterVolumeParameter = "MasterVolume"
 the name of the exposed MasterVolume parameter in the AudioMixer More...
 
string MusicVolumeParameter = "MusicVolume"
 the name of the exposed MusicVolume parameter in the AudioMixer More...
 
string SfxVolumeParameter = "SfxVolume"
 the name of the exposed SfxVolume parameter in the AudioMixer More...
 
string UIVolumeParameter = "UIVolume"
 the name of the exposed UIVolume parameter in the AudioMixer More...
 
float MasterVolume = _defaultVolume
 the master volume More...
 
bool MasterOn = true
 whether the master track is active at the moment or not More...
 
float MutedMasterVolume
 the volume of the master track before it was muted More...
 
float MusicVolume = _defaultVolume
 the music volume More...
 
bool MusicOn = true
 whether the music track is active at the moment or not More...
 
float MutedMusicVolume
 the volume of the music track before it was muted More...
 
float SfxVolume = _defaultVolume
 the sound fx volume More...
 
bool SfxOn = true
 whether the SFX track is active at the moment or not More...
 
float MutedSfxVolume
 the volume of the SFX track before it was muted More...
 
float UIVolume = _defaultVolume
 the UI sounds volume More...
 
bool UIOn = true
 whether the UI track is active at the moment or not More...
 
float MutedUIVolume
 the volume of the UI track before it was muted More...
 
bool AutoLoad = true
 whether or not the MMSoundManager should automatically load settings when starting More...
 
bool AutoSave = false
 whether or not each change in the settings should be automaticall saved. If not, you'll have to call a save MMSoundManager event for settings to be saved. More...
 

Static Public Attributes

const float _minimalVolume = 0.0001f
 
const float _maxVolume = 10f
 
const float _defaultVolume = 1f
 

Detailed Description

This class stores MMSoundManager settings and lets you tweak them from the MMSoundManagerSettingsSO's inspector

Member Data Documentation

◆ _defaultVolume

const float MoreMountains.Tools.MMSoundManagerSettings._defaultVolume = 1f
static

◆ _maxVolume

const float MoreMountains.Tools.MMSoundManagerSettings._maxVolume = 10f
static

◆ _minimalVolume

const float MoreMountains.Tools.MMSoundManagerSettings._minimalVolume = 0.0001f
static

◆ AutoLoad

bool MoreMountains.Tools.MMSoundManagerSettings.AutoLoad = true

whether or not the MMSoundManager should automatically load settings when starting

◆ AutoSave

bool MoreMountains.Tools.MMSoundManagerSettings.AutoSave = false

whether or not each change in the settings should be automaticall saved. If not, you'll have to call a save MMSoundManager event for settings to be saved.

◆ MasterOn

bool MoreMountains.Tools.MMSoundManagerSettings.MasterOn = true

whether the master track is active at the moment or not

◆ MasterVolume

float MoreMountains.Tools.MMSoundManagerSettings.MasterVolume = _defaultVolume

the master volume

◆ MasterVolumeParameter

string MoreMountains.Tools.MMSoundManagerSettings.MasterVolumeParameter = "MasterVolume"

the name of the exposed MasterVolume parameter in the AudioMixer

◆ MusicOn

bool MoreMountains.Tools.MMSoundManagerSettings.MusicOn = true

whether the music track is active at the moment or not

◆ MusicVolume

float MoreMountains.Tools.MMSoundManagerSettings.MusicVolume = _defaultVolume

the music volume

◆ MusicVolumeParameter

string MoreMountains.Tools.MMSoundManagerSettings.MusicVolumeParameter = "MusicVolume"

the name of the exposed MusicVolume parameter in the AudioMixer

◆ MutedMasterVolume

float MoreMountains.Tools.MMSoundManagerSettings.MutedMasterVolume

the volume of the master track before it was muted

◆ MutedMusicVolume

float MoreMountains.Tools.MMSoundManagerSettings.MutedMusicVolume

the volume of the music track before it was muted

◆ MutedSfxVolume

float MoreMountains.Tools.MMSoundManagerSettings.MutedSfxVolume

the volume of the SFX track before it was muted

◆ MutedUIVolume

float MoreMountains.Tools.MMSoundManagerSettings.MutedUIVolume

the volume of the UI track before it was muted

◆ OverrideMixerSettings

bool MoreMountains.Tools.MMSoundManagerSettings.OverrideMixerSettings = true

whether or not the settings described below should override the ones defined in the AudioMixer

◆ SfxOn

bool MoreMountains.Tools.MMSoundManagerSettings.SfxOn = true

whether the SFX track is active at the moment or not

◆ SfxVolume

float MoreMountains.Tools.MMSoundManagerSettings.SfxVolume = _defaultVolume

the sound fx volume

◆ SfxVolumeParameter

string MoreMountains.Tools.MMSoundManagerSettings.SfxVolumeParameter = "SfxVolume"

the name of the exposed SfxVolume parameter in the AudioMixer

◆ UIOn

bool MoreMountains.Tools.MMSoundManagerSettings.UIOn = true

whether the UI track is active at the moment or not

◆ UIVolume

float MoreMountains.Tools.MMSoundManagerSettings.UIVolume = _defaultVolume

the UI sounds volume

◆ UIVolumeParameter

string MoreMountains.Tools.MMSoundManagerSettings.UIVolumeParameter = "UIVolume"

the name of the exposed UIVolume parameter in the AudioMixer


The documentation for this class was generated from the following file: