Feel 5.9.1
The best way to improve your game's feel and make it extra juicy
Loading...
Searching...
No Matches
MoreMountains.Tools.MMSoundManagerSettingsSO Class Reference

A class to save sound settings (music on or off, sfx on or off) More...

Inheritance diagram for MoreMountains.Tools.MMSoundManagerSettingsSO:

Public Member Functions

virtual void SaveSoundSettings ()
 Saves the sound settings to file.
virtual void LoadSoundSettings ()
 Loads the sound settings from file (if found)
virtual void ResetSoundSettings ()
 Resets the sound settings by destroying the save file.
virtual void SetTrackVolume (MMSoundManager.MMSoundManagerTracks track, float volume)
 sets the volume of the selected track to the value passed in parameters
virtual float GetTrackVolume (MMSoundManager.MMSoundManagerTracks track)
 Returns the volume of the specified track.
virtual void GetTrackVolumes ()
 assigns the volume of each track to the settings values
virtual float NormalizedToMixerVolume (float normalizedVolume)
 Converts a normalized volume to the mixer group db scale.
virtual float MixerVolumeToNormalized (float mixerVolume)
 Converts mixer volume to a normalized value.

Public Attributes

AudioMixer TargetAudioMixer
 the audio mixer to use when playing sounds
AudioMixerGroup MasterAudioMixerGroup
 the master group
AudioMixerGroup MusicAudioMixerGroup
 the group on which to play all music sounds
AudioMixerGroup SfxAudioMixerGroup
 the group on which to play all sound effects
AudioMixerGroup UIAudioMixerGroup
 the group on which to play all UI sounds
float MixerValuesMultiplier = 20
 the multiplier to apply when converting normalized volume values to audio mixer values
MMSoundManagerSettings Settings
 the full settings for this MMSoundManager

Protected Member Functions

virtual void ApplyTrackVolumes ()
 applies volume to all tracks and saves if needed

Static Protected Attributes

const string _saveFolderName = "MMSoundManager/"
const string _saveFileName = "mmsound.settings"

Detailed Description

A class to save sound settings (music on or off, sfx on or off)

Member Function Documentation

◆ ApplyTrackVolumes()

virtual void MoreMountains.Tools.MMSoundManagerSettingsSO.ApplyTrackVolumes ( )
protectedvirtual

applies volume to all tracks and saves if needed

◆ GetTrackVolume()

virtual float MoreMountains.Tools.MMSoundManagerSettingsSO.GetTrackVolume ( MMSoundManager.MMSoundManagerTracks track)
virtual

Returns the volume of the specified track.

Parameters
track
Returns

◆ GetTrackVolumes()

virtual void MoreMountains.Tools.MMSoundManagerSettingsSO.GetTrackVolumes ( )
virtual

assigns the volume of each track to the settings values

◆ LoadSoundSettings()

virtual void MoreMountains.Tools.MMSoundManagerSettingsSO.LoadSoundSettings ( )
virtual

Loads the sound settings from file (if found)

◆ MixerVolumeToNormalized()

virtual float MoreMountains.Tools.MMSoundManagerSettingsSO.MixerVolumeToNormalized ( float mixerVolume)
virtual

Converts mixer volume to a normalized value.

Parameters
mixerVolume
Returns

◆ NormalizedToMixerVolume()

virtual float MoreMountains.Tools.MMSoundManagerSettingsSO.NormalizedToMixerVolume ( float normalizedVolume)
virtual

Converts a normalized volume to the mixer group db scale.

Parameters
normalizedVolume
Returns

◆ ResetSoundSettings()

virtual void MoreMountains.Tools.MMSoundManagerSettingsSO.ResetSoundSettings ( )
virtual

Resets the sound settings by destroying the save file.

◆ SaveSoundSettings()

virtual void MoreMountains.Tools.MMSoundManagerSettingsSO.SaveSoundSettings ( )
virtual

Saves the sound settings to file.

◆ SetTrackVolume()

virtual void MoreMountains.Tools.MMSoundManagerSettingsSO.SetTrackVolume ( MMSoundManager.MMSoundManagerTracks track,
float volume )
virtual

sets the volume of the selected track to the value passed in parameters

Parameters
track
volume

Member Data Documentation

◆ _saveFileName

const string MoreMountains.Tools.MMSoundManagerSettingsSO._saveFileName = "mmsound.settings"
staticprotected

◆ _saveFolderName

const string MoreMountains.Tools.MMSoundManagerSettingsSO._saveFolderName = "MMSoundManager/"
staticprotected

◆ MasterAudioMixerGroup

AudioMixerGroup MoreMountains.Tools.MMSoundManagerSettingsSO.MasterAudioMixerGroup

the master group

◆ MixerValuesMultiplier

float MoreMountains.Tools.MMSoundManagerSettingsSO.MixerValuesMultiplier = 20

the multiplier to apply when converting normalized volume values to audio mixer values

◆ MusicAudioMixerGroup

AudioMixerGroup MoreMountains.Tools.MMSoundManagerSettingsSO.MusicAudioMixerGroup

the group on which to play all music sounds

◆ Settings

MMSoundManagerSettings MoreMountains.Tools.MMSoundManagerSettingsSO.Settings

the full settings for this MMSoundManager

◆ SfxAudioMixerGroup

AudioMixerGroup MoreMountains.Tools.MMSoundManagerSettingsSO.SfxAudioMixerGroup

the group on which to play all sound effects

◆ TargetAudioMixer

AudioMixer MoreMountains.Tools.MMSoundManagerSettingsSO.TargetAudioMixer

the audio mixer to use when playing sounds

◆ UIAudioMixerGroup

AudioMixerGroup MoreMountains.Tools.MMSoundManagerSettingsSO.UIAudioMixerGroup

the group on which to play all UI sounds

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