Feel  4.3
The best way to improve your game's feel and make it extra juicy
MoreMountains.Feedbacks.MMF_AudioSource Class Reference
Inheritance diagram for MoreMountains.Feedbacks.MMF_AudioSource:
MoreMountains.Feedbacks.MMF_Feedback

Public Types

enum  Modes { Modes.Play, Modes.Pause, Modes.UnPause, Modes.Stop }
 the possible ways to interact with the audiosource More...
 

Public Member Functions

override void Stop (Vector3 position, float feedbacksIntensity=1.0f)
 Stops the audiosource from playing More...
 

Public Attributes

override bool HasRandomness => true
 sets the inspector color for this feedback More...
 
override bool HasAutomatedTargetAcquisition => true
 
AudioSource TargetAudioSource
 the target audio source to play More...
 
Modes Mode = Modes.Play
 whether we should play the audio source or stop it or pause it More...
 
AudioClip[] RandomSfx
 an array to pick a random sfx from 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...
 

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 AutomateTargetAcquisition ()
 A method meant to be implemented per feedback letting you specify what happens (usually setting a target) More...
 
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 Plays either a random sound or the specified sfx More...
 
virtual void PlayAudioSource (AudioSource audioSource, float volume, float pitch)
 Plays the audiosource at the selected volume and pitch More...
 

Protected Attributes

AudioClip _randomClip
 
float _duration
 

Properties

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

Member Enumeration Documentation

◆ Modes

the possible ways to interact with the audiosource

Enumerator
Play 
Pause 
UnPause 
Stop 

Member Function Documentation

◆ AutomateTargetAcquisition()

override void MoreMountains.Feedbacks.MMF_AudioSource.AutomateTargetAcquisition ( )
protectedvirtual

A method meant to be implemented per feedback letting you specify what happens (usually setting a target)

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_AudioSource.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.

◆ PlayAudioSource()

virtual void MoreMountains.Feedbacks.MMF_AudioSource.PlayAudioSource ( AudioSource  audioSource,
float  volume,
float  pitch 
)
protectedvirtual

Plays the audiosource at the selected volume and pitch

Parameters
audioSource
volume
pitch

◆ Stop()

override void MoreMountains.Feedbacks.MMF_AudioSource.Stop ( Vector3  position,
float  feedbacksIntensity = 1.0f 
)
virtual

Stops the audiosource from playing

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ _duration

float MoreMountains.Feedbacks.MMF_AudioSource._duration
protected

◆ _randomClip

AudioClip MoreMountains.Feedbacks.MMF_AudioSource._randomClip
protected

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_AudioSource.FeedbackTypeAuthorized = true
static

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

◆ HasAutomatedTargetAcquisition

override bool MoreMountains.Feedbacks.MMF_AudioSource.HasAutomatedTargetAcquisition => true

◆ HasRandomness

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

sets the inspector color for this feedback

◆ MaxPitch

float MoreMountains.Feedbacks.MMF_AudioSource.MaxPitch = 1f

the maximum pitch to play the sound at

◆ MaxVolume

float MoreMountains.Feedbacks.MMF_AudioSource.MaxVolume = 1f

the maximum volume to play the sound at

◆ MinPitch

float MoreMountains.Feedbacks.MMF_AudioSource.MinPitch = 1f

the minimum pitch to play the sound at

◆ MinVolume

float MoreMountains.Feedbacks.MMF_AudioSource.MinVolume = 1f

the minimum volume to play the sound at

◆ Mode

Modes MoreMountains.Feedbacks.MMF_AudioSource.Mode = Modes.Play

whether we should play the audio source or stop it or pause it

◆ RandomSfx

AudioClip [] MoreMountains.Feedbacks.MMF_AudioSource.RandomSfx

an array to pick a random sfx from

◆ SfxAudioMixerGroup

AudioMixerGroup MoreMountains.Feedbacks.MMF_AudioSource.SfxAudioMixerGroup

the audiomixer to play the sound with (optional)

◆ TargetAudioSource

AudioSource MoreMountains.Feedbacks.MMF_AudioSource.TargetAudioSource

the target audio source to play

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_AudioSource.FeedbackDuration
getset

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


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