This feedback will let you play a sound via the MMSoundManager. You will need a game object in your scene with a MMSoundManager object on it for this to work. More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_MMSoundManagerSound:

Public Member Functions
override void	InitializeCustomAttributes ()
	Initializes the debug buttons More...

virtual void	RandomizeTimes ()
	Randomizes playback time and playback duration More...

override void	OnDrawGizmosSelectedHandler ()
	Triggered when the host MMF Player gets selected, can be used to draw gizmos More...

override void	AutomaticShakerSetup ()
	Automatically tries to add a MMSoundManager to the scene if none are present More...

virtual void	ResetSequentialIndex ()
	Forces a reset of the sequential index to 0 More...

virtual void	SetSequentialIndex (int newIndex)
	Forces a reset of the sequential index to the value specified in parameters More...

override void	OnValidate ()
	On validate we randomize our times More...

Public Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual float	ComputeIntensity (float intensity, Vector3 position)
	Computes the new intensity, taking into account constant intensity and potential randomness More...

virtual void	CacheRequiresSetup ()

virtual bool	EvaluateRequiresSetup ()
	Override this method to determine if a feedback requires setup More...

virtual void	SetFeedbackDuration (float newDuration)
	Use this method to change the duration of this feedback More...

virtual void	PreInitialization (MMF_Player owner, int index)
	Runs at Awake, lets you preinitialize your custom feedback before Initialization More...

virtual void	Initialization (MMF_Player owner, int index)
	Typically runs on Start, Initializes the feedback and its timing related variables More...

virtual void	SetIndexInFeedbacksList (int index)
	Lets you specify at what index this feedback is in the list - use carefully (or don't use at all) More...

virtual void	ForceAutomateTargetAcquisition ()
	Lets you force target acquisition, outside of initialization where it usually occurs More...

virtual void	Play (Vector3 position, float feedbacksIntensity=1.0f)
	Plays the feedback More...

virtual void	SetSequence (MMSequence newSequence)
	Use this method to change this feedback's sequence at runtime More...

virtual void	Stop (Vector3 position, float feedbacksIntensity=1.0f)
	Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations More...

virtual void	SkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	Called when skipping to the end of MMF_Player, calls custom Skip on all feedbacks More...

virtual void	ForceInitialValue (Vector3 position, float feedbacksIntensity=1.0f)
	Forces the feedback to set its initial value (behavior will change from feedback to feedback, but for example, a Position feedback that moves a Transform from point A to B would automatically move the Transform to point A when ForceInitialState is called More...

virtual void	RestoreInitialValues ()
	Called when restoring the initial state of a player, calls custom Restore on all feedbacks More...

virtual void	ResetFeedback ()
	Calls this feedback's custom reset More...

virtual void	PlayerComplete ()
	This gets called by the MMF Player when all feedbacks have completed playing More...

virtual void	SetDelayBetweenRepeats (float delay)
	Use this method to specify a new delay between repeats at runtime More...

virtual void	SetInitialDelay (float delay)
	Use this method to specify a new initial delay at runtime More...

virtual void	ComputeNewRandomDurationMultiplier ()
	Computes a new random duration multiplier More...

virtual void	ResetPlayCount ()
	Resets the play count of this feedback More...

virtual void	ComputeTotalDuration ()
	Computes the total duration of this feedback More...

virtual void	OnAddFeedback ()
	Triggered when the feedback gets added to the player More...

virtual void	OnDestroy ()
	Triggered when that feedback gets destroyed More...

virtual void	OnDisable ()
	Triggered when the host MMF Player gets disabled More...

Public Attributes
override bool	HasRandomness => true

AudioClip	Sfx
	the sound clip to play More...

AudioClip[]	RandomSfx
	an array to pick a random sfx from More...

bool	SequentialOrder = false
	if this is true, random sfx audio clips will be played in sequential order instead of at random More...

bool	SequentialOrderHoldLast = false
	if we're in sequential order, determines whether or not to hold at the last index, until either a cooldown is met, or the ResetSequentialIndex method is called More...

float	SequentialOrderHoldCooldownDuration = 2f
	if we're in sequential order hold last mode, index will reset to 0 automatically after this duration, unless it's 0, in which case it'll be ignored More...

bool	RandomUnique = false
	if this is true, sfx will be picked at random until all have been played. once this happens, the list is shuffled again, and it starts over More...

MMF_MMSoundManagerSoundData	SoundDataSO
	a scriptable object (created via the Create/MoreMountains/Audio/MMF_SoundData menu) to define settings that will override all other settings on this feedback More...

float	MinVolume = 1f
	the minimum volume to play the sound at More...

float	MaxVolume = 1f
	the maximum volume to play the sound at More...

float	MinPitch = 1f
	the minimum pitch to play the sound at More...

float	MaxPitch = 1f
	the maximum pitch to play the sound at More...

MMSoundManager.MMSoundManagerTracks	MmSoundManagerTrack = MMSoundManager.MMSoundManagerTracks.Sfx
	the track on which to play the sound. Pick the one that matches the nature of your sound More...

int	ID = 0
	the ID of the sound. This is useful if you plan on using sound control feedbacks on it afterwards. More...

AudioMixerGroup	AudioGroup = null
	the AudioGroup on which to play the sound. If you're already targeting a preset track, you can leave it blank, otherwise the group you specify here will override it. More...

AudioSource	RecycleAudioSource = null
	if (for some reason) you've already got an audiosource and wouldn't like to use the built-in pool system, you can specify it here More...

bool	Loop = false
	whether or not this sound should loop More...

bool	Persistent = false
	whether or not this sound should continue playing when transitioning to another scene More...

bool	DoNotPlayIfClipAlreadyPlaying = false
	whether or not this sound should play if the same sound clip is already playing More...

bool	StopSoundOnFeedbackStop = false
	if this is true, this sound will stop playing when stopping the feedback More...

bool	Fade = false
	whether or not to fade this sound in when playing it More...

float	FadeInitialVolume = 0f
	if fading, the volume at which to start the fade More...

float	FadeDuration = 1f
	if fading, the duration of the fade, in seconds More...

MMTweenType	FadeTween = new MMTweenType(MMTween.MMTweenCurve.EaseInOutQuartic)
	if fading, the tween over which to fade the sound More...

bool	SoloSingleTrack = false
	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 More...

bool	SoloAllTracks = false
	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 More...

bool	AutoUnSoloOnEnd = false
	if in any of the above solo modes, AutoUnSoloOnEnd will unmute the track(s) automatically once that sound stops playing More...

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

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. More...

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

bool	BypassEffects = false
	Bypass effects (Applied from filter components or global listener filters). More...

bool	BypassListenerEffects = false
	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. More...

bool	BypassReverbZones = false
	When set doesn't route the signal from an AudioSource into the global reverb associated with reverb zones. More...

int	Priority = 128
	Sets the priority of the AudioSource. More...

float	ReverbZoneMix = 1f
	The amount by which the signal from the AudioSource will be mixed into the global reverb associated with the Reverb Zones. More...

Vector2	PlaybackTime = new Vector2(0f, 0f)
	a timestamp (in seconds, randomized between the defined min and max) at which the sound will start playing, equivalent to the Audiosource API's Time) More...

Vector2	PlaybackDuration = new Vector2(0f, 0f)
	a duration (in seconds, randomized between the defined min and max) for which the sound will play before stopping. Ignored if min and max are zero. More...

float	DopplerLevel = 1f
	Sets the Doppler scale for this AudioSource. More...

int	Spread = 0
	Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space. More...

AudioRolloffMode	RolloffMode = AudioRolloffMode.Logarithmic
	Sets/Gets how the AudioSource attenuates over distance. More...

float	MinDistance = 1f
	Within the Min distance the AudioSource will cease to grow louder in volume. More...

float	MaxDistance = 500f
	(Logarithmic rolloff) MaxDistance is the distance a sound stops attenuating at. More...

bool	UseCustomRolloffCurve = false
	whether or not to use a custom curve for custom volume rolloff More...

AnimationCurve	CustomRolloffCurve
	the curve to use for custom volume rolloff if UseCustomRolloffCurve is true More...

bool	UseSpatialBlendCurve = false
	whether or not to use a custom curve for spatial blend More...

AnimationCurve	SpatialBlendCurve
	the curve to use for custom spatial blend if UseSpatialBlendCurve is true More...

bool	UseReverbZoneMixCurve = false
	whether or not to use a custom curve for reverb zone mix More...

AnimationCurve	ReverbZoneMixCurve
	the curve to use for custom reverb zone mix if UseReverbZoneMixCurve is true More...

bool	UseSpreadCurve = false
	whether or not to use a custom curve for spread More...

AnimationCurve	SpreadCurve
	the curve to use for custom spread if UseSpreadCurve is true More...

bool	DrawGizmos = false
	whether or not to draw sound falloff gizmos when this MMF Player is selected More...

Transform	GizmosCenter
	an object to use as the center of the gizmos. If left empty, this MMF Player's position will be used. More...

Color	MinDistanceColor = MMColors.CadetBlue
	the color to use to draw the min distance sphere of the sound falloff gizmos More...

Color	MaxDistanceColor = MMColors.Orangered
	the color to use to draw the max distance sphere of the sound falloff gizmos More...

MMF_Button	TestPlayButton
	a test button used to play the sound in inspector More...

MMF_Button	TestStopButton
	a test button used to stop the sound in inspector More...

MMF_Button	ResetSequentialIndexButton
	a test button used to stop the sound in inspector More...

Public Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
bool	Active = true
	whether or not this feedback is active More...

int	UniqueID

string	Label = "MMFeedback"
	the name of this feedback to display in the inspector More...

MMChannelModes	ChannelMode = MMChannelModes.Int

int	Channel = 0
	the ID of the channel on which this feedback will communicate More...

MMChannel	MMChannelDefinition = null

float	Chance = 100f
	the chance of this feedback happening (in percent : 100 : happens all the time, 0 : never happens, 50 : happens once every two calls, etc) More...

Color	DisplayColor = Color.black
	use this color to customize the background color of the feedback in the MMF_Player's list More...

MMFeedbackTiming	Timing
	a number of timing-related values (delay, repeat, etc) More...

MMFeedbackTargetAcquisition	AutomatedTargetAcquisition
	a set of settings letting you define automated target acquisition for this feedback, to (for example) automatically grab the target on this game object, or a parent, a child, or on a reference holder More...

bool	RandomizeOutput = false
	if this is true, intensity will be multiplied by a random value on play, picked between RandomMultiplier.x and RandomMultiplier.y More...

Vector2	RandomMultiplier = new Vector2(0.8f, 1f)
	a random value (randomized between its x and y) by which to multiply the output of this feedback, if RandomizeOutput is true More...

bool	RandomizeDuration = false
	if this is true, this feedback's duration will be multiplied by a random value on play, picked between RandomDurationMultiplier.x and RandomDurationMultiplier.y More...

Vector2	RandomDurationMultiplier = new Vector2(0.5f, 2f)
	a random value (randomized between its x and y) by which to multiply the duration of this feedback, if RandomizeDuration is true More...

bool	UseRange = false
	if this is true, only shakers within the specified range will respond to this feedback More...

float	RangeDistance = 5f
	when in UseRange mode, only shakers within that distance will respond to this feedback More...

bool	UseRangeFalloff = false
	when in UseRange mode, whether or not to modify the shake intensity based on the RangeFallOff curve More...

AnimationCurve	RangeFalloff = new AnimationCurve(new Keyframe(0f, 1f), new Keyframe(1f, 0f))
	the animation curve to use to define falloff (on the x 0 represents the range center, 1 represents the max distance to it) More...

Vector2	RemapRangeFalloff = new Vector2(0f, 1f)
	the values to remap the falloff curve's y axis' 0 and 1 More...

MMF_Button	AutomaticShakerSetupButton
	a button used to attempt an auto shaker setup for this feedback, adding whatever shaker it requires to function to the scene More...

MMF_Player	Owner
	the Owner of the feedback, as defined when calling the Initialization method More...

bool	DebugActive = false
	whether or not this feedback is in debug mode More...

virtual IEnumerator	Pause => null
	set this to true if your feedback should pause the execution of the feedback sequence More...

virtual bool	HoldingPause => false
	if this is true, this feedback will wait until all previous feedbacks have run More...

virtual bool	LooperPause => false
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	LooperStart => false
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	HasChannel => false
	if this is true, the Channel property will be displayed, otherwise it'll be hidden More...

virtual bool	HasAutomaticShakerSetup => false
	if this is true, this feedback will display an automatic shaker setup button More...

virtual bool	HasRandomness => false
	if this is true, the Randomness group will be displayed, otherwise it'll be hidden More...

virtual bool	CanForceInitialValue => false
	if this is true, this feedback implements ForceInitialState, otherwise calling that method will have no effect More...

virtual bool	ForceInitialValueDelayed => false
	if this is true, force initial value will happen over two frames More...

virtual bool	HasAutomatedTargetAcquisition => false
	whether or not this feedback can automatically grab the target on this game object, or a parent, a child, or on a reference holder More...

virtual bool	HasRange => false
	if this is true, the Range group will be displayed, otherwise it'll be hidden More...

virtual int	PlaysLeft => _playsLeft
	the total amount of plays this feedback has left More...

virtual bool	HasCustomInspectors => false

virtual bool	InCooldown
	returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise More...

virtual float	ComputedRandomMultiplier
	Returns the random multiplier to apply to this feedback's output More...

virtual bool	RequiresSetup => _requiresSetup
	A flag used to determine if a feedback has all it needs, or if it requires some extra setup. This flag will be used to display a warning icon in the inspector if the feedback is not ready to be played. More...

virtual string	RequiredTarget => _requiredTarget

virtual bool	DrawGroupInspectors => true
	if this is true, group inspectors will be displayed within this feedback More...

virtual bool	DisplayFullHeaderColor => false
	if this is true, the feedback will be displayed in the MMF Player's list with a full color background, as opposed to just a small line on the left More...

virtual string	RequiresSetupText => "This feedback requires some additional setup."
	defines the setup text that will be displayed on the feedback, should setup be required More...

virtual string	RequiredTargetText => ""
	the text used to describe the required target More...

virtual string	RequiredTargetTextExtra => ""
	the text used to describe the required target, if more info is needed More...

virtual float	FeedbackStartedAt => Application.isPlaying ? _lastPlayTimestamp : -1f

virtual bool	FeedbackPlaying
	whether or not this feedback is playing right now More...

virtual MMChannelData	ChannelData => _channelData.Set(ChannelMode, Channel, MMChannelDefinition)
	a ChannelData object, ready to pass to an event More...

Static Public Attributes
static bool	FeedbackTypeAuthorized = true
	a static bool used to disable all feedbacks of this type at once More...

Static Public Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
const string	_randomnessGroupName = "Feedback Randomness"

const string	_rangeGroupName = "Feedback Range"

const string	_automaticSetupGroupName = "Automatic Setup"

Protected Member Functions
override void	CustomInitialization (MMF_Player owner)
	This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method More...

override void	CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	Plays either a random sound or the specified sfx More...

override void	CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
	On Stop, we stop our sound if needed More...

virtual void	HandleSO ()
	If a scriptable object is specified, we grab its values More...

virtual void	PlaySound (AudioClip sfx, Vector3 position, float intensity)
	Triggers a play sound event More...

virtual float	GetDuration ()
	Returns the duration of the sound, or of the longest of the random sounds More...

virtual float	ComputeDuration (AudioClip sfx, AudioClip[] randomSfx)

virtual async void	TestPlaySound ()
	A test method that creates an audiosource, plays it, and destroys itself after play More...

virtual void	TestStopSound ()
	A test method that stops the test sound More...

virtual void	PlayAudioSource (AudioSource audioSource, AudioClip sfx, float volume, float pitch, float time, float playbackDuration)
	Plays the audio source with the specified volume and pitch More...

virtual AudioClip	PickRandomClip ()
	Determines the next index to play when dealing with random clips More...

Protected Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual void	AutomateTargetAcquisitionInternal ()
	Performs automated target acquisition, if needed More...

virtual void	AutomateTargetAcquisition ()
	A method meant to be implemented per feedback letting you specify what happens (usually setting a target) More...

virtual GameObject	FindAutomatedTargetGameObject ()

virtual T	FindAutomatedTarget< T > ()

virtual IEnumerator	PlayCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	An internal coroutine delaying the initial play of the feedback More...

virtual void	RegularPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Triggers delaying coroutines if needed More...

virtual void	TriggerCustomPlay (Vector3 position, float intensity)
	Triggers a custom play More...

virtual IEnumerator	InfinitePlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play without end More...

virtual IEnumerator	RepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play More...

virtual IEnumerator	TriggerRepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f)

virtual IEnumerator	SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	A coroutine used to play this feedback on a sequence More...

virtual IEnumerator	ForceInitialValueDelayedCo (Vector3 position, float feedbacksIntensity=1.0f)
	A coroutine used to delay the Stop when forcing initial values (used mostly with shaker based feedbacks) More...

virtual float	ApplyTimeMultiplier (float duration)
	Applies the host MMFeedbacks' time multiplier to this feedback More...

virtual IEnumerator	WaitFor (float delay)
	Internal method used to wait for a duration, on scaled or unscaled time More...

virtual float	ApplyDirection (float normalizedTime)
	Returns a new value of the normalized time based on the current play direction of this feedback More...

virtual void	CustomSkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets skipped to the end More...

virtual void	CustomRestoreInitialValues ()
	This method describes what happens when the feedback gets restored More...

virtual void	CustomPlayerComplete ()
	This method describes what happens when the player this feedback belongs to completes playing More...

virtual void	CustomReset ()
	This method describes what happens when the feedback gets reset More...

Protected Attributes
AudioClip	_randomClip

AudioSource	_editorAudioSource

MMSoundManagerPlayOptions	_options

AudioSource	_playedAudioSource

float	_randomPlaybackTime

float	_randomPlaybackDuration

int	_currentIndex = 0

Vector3	_gizmoCenter

MMShufflebag< int >	_randomUniqueShuffleBag

AudioClip	_lastPlayedClip

Protected Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
float	_lastPlayTimestamp = -1f

int	_playsLeft

bool	_initialized = false

Coroutine	_playCoroutine

Coroutine	_infinitePlayCoroutine

Coroutine	_sequenceCoroutine

Coroutine	_repeatedPlayCoroutine

bool	_requiresSetup = false

string	_requiredTarget = ""

float	_randomDurationMultiplier = 1f

int	_sequenceTrackID = 0

float	_beatInterval

bool	BeatThisFrame = false

int	LastBeatIndex = 0

int	CurrentSequenceIndex = 0

float	LastBeatTimestamp = 0f

MMChannelData	_channelData

float	_totalDuration = 0f

int	_indexInOwnerFeedbackList = 0

string	_requiredTargetTextCached = "."

string	_requiredTargetTextCachedExtra = ""

float	_repeatOffset = 0f

Properties
override float	FeedbackDuration `[get]`
	sets the inspector color for this feedback More...

Properties inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual bool	ScriptDrivenPause `[get, set]`
	if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution More...

virtual float	ScriptDrivenPauseAutoResume `[get, set]`
	if this is a positive value, the feedback will auto resume after that duration if it hasn't been resumed via script already More...

virtual MMF_ReferenceHolder	ForcedReferenceHolder `[get, set]`
	when in forced reference mode, this will contain the forced reference holder that will be used (usually set by itself) More...

virtual bool	IsPlaying `[get, set]`
	if this is true, this feedback is currently playing More...

virtual TimescaleModes	ComputedTimescaleMode `[get]`
	Returns the timescale mode to use in logic, taking into account the one set at the feedback level and the player level More...

virtual bool	InScaledTimescaleMode `[get]`
	returns true if this feedback is in Scaled timescale mode, false otherwise More...

virtual float	FeedbackTime `[get]`
	the time (or unscaled time) based on the selected Timing settings More...

virtual float	FeedbackDeltaTime `[get]`
	the delta time (or unscaled delta time) based on the selected Timing settings More...

virtual float	TotalDuration `[get]`
	The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats) More...

virtual bool	IsExpanded `[get, set]`

virtual string	RequiredChannelText `[get]`

virtual float	FeedbackDuration `[get, set]`

virtual float?	FinalNormalizedTime `[get]`
	Returns the t value at which to evaluate a curve at the end of this feedback's play time More...

virtual bool	NormalPlayDirection `[get]`
	Returns true if this feedback should play normally, or false if it should play in rewind More...

virtual bool	ShouldPlayInThisSequenceDirection `[get]`
	Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting More...

Detailed Description

This feedback will let you play a sound via the MMSoundManager. You will need a game object in your scene with a MMSoundManager object on it for this to work.

Member Function Documentation

◆ AutomaticShakerSetup()

override void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.AutomaticShakerSetup ( )

virtual

Automatically tries to add a MMSoundManager to the scene if none are present

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ ComputeDuration()

virtual float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.ComputeDuration	(	AudioClip	sfx,
		AudioClip[]	randomSfx
	)

protectedvirtual

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.CustomInitialization ( MMF_Player owner )

protectedvirtual

This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method

Parameters

owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.CustomPlayFeedback	(	Vector3	position,
		float	feedbacksIntensity = `1.0f`
	)

protectedvirtual

Plays either a random sound or the specified sfx

Parameters

position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.CustomStopFeedback	(	Vector3	position,
		float	feedbacksIntensity = `1`
	)

protectedvirtual

On Stop, we stop our sound if needed

Parameters

position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ GetDuration()

virtual float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.GetDuration ( )

protectedvirtual

Returns the duration of the sound, or of the longest of the random sounds

Returns

◆ HandleSO()

virtual void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.HandleSO ( )

protectedvirtual

If a scriptable object is specified, we grab its values

◆ InitializeCustomAttributes()

override void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.InitializeCustomAttributes ( )

virtual

Initializes the debug buttons

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ OnDrawGizmosSelectedHandler()

override void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.OnDrawGizmosSelectedHandler ( )

virtual

Triggered when the host MMF Player gets selected, can be used to draw gizmos

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ OnValidate()

override void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.OnValidate ( )

virtual

On validate we randomize our times

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ PickRandomClip()

virtual AudioClip MoreMountains.Feedbacks.MMF_MMSoundManagerSound.PickRandomClip ( )

protectedvirtual

Determines the next index to play when dealing with random clips

Returns

◆ PlayAudioSource()

virtual void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.PlayAudioSource	(	AudioSource	audioSource,
		AudioClip	sfx,
		float	volume,
		float	pitch,
		float	time,
		float	playbackDuration
	)

protectedvirtual

Plays the audio source with the specified volume and pitch

Parameters

audioSource
sfx
volume
pitch

◆ PlaySound()

virtual void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.PlaySound	(	AudioClip	sfx,
		Vector3	position,
		float	intensity
	)

protectedvirtual

Triggers a play sound event

Parameters

sfx
position
intensity

◆ RandomizeTimes()

virtual void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.RandomizeTimes ( )

virtual

Randomizes playback time and playback duration

◆ ResetSequentialIndex()

virtual void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.ResetSequentialIndex ( )

virtual

Forces a reset of the sequential index to 0

◆ SetSequentialIndex()

virtual void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.SetSequentialIndex ( int newIndex )

virtual

Forces a reset of the sequential index to the value specified in parameters

Parameters

newIndex

◆ TestPlaySound()

virtual async void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.TestPlaySound ( )

protectedvirtual

A test method that creates an audiosource, plays it, and destroys itself after play

◆ TestStopSound()

virtual void MoreMountains.Feedbacks.MMF_MMSoundManagerSound.TestStopSound ( )

protectedvirtual

A test method that stops the test sound

Member Data Documentation

◆ _currentIndex

int MoreMountains.Feedbacks.MMF_MMSoundManagerSound._currentIndex = 0

protected

◆ _editorAudioSource

AudioSource MoreMountains.Feedbacks.MMF_MMSoundManagerSound._editorAudioSource

protected

◆ _gizmoCenter

Vector3 MoreMountains.Feedbacks.MMF_MMSoundManagerSound._gizmoCenter

protected

◆ _lastPlayedClip

AudioClip MoreMountains.Feedbacks.MMF_MMSoundManagerSound._lastPlayedClip

protected

◆ _options

MMSoundManagerPlayOptions MoreMountains.Feedbacks.MMF_MMSoundManagerSound._options

protected

◆ _playedAudioSource

AudioSource MoreMountains.Feedbacks.MMF_MMSoundManagerSound._playedAudioSource

protected

◆ _randomClip

AudioClip MoreMountains.Feedbacks.MMF_MMSoundManagerSound._randomClip

protected

◆ _randomPlaybackDuration

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound._randomPlaybackDuration

protected

◆ _randomPlaybackTime

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound._randomPlaybackTime

protected

◆ _randomUniqueShuffleBag

MMShufflebag<int> MoreMountains.Feedbacks.MMF_MMSoundManagerSound._randomUniqueShuffleBag

protected

◆ AttachToTransform

Transform MoreMountains.Feedbacks.MMF_MMSoundManagerSound.AttachToTransform

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

◆ AudioGroup

AudioMixerGroup MoreMountains.Feedbacks.MMF_MMSoundManagerSound.AudioGroup = null

the AudioGroup on which to play the sound. If you're already targeting a preset track, you can leave it blank, otherwise the group you specify here will override it.

◆ AutoUnSoloOnEnd

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.AutoUnSoloOnEnd = false

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

◆ BypassEffects

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.BypassEffects = false

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

◆ BypassListenerEffects

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.BypassListenerEffects = false

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.Feedbacks.MMF_MMSoundManagerSound.BypassReverbZones = false

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

◆ CustomRolloffCurve

AnimationCurve MoreMountains.Feedbacks.MMF_MMSoundManagerSound.CustomRolloffCurve

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

◆ DoNotPlayIfClipAlreadyPlaying

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.DoNotPlayIfClipAlreadyPlaying = false

whether or not this sound should play if the same sound clip is already playing

◆ DopplerLevel

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.DopplerLevel = 1f

Sets the Doppler scale for this AudioSource.

◆ DrawGizmos

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.DrawGizmos = false

whether or not to draw sound falloff gizmos when this MMF Player is selected

◆ Fade

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.Fade = false

whether or not to fade this sound in when playing it

◆ FadeDuration

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.FadeDuration = 1f

if fading, the duration of the fade, in seconds

◆ FadeInitialVolume

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.FadeInitialVolume = 0f

if fading, the volume at which to start the fade

◆ FadeTween

MMTweenType MoreMountains.Feedbacks.MMF_MMSoundManagerSound.FadeTween = new MMTweenType(MMTween.MMTweenCurve.EaseInOutQuartic)

if fading, the tween over which to fade the sound

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.FeedbackTypeAuthorized = true

static

a static bool used to disable all feedbacks of this type at once

◆ GizmosCenter

Transform MoreMountains.Feedbacks.MMF_MMSoundManagerSound.GizmosCenter

an object to use as the center of the gizmos. If left empty, this MMF Player's position will be used.

◆ HasRandomness

override bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.HasRandomness => true

◆ ID

int MoreMountains.Feedbacks.MMF_MMSoundManagerSound.ID = 0

the ID of the sound. This is useful if you plan on using sound control feedbacks on it afterwards.

◆ Loop

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.Loop = false

whether or not this sound should loop

◆ MaxDistance

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MaxDistance = 500f

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

◆ MaxDistanceColor

Color MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MaxDistanceColor = MMColors.Orangered

the color to use to draw the max distance sphere of the sound falloff gizmos

◆ MaxPitch

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MaxPitch = 1f

the maximum pitch to play the sound at

◆ MaxVolume

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MaxVolume = 1f

the maximum volume to play the sound at

◆ MinDistance

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MinDistance = 1f

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

◆ MinDistanceColor

Color MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MinDistanceColor = MMColors.CadetBlue

the color to use to draw the min distance sphere of the sound falloff gizmos

◆ MinPitch

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MinPitch = 1f

the minimum pitch to play the sound at

◆ MinVolume

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MinVolume = 1f

the minimum volume to play the sound at

◆ MmSoundManagerTrack

MMSoundManager.MMSoundManagerTracks MoreMountains.Feedbacks.MMF_MMSoundManagerSound.MmSoundManagerTrack = MMSoundManager.MMSoundManagerTracks.Sfx

the track on which to play the sound. Pick the one that matches the nature of your sound

◆ PanStereo

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.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.Feedbacks.MMF_MMSoundManagerSound.Persistent = false

whether or not this sound should continue playing when transitioning to another scene

◆ PlaybackDuration

Vector2 MoreMountains.Feedbacks.MMF_MMSoundManagerSound.PlaybackDuration = new Vector2(0f, 0f)

a duration (in seconds, randomized between the defined min and max) for which the sound will play before stopping. Ignored if min and max are zero.

◆ PlaybackTime

Vector2 MoreMountains.Feedbacks.MMF_MMSoundManagerSound.PlaybackTime = new Vector2(0f, 0f)

a timestamp (in seconds, randomized between the defined min and max) at which the sound will start playing, equivalent to the Audiosource API's Time)

◆ Priority

int MoreMountains.Feedbacks.MMF_MMSoundManagerSound.Priority = 128

Sets the priority of the AudioSource.

◆ RandomSfx

AudioClip [] MoreMountains.Feedbacks.MMF_MMSoundManagerSound.RandomSfx

an array to pick a random sfx from

◆ RandomUnique

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.RandomUnique = false

if this is true, sfx will be picked at random until all have been played. once this happens, the list is shuffled again, and it starts over

◆ RecycleAudioSource

AudioSource MoreMountains.Feedbacks.MMF_MMSoundManagerSound.RecycleAudioSource = null

if (for some reason) you've already got an audiosource and wouldn't like to use the built-in pool system, you can specify it here

◆ ResetSequentialIndexButton

MMF_Button MoreMountains.Feedbacks.MMF_MMSoundManagerSound.ResetSequentialIndexButton

a test button used to stop the sound in inspector

◆ ReverbZoneMix

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.ReverbZoneMix = 1f

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

◆ ReverbZoneMixCurve

AnimationCurve MoreMountains.Feedbacks.MMF_MMSoundManagerSound.ReverbZoneMixCurve

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

◆ RolloffMode

AudioRolloffMode MoreMountains.Feedbacks.MMF_MMSoundManagerSound.RolloffMode = AudioRolloffMode.Logarithmic

Sets/Gets how the AudioSource attenuates over distance.

◆ SequentialOrder

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.SequentialOrder = false

if this is true, random sfx audio clips will be played in sequential order instead of at random

◆ SequentialOrderHoldCooldownDuration

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.SequentialOrderHoldCooldownDuration = 2f

if we're in sequential order hold last mode, index will reset to 0 automatically after this duration, unless it's 0, in which case it'll be ignored

◆ SequentialOrderHoldLast

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.SequentialOrderHoldLast = false

if we're in sequential order, determines whether or not to hold at the last index, until either a cooldown is met, or the ResetSequentialIndex method is called

◆ Sfx

AudioClip MoreMountains.Feedbacks.MMF_MMSoundManagerSound.Sfx

the sound clip to play

◆ SoloAllTracks

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.SoloAllTracks = false

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.Feedbacks.MMF_MMSoundManagerSound.SoloSingleTrack = false

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

◆ SoundDataSO

MMF_MMSoundManagerSoundData MoreMountains.Feedbacks.MMF_MMSoundManagerSound.SoundDataSO

a scriptable object (created via the Create/MoreMountains/Audio/MMF_SoundData menu) to define settings that will override all other settings on this feedback

◆ SpatialBlend

float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.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.Feedbacks.MMF_MMSoundManagerSound.SpatialBlendCurve

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

◆ Spread

int MoreMountains.Feedbacks.MMF_MMSoundManagerSound.Spread = 0

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

◆ SpreadCurve

AnimationCurve MoreMountains.Feedbacks.MMF_MMSoundManagerSound.SpreadCurve

the curve to use for custom spread if UseSpreadCurve is true

◆ StopSoundOnFeedbackStop

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.StopSoundOnFeedbackStop = false

if this is true, this sound will stop playing when stopping the feedback

◆ TestPlayButton

MMF_Button MoreMountains.Feedbacks.MMF_MMSoundManagerSound.TestPlayButton

a test button used to play the sound in inspector

◆ TestStopButton

MMF_Button MoreMountains.Feedbacks.MMF_MMSoundManagerSound.TestStopButton

a test button used to stop the sound in inspector

◆ UseCustomRolloffCurve

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.UseCustomRolloffCurve = false

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

◆ UseReverbZoneMixCurve

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.UseReverbZoneMixCurve = false

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

◆ UseSpatialBlendCurve

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.UseSpatialBlendCurve = false

whether or not to use a custom curve for spatial blend

◆ UseSpreadCurve

bool MoreMountains.Feedbacks.MMF_MMSoundManagerSound.UseSpreadCurve = false

whether or not to use a custom curve for spread

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_MMSoundManagerSound.FeedbackDuration

get

sets the inspector color for this feedback

the duration of this feedback is the duration of the clip being played

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

F:/Github/Store/Feel/Assets/Feel/MMFeedbacks/MMFeedbacksForThirdParty/MMTools/Feedbacks/MMF_MMSoundManagerSound.cs

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ AutomaticShakerSetup()

◆ ComputeDuration()

◆ CustomInitialization()

◆ CustomPlayFeedback()

◆ CustomStopFeedback()

◆ GetDuration()

◆ HandleSO()

◆ InitializeCustomAttributes()

◆ OnDrawGizmosSelectedHandler()

◆ OnValidate()

◆ PickRandomClip()

◆ PlayAudioSource()

◆ PlaySound()

◆ RandomizeTimes()

◆ ResetSequentialIndex()

◆ SetSequentialIndex()

◆ TestPlaySound()

◆ TestStopSound()

Member Data Documentation

◆ _currentIndex

◆ _editorAudioSource

◆ _gizmoCenter

◆ _lastPlayedClip

◆ _options

◆ _playedAudioSource

◆ _randomClip

◆ _randomPlaybackDuration

◆ _randomPlaybackTime

◆ _randomUniqueShuffleBag

◆ AttachToTransform

◆ AudioGroup

◆ AutoUnSoloOnEnd

◆ BypassEffects

◆ BypassListenerEffects

◆ BypassReverbZones

◆ CustomRolloffCurve

◆ DoNotPlayIfClipAlreadyPlaying

◆ DopplerLevel

◆ DrawGizmos

◆ Fade

◆ FadeDuration

◆ FadeInitialVolume

◆ FadeTween

◆ FeedbackTypeAuthorized

◆ GizmosCenter

◆ HasRandomness

◆ ID

◆ Loop

◆ MaxDistance

◆ MaxDistanceColor

◆ MaxPitch

◆ MaxVolume

◆ MinDistance

◆ MinDistanceColor

◆ MinPitch

◆ MinVolume

◆ MmSoundManagerTrack

◆ PanStereo

◆ Persistent

◆ PlaybackDuration

◆ PlaybackTime

◆ Priority

◆ RandomSfx

◆ RandomUnique

◆ RecycleAudioSource

◆ ResetSequentialIndexButton

◆ ReverbZoneMix

◆ ReverbZoneMixCurve

◆ RolloffMode

◆ SequentialOrder

◆ SequentialOrderHoldCooldownDuration

◆ SequentialOrderHoldLast