A class used to store options for MMSoundManager play. More...

Public Attributes
bool	Initialized
AudioResource	AudioResourceToPlay
MMSoundManager.MMSoundManagerTracks	MmSoundManagerTrack
	the track on which to play the sound
AudioMixerGroup	AudioGroup
	an audiogroup to use if you don't want to play on any of the preset tracks
bool	Loop
	whether or not the sound should loop
float	Volume
	the volume at which to play the sound
float	Pitch
	The pitch of the audio source.
int	ID
	the ID of the sound, useful to find that sound again later
bool	Fade
	whether or not to fade the sound when playing it
float	FadeInitialVolume
	the initial volume of the sound, before the fade
float	FadeDuration
	the duration of the fade, in seconds
MMTweenType	FadeTween
	the tween to use when fading the sound
bool	Persistent
	whether or not the sound should persist over scene transitions
AudioSource	RecycleAudioSource
	an AudioSource to use if you don't want to pick one from the pool
float	InitialDelay
	a delay in seconds to apply before playing a song
float	PlaybackTime
	The time (in seconds) at which to start playing the sound.
float	PlaybackDuration
	The time (in seconds after which to stop playing the sound.
float	PanStereo
	Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo.
float	SpatialBlend
	Sets how much this AudioSource is affected by 3D spatialisation calculations (attenuation, doppler etc). 0.0 makes the sound full 2D, 1.0 makes it full 3D.
Transform	AttachToTransform
	a Transform this sound can 'attach' to and follow it along as it plays
bool	SoloSingleTrack
	whether or not this sound should play in solo mode over its destination track. If yes, all other sounds on that track will be muted when this sound starts playing
bool	SoloAllTracks
	whether or not this sound should play in solo mode over all other tracks. If yes, all other tracks will be muted when this sound starts playing
bool	AutoUnSoloOnEnd
	if in any of the solo modes, AutoUnSoloOnEnd will unmute the track(s) automatically once that sound stops playing
bool	BypassEffects
	Bypass effects (Applied from filter components or global listener filters).
bool	BypassListenerEffects
	When set global effects on the AudioListener will not be applied to the audio signal generated by the AudioSource. Does not apply if the AudioSource is playing into a mixer group.
bool	BypassReverbZones
	When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones.
int	Priority
	Sets the priority of the AudioSource.
float	ReverbZoneMix
	The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones.
float	DopplerLevel
	Sets the Doppler scale for this AudioSource.
Vector3	Location
	the location at which to position the sound
int	Spread
	Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space.
AudioRolloffMode	RolloffMode
	Sets/Gets how the AudioSource attenuates over distance.
float	MinDistance
	Within the Min distance the AudioSource will cease to grow louder in volume.
float	MaxDistance
	(Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at.
bool	DoNotAutoRecycleIfNotDonePlaying
	Whether or not the source should be auto recycled if not done playing.
bool	UseCustomRolloffCurve
	whether or not to use a custom curve for custom volume rolloff
AnimationCurve	CustomRolloffCurve
	the curve to use for custom volume rolloff if UseCustomRolloffCurve is true
bool	UseSpatialBlendCurve
	whether or not to use a custom curve for spatial blend
AnimationCurve	SpatialBlendCurve
	the curve to use for custom spatial blend if UseSpatialBlendCurve is true
bool	UseReverbZoneMixCurve
	whether or not to use a custom curve for reverb zone mix
AnimationCurve	ReverbZoneMixCurve
	the curve to use for custom reverb zone mix if UseReverbZoneMixCurve is true
bool	UseSpreadCurve
	whether or not to use a custom curve for spread
AnimationCurve	SpreadCurve
	the curve to use for custom spread if UseSpreadCurve is true

Properties
static MMSoundManagerPlayOptions	Default `[get]`
	A default set of options, meant to suit most common cases. When using options, it's a good idea to start with that and override only what you need to.

Detailed Description

A class used to store options for MMSoundManager play.

Member Data Documentation

◆ AttachToTransform

Transform MoreMountains.Tools.MMSoundManagerPlayOptions.AttachToTransform

a Transform this sound can 'attach' to and follow it along as it plays

◆ AudioGroup

AudioMixerGroup MoreMountains.Tools.MMSoundManagerPlayOptions.AudioGroup

an audiogroup to use if you don't want to play on any of the preset tracks

◆ AudioResourceToPlay

AudioResource MoreMountains.Tools.MMSoundManagerPlayOptions.AudioResourceToPlay

◆ AutoUnSoloOnEnd

bool MoreMountains.Tools.MMSoundManagerPlayOptions.AutoUnSoloOnEnd

if in any of the solo modes, AutoUnSoloOnEnd will unmute the track(s) automatically once that sound stops playing

◆ BypassEffects

bool MoreMountains.Tools.MMSoundManagerPlayOptions.BypassEffects

Bypass effects (Applied from filter components or global listener filters).

◆ BypassListenerEffects

bool MoreMountains.Tools.MMSoundManagerPlayOptions.BypassListenerEffects

When set global effects on the AudioListener will not be applied to the audio signal generated by the AudioSource. Does not apply if the AudioSource is playing into a mixer group.

◆ BypassReverbZones

bool MoreMountains.Tools.MMSoundManagerPlayOptions.BypassReverbZones

When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones.

◆ CustomRolloffCurve

AnimationCurve MoreMountains.Tools.MMSoundManagerPlayOptions.CustomRolloffCurve

the curve to use for custom volume rolloff if UseCustomRolloffCurve is true

◆ DoNotAutoRecycleIfNotDonePlaying

bool MoreMountains.Tools.MMSoundManagerPlayOptions.DoNotAutoRecycleIfNotDonePlaying

Whether or not the source should be auto recycled if not done playing.

◆ DopplerLevel

float MoreMountains.Tools.MMSoundManagerPlayOptions.DopplerLevel

Sets the Doppler scale for this AudioSource.

◆ Fade

bool MoreMountains.Tools.MMSoundManagerPlayOptions.Fade

whether or not to fade the sound when playing it

◆ FadeDuration

float MoreMountains.Tools.MMSoundManagerPlayOptions.FadeDuration

the duration of the fade, in seconds

◆ FadeInitialVolume

float MoreMountains.Tools.MMSoundManagerPlayOptions.FadeInitialVolume

the initial volume of the sound, before the fade

◆ FadeTween

MMTweenType MoreMountains.Tools.MMSoundManagerPlayOptions.FadeTween

the tween to use when fading the sound

◆ ID

int MoreMountains.Tools.MMSoundManagerPlayOptions.ID

the ID of the sound, useful to find that sound again later

◆ InitialDelay

float MoreMountains.Tools.MMSoundManagerPlayOptions.InitialDelay

a delay in seconds to apply before playing a song

◆ Initialized

bool MoreMountains.Tools.MMSoundManagerPlayOptions.Initialized

◆ Location

Vector3 MoreMountains.Tools.MMSoundManagerPlayOptions.Location

the location at which to position the sound

◆ Loop

bool MoreMountains.Tools.MMSoundManagerPlayOptions.Loop

whether or not the sound should loop

◆ MaxDistance

float MoreMountains.Tools.MMSoundManagerPlayOptions.MaxDistance

(Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at.

◆ MinDistance

float MoreMountains.Tools.MMSoundManagerPlayOptions.MinDistance

Within the Min distance the AudioSource will cease to grow louder in volume.

◆ MmSoundManagerTrack

MMSoundManager.MMSoundManagerTracks MoreMountains.Tools.MMSoundManagerPlayOptions.MmSoundManagerTrack

the track on which to play the sound

◆ PanStereo

float MoreMountains.Tools.MMSoundManagerPlayOptions.PanStereo

Pans a playing sound in a stereo way (left or right). This only applies to sounds that are Mono or Stereo.

◆ Persistent

bool MoreMountains.Tools.MMSoundManagerPlayOptions.Persistent

whether or not the sound should persist over scene transitions

◆ Pitch

float MoreMountains.Tools.MMSoundManagerPlayOptions.Pitch

The pitch of the audio source.

◆ PlaybackDuration

float MoreMountains.Tools.MMSoundManagerPlayOptions.PlaybackDuration

The time (in seconds after which to stop playing the sound.

◆ PlaybackTime

float MoreMountains.Tools.MMSoundManagerPlayOptions.PlaybackTime

The time (in seconds) at which to start playing the sound.

◆ Priority

int MoreMountains.Tools.MMSoundManagerPlayOptions.Priority

Sets the priority of the AudioSource.

◆ RecycleAudioSource

AudioSource MoreMountains.Tools.MMSoundManagerPlayOptions.RecycleAudioSource

an AudioSource to use if you don't want to pick one from the pool

◆ ReverbZoneMix

float MoreMountains.Tools.MMSoundManagerPlayOptions.ReverbZoneMix

The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones.

◆ ReverbZoneMixCurve

AnimationCurve MoreMountains.Tools.MMSoundManagerPlayOptions.ReverbZoneMixCurve

the curve to use for custom reverb zone mix if UseReverbZoneMixCurve is true

◆ RolloffMode

AudioRolloffMode MoreMountains.Tools.MMSoundManagerPlayOptions.RolloffMode

Sets/Gets how the AudioSource attenuates over distance.

◆ SoloAllTracks

bool MoreMountains.Tools.MMSoundManagerPlayOptions.SoloAllTracks

whether or not this sound should play in solo mode over all other tracks. If yes, all other tracks will be muted when this sound starts playing

◆ SoloSingleTrack

bool MoreMountains.Tools.MMSoundManagerPlayOptions.SoloSingleTrack

whether or not this sound should play in solo mode over its destination track. If yes, all other sounds on that track will be muted when this sound starts playing

◆ SpatialBlend

float MoreMountains.Tools.MMSoundManagerPlayOptions.SpatialBlend

Sets how much this AudioSource is affected by 3D spatialisation calculations (attenuation, doppler etc). 0.0 makes the sound full 2D, 1.0 makes it full 3D.

◆ SpatialBlendCurve

AnimationCurve MoreMountains.Tools.MMSoundManagerPlayOptions.SpatialBlendCurve

the curve to use for custom spatial blend if UseSpatialBlendCurve is true

◆ Spread

int MoreMountains.Tools.MMSoundManagerPlayOptions.Spread

Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space.

◆ SpreadCurve

AnimationCurve MoreMountains.Tools.MMSoundManagerPlayOptions.SpreadCurve

the curve to use for custom spread if UseSpreadCurve is true

◆ UseCustomRolloffCurve

bool MoreMountains.Tools.MMSoundManagerPlayOptions.UseCustomRolloffCurve

whether or not to use a custom curve for custom volume rolloff

◆ UseReverbZoneMixCurve

bool MoreMountains.Tools.MMSoundManagerPlayOptions.UseReverbZoneMixCurve

whether or not to use a custom curve for reverb zone mix

◆ UseSpatialBlendCurve

bool MoreMountains.Tools.MMSoundManagerPlayOptions.UseSpatialBlendCurve

whether or not to use a custom curve for spatial blend

◆ UseSpreadCurve

bool MoreMountains.Tools.MMSoundManagerPlayOptions.UseSpreadCurve

whether or not to use a custom curve for spread

◆ Volume

float MoreMountains.Tools.MMSoundManagerPlayOptions.Volume

the volume at which to play the sound

Property Documentation

◆ Default

MMSoundManagerPlayOptions MoreMountains.Tools.MMSoundManagerPlayOptions.Default

staticget

A default set of options, meant to suit most common cases. When using options, it's a good idea to start with that and override only what you need to.

Example :

MMSoundManagerPlayOptions options = MMSoundManagerPlayOptions.Default; options.Loop = Loop; options.Location = Vector3.zero; options.MmSoundManagerTrack = MMSoundManager.MMSoundManagerTracks.Music;

MMSoundManagerSoundPlayEvent.Trigger(SoundClip, options);

Here we initialize a new local options set, override its loop, location and track settings, and call a play event using it

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

H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMTools/Core/MMAudio/MMSoundManager/MMSoundManagerPlayOptions.cs

Public Attributes

Properties