Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed Class Reference

This feedback will let you change the speed of a target animator, either once, or instantly and then reset it, or interpolate it over time More...

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

Public Types

enum  Modes { Modes.Once, Modes.InstantThenReset, Modes.OverTime }
 sets the inspector color for this feedback More...
 

Public Member Functions

virtual float GetTime ()
 
virtual float GetDeltaTime ()
 
- Public Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual MMChannelData ChannelData (int channel)
 
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...
 

Public Attributes

Animator BoundAnimator
 the animator whose parameters you want to update More...
 
Modes Mode = Modes.Once
 whether to change the speed of the target animator once, instantly and reset it later, or have it change over time More...
 
float NewSpeedMin = 0f
 the new minimum speed at which to set the animator - value will be randomized between min and max More...
 
float NewSpeedMax = 0f
 the new maximum speed at which to set the animator - value will be randomized between min and max More...
 
float Duration = 1f
 when in instant then reset or over time modes, the duration of the effect More...
 
AnimationCurve Curve = new AnimationCurve(new Keyframe(0, 0f), new Keyframe(0.5f, 1f), new Keyframe(1, 0f))
 when in over time mode, the curve against which to evaluate the new speed 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 CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play, checks if an animator is bound and triggers parameters More...
 
virtual IEnumerator ChangeSpeedCo ()
 A coroutine used in ForDuration mode More...
 
virtual float DetermineNewSpeed ()
 Determines the new speed for the target animator More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On stop, turns the bool parameter to false 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 CustomInitialization (GameObject owner)
 This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method More...
 
virtual void CustomReset ()
 This method describes what happens when the feedback gets reset More...
 

Protected Attributes

Coroutine _coroutine
 
float _initialSpeed
 
float _startedAt
 
- 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
 
MMChannelData _channelData
 

Additional Inherited Members

- Properties inherited from MoreMountains.Feedbacks.MMFeedback
GameObject Owner [get, set]
 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 [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 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 [get, set]
 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 [get, set]
 
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...
 

Detailed Description

This feedback will let you change the speed of a target animator, either once, or instantly and then reset it, or interpolate it over time

Member Enumeration Documentation

◆ Modes

sets the inspector color for this feedback

Enumerator
Once 
InstantThenReset 
OverTime 

Member Function Documentation

◆ ChangeSpeedCo()

virtual IEnumerator MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.ChangeSpeedCo ( )
protectedvirtual

A coroutine used in ForDuration mode

Returns

◆ CustomPlayFeedback()

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

On Play, checks if an animator is bound and triggers parameters

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMFeedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.CustomStopFeedback ( Vector3  position,
float  feedbacksIntensity = 1.0f 
)
protectedvirtual

On stop, turns the bool parameter to false

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ DetermineNewSpeed()

virtual float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.DetermineNewSpeed ( )
protectedvirtual

Determines the new speed for the target animator

Returns

◆ GetDeltaTime()

virtual float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.GetDeltaTime ( )
virtual

◆ GetTime()

virtual float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.GetTime ( )
virtual

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed._coroutine
protected

◆ _initialSpeed

float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed._initialSpeed
protected

◆ _startedAt

float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed._startedAt
protected

◆ BoundAnimator

Animator MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.BoundAnimator

the animator whose parameters you want to update

◆ Curve

AnimationCurve MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.Curve = new AnimationCurve(new Keyframe(0, 0f), new Keyframe(0.5f, 1f), new Keyframe(1, 0f))

when in over time mode, the curve against which to evaluate the new speed

◆ Duration

float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.Duration = 1f

when in instant then reset or over time modes, the duration of the effect

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.FeedbackTypeAuthorized = true
static

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

◆ Mode

Modes MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.Mode = Modes.Once

whether to change the speed of the target animator once, instantly and reset it later, or have it change over time

◆ NewSpeedMax

float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.NewSpeedMax = 0f

the new maximum speed at which to set the animator - value will be randomized between min and max

◆ NewSpeedMin

float MoreMountains.Feedbacks.MMFeedbackAnimatorSpeed.NewSpeedMin = 0f

the new minimum speed at which to set the animator - value will be randomized between min and max


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