MMFeedbacks  v1.6
Public Attributes | Protected Member Functions | Properties | List of all members
MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch Class Reference

This feedback lets you control the pitch of an AudioSource over time More...

Inheritance diagram for MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch:
MoreMountains.Feedbacks.MMFeedback

Public Attributes

int Channel = 0
 the channel to emit on More...
 
float Duration = 2f
 the duration of the shake, in seconds More...
 
bool ResetShakerValuesAfterShake = true
 whether or not to reset shaker values after shake More...
 
bool ResetTargetValuesAfterShake = true
 whether or not to reset the target's values after shake More...
 
bool RelativePitch = false
 whether or not to add to the initial value More...
 
AnimationCurve PitchTween = new AnimationCurve(new Keyframe(0, 1f), new Keyframe(0.5f, 0f), new Keyframe(1, 1f))
 the curve used to animate the intensity value on More...
 
float RemapPitchZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapPitchOne = 1f
 the value to remap the curve's 1 to 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...
 

Protected Member Functions

override void CustomPlayFeedback (Vector3 position, float attenuation=1.0f)
 Triggers the corresponding coroutine More...
 
- Protected Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual IEnumerator PlayCoroutine (Vector3 position, float attenuation=1.0f)
 An internal coroutine delaying the initial play of the feedback More...
 
virtual void RegularPlay (Vector3 position, float attenuation=1.0f)
 Triggers delaying coroutines if needed More...
 
virtual IEnumerator InfinitePlay (Vector3 position, float attenuation=1.0f)
 Internal coroutine used for repeated play without end More...
 
virtual IEnumerator RepeatedPlay (Vector3 position, float attenuation=1.0f)
 Internal coroutine used for repeated play More...
 
virtual IEnumerator SequenceCoroutine (Vector3 position, float attenuation=1.0f)
 A coroutine used to play this feedback on a sequence More...
 
virtual void CustomInitialization (GameObject owner)
 This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method More...
 
virtual void CustomStopFeedback (Vector3 position, float attenuation=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...
 

Properties

override float FeedbackDuration [get]
 sets the inspector color for this feedback More...
 
- Properties inherited from MoreMountains.Feedbacks.MMFeedback
GameObject Owner [get, set]
 the Owner of the feedback, as defined when calling the Initialization method More...
 
virtual YieldInstruction 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 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...
 
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...
 
virtual float FeedbackStartedAt [get]
 
virtual float FeedbackDuration [get]
 
virtual bool FeedbackPlaying [get]
 whether or not this feedback is playing right now 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 attenuation=1.0f)
 Plays the feedback More...
 
virtual void Stop (Vector3 position, float attenuation=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...
 
- Protected Attributes inherited from MoreMountains.Feedbacks.MMFeedback
WaitForSeconds _initialDelayWaitForSeconds
 
WaitForSeconds _betweenDelayWaitForSeconds
 
WaitForSeconds _sequenceDelayWaitForSeconds
 
float _lastPlayTimestamp = -1f
 
int _playsLeft
 
bool _initialized = false
 
Coroutine _playCoroutine
 
Coroutine _infinitePlayCoroutine
 
Coroutine _sequenceCoroutine
 
Coroutine _repeatedPlayCoroutine
 
int _sequenceTrackID = 0
 
float _beatInterval
 
bool BeatThisFrame = false
 
int LastBeatIndex = 0
 
int CurrentSequenceIndex = 0
 
float LastBeatTimestamp = 0f
 

Detailed Description

This feedback lets you control the pitch of an AudioSource over time

Member Function Documentation

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.CustomPlayFeedback ( Vector3  position,
float  attenuation = 1.0f 
)
protectedvirtual

Triggers the corresponding coroutine

Parameters
position
attenuation

Implements MoreMountains.Feedbacks.MMFeedback.

Member Data Documentation

◆ Channel

int MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.Channel = 0

the channel to emit on

◆ Duration

float MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.Duration = 2f

the duration of the shake, in seconds

◆ PitchTween

AnimationCurve MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.PitchTween = new AnimationCurve(new Keyframe(0, 1f), new Keyframe(0.5f, 0f), new Keyframe(1, 1f))

the curve used to animate the intensity value on

◆ RelativePitch

bool MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.RelativePitch = false

whether or not to add to the initial value

◆ RemapPitchOne

float MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.RemapPitchOne = 1f

the value to remap the curve's 1 to

◆ RemapPitchZero

float MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.RemapPitchZero = 0f

the value to remap the curve's 0 to

◆ ResetShakerValuesAfterShake

bool MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.ResetShakerValuesAfterShake = true

whether or not to reset shaker values after shake

◆ ResetTargetValuesAfterShake

bool MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.ResetTargetValuesAfterShake = true

whether or not to reset the target's values after shake

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMFeedbackAudioSourcePitch.FeedbackDuration
get

sets the inspector color for this feedback

returns the duration of the feedback


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