Inheritance diagram for MoreMountains.Feedbacks.MMFeedbackSound:

Public Types
enum	PlayMethods { Event , Cached , OnDemand , Pool }
	sets the inspector color for this feedback More...

Public Attributes
AudioClip	Sfx
	the sound clip to play More...

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

bool	TestButton

bool	TestStopButton

PlayMethods	PlayMethod = PlayMethods.Event
	the play method to use when playing the sound (event, cached or on demand) More...

int	PoolSize = 10
	the size of the pool when in Pool mode 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...

AudioMixerGroup	SfxAudioMixerGroup
	the audiomixer to play the sound with (optional) More...

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

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

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

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

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

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

Protected Member Functions
override void	CustomInitialization (GameObject owner)
	Custom init to cache the audiosource if required More...

virtual AudioSource	CreateAudioSource (GameObject owner, string audioSourceName)

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

virtual float	GetDuration ()

virtual void	PlaySound (AudioClip sfx, Vector3 position, float intensity)
	Plays a sound differently based on the selected play method More...

virtual void	PlayAudioSource (AudioSource audioSource, AudioClip sfx, float volume, float pitch, int timeSamples, AudioMixerGroup audioMixerGroup=null)
	Plays the audio source with the specified volume and pitch More...

virtual AudioSource	GetAudioSourceFromPool ()
	Gets an audio source from the pool if possible More...

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

Protected Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual void	OnEnable ()

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 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	SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	A coroutine used to play this feedback on a sequence 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 float	ApplyTimeMultiplier (float duration)
	Applies the host MMFeedbacks' time multiplier to this feedback More...

virtual void	CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets stopped More...

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

Protected Attributes
AudioClip	_randomClip

AudioSource	_cachedAudioSource

AudioSource[]	_pool

AudioSource	_tempAudioSource

float	_duration

AudioSource	_editorAudioSource

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

int	_playsLeft

bool	_initialized = false

Coroutine	_playCoroutine

Coroutine	_infinitePlayCoroutine

Coroutine	_sequenceCoroutine

Coroutine	_repeatedPlayCoroutine

int	_sequenceTrackID = 0

MMFeedbacks	_hostMMFeedbacks

float	_beatInterval

bool	BeatThisFrame = false

int	LastBeatIndex = 0

int	CurrentSequenceIndex = 0

float	LastBeatTimestamp = 0f

bool	_isHostMMFeedbacksNotNull

Properties
override float	FeedbackDuration `[get]`
	the duration of this feedback is the duration of the clip being played More...

Properties inherited from MoreMountains.Feedbacks.MMFeedback
GameObject	Owner `[getset]`
	the Owner of the feedback, as defined when calling the Initialization method More...

virtual IEnumerator	Pause `[get]`
	set this to true if your feedback should pause the execution of the feedback sequence More...

virtual bool	HoldingPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run More...

virtual bool	LooperPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	ScriptDrivenPause `[getset]`
	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 `[getset]`
	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 bool	LooperStart `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

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

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

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

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

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

virtual float	FeedbackStartedAt `[get]`

virtual float	FeedbackDuration `[getset]`

virtual bool	FeedbackPlaying `[get]`
	whether or not this feedback is playing right now 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...

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

Additional Inherited Members
Public Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual void	Initialization (GameObject owner)
	Initializes the feedback and its timing related variables More...

virtual void	Play (Vector3 position, float feedbacksIntensity=1.0f)
	Plays the feedback 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	ResetFeedback ()
	Calls this feedback's custom reset More...

virtual void	SetSequence (MMSequence newSequence)
	Use this method to change this feedback's sequence at runtime 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...

Member Enumeration Documentation

◆ PlayMethods

enum MoreMountains.Feedbacks.MMFeedbackSound.PlayMethods

sets the inspector color for this feedback

The possible methods to play the sound with. Event : sends a MMSfxEvent, you'll need a class to catch this event and play the sound Cached : creates and stores an audiosource to play the sound with, parented to the owner OnDemand : creates an audiosource and destroys it everytime you want to play the sound

Enumerator
Event
Cached
OnDemand
Pool

Member Function Documentation

◆ CreateAudioSource()

virtual AudioSource MoreMountains.Feedbacks.MMFeedbackSound.CreateAudioSource	(	GameObject	owner,
		string	audioSourceName
	)

protectedvirtual

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMFeedbackSound.CustomInitialization ( GameObject owner )

protectedvirtual

Custom init to cache the audiosource if required

Parameters

owner

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ CustomPlayFeedback()

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

protectedvirtual

Plays either a random sound or the specified sfx

Parameters

position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMFeedback.

◆ GetAudioSourceFromPool()

virtual AudioSource MoreMountains.Feedbacks.MMFeedbackSound.GetAudioSourceFromPool ( )

protectedvirtual

Gets an audio source from the pool if possible

Returns

◆ GetDuration()

virtual float MoreMountains.Feedbacks.MMFeedbackSound.GetDuration ( )

protectedvirtual

◆ PlayAudioSource()

virtual void MoreMountains.Feedbacks.MMFeedbackSound.PlayAudioSource	(	AudioSource	audioSource,
		AudioClip	sfx,
		float	volume,
		float	pitch,
		int	timeSamples,
		AudioMixerGroup	audioMixerGroup = `null`
	)

protectedvirtual

Plays the audio source with the specified volume and pitch

Parameters

audioSource
sfx
volume
pitch

◆ PlaySound()

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

protectedvirtual

Plays a sound differently based on the selected play method

Parameters

sfx
position

◆ TestPlaySound()

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

protectedvirtual

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

◆ TestStopSound()

virtual void MoreMountains.Feedbacks.MMFeedbackSound.TestStopSound ( )

protectedvirtual

A test method that stops the test sound

Member Data Documentation

◆ _cachedAudioSource

AudioSource MoreMountains.Feedbacks.MMFeedbackSound._cachedAudioSource

protected

◆ _duration

float MoreMountains.Feedbacks.MMFeedbackSound._duration

protected

◆ _editorAudioSource

AudioSource MoreMountains.Feedbacks.MMFeedbackSound._editorAudioSource

protected

◆ _pool

AudioSource [] MoreMountains.Feedbacks.MMFeedbackSound._pool

protected

◆ _randomClip

AudioClip MoreMountains.Feedbacks.MMFeedbackSound._randomClip

protected

◆ _tempAudioSource

AudioSource MoreMountains.Feedbacks.MMFeedbackSound._tempAudioSource

protected

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMFeedbackSound.FeedbackTypeAuthorized = true

static

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

◆ MaxPitch

float MoreMountains.Feedbacks.MMFeedbackSound.MaxPitch = 1f

the maximum pitch to play the sound at

◆ MaxVolume

float MoreMountains.Feedbacks.MMFeedbackSound.MaxVolume = 1f

the maximum volume to play the sound at

◆ MinPitch

float MoreMountains.Feedbacks.MMFeedbackSound.MinPitch = 1f

the minimum pitch to play the sound at

◆ MinVolume

float MoreMountains.Feedbacks.MMFeedbackSound.MinVolume = 1f

the minimum volume to play the sound at

◆ PlayMethod

PlayMethods MoreMountains.Feedbacks.MMFeedbackSound.PlayMethod = PlayMethods.Event

the play method to use when playing the sound (event, cached or on demand)

◆ PoolSize

int MoreMountains.Feedbacks.MMFeedbackSound.PoolSize = 10

the size of the pool when in Pool mode

◆ RandomSfx

AudioClip [] MoreMountains.Feedbacks.MMFeedbackSound.RandomSfx

an array to pick a random sfx from

◆ Sfx

AudioClip MoreMountains.Feedbacks.MMFeedbackSound.Sfx

the sound clip to play

◆ SfxAudioMixerGroup

AudioMixerGroup MoreMountains.Feedbacks.MMFeedbackSound.SfxAudioMixerGroup

the audiomixer to play the sound with (optional)

◆ TestButton

bool MoreMountains.Feedbacks.MMFeedbackSound.TestButton

◆ TestStopButton

bool MoreMountains.Feedbacks.MMFeedbackSound.TestStopButton

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMFeedbackSound.FeedbackDuration

get

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

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

Assets/InfiniteRunnerEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacksForThirdParty/MMTools/Feedbacks/Legacy/MMFeedbackSound.cs

Public Types

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Member Enumeration Documentation

◆ PlayMethods

Member Function Documentation

◆ CreateAudioSource()

◆ CustomInitialization()

◆ CustomPlayFeedback()

◆ GetAudioSourceFromPool()

◆ GetDuration()

◆ PlayAudioSource()

◆ PlaySound()

◆ TestPlaySound()

◆ TestStopSound()

Member Data Documentation

◆ _cachedAudioSource

◆ _duration

◆ _editorAudioSource

◆ _pool

◆ _randomClip

◆ _tempAudioSource

◆ FeedbackTypeAuthorized

◆ MaxPitch

◆ MaxVolume

◆ MinPitch

◆ MinVolume

◆ PlayMethod

◆ PoolSize

◆ RandomSfx

◆ Sfx

◆ SfxAudioMixerGroup

◆ TestButton

◆ TestStopButton

Property Documentation

◆ FeedbackDuration