Infinite Runner Engine v1.9
Public Types | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
MoreMountains.Feedbacks.MMFeedbackTMPAlpha Class Reference

This feedback lets you control the alpha of a target TMP over time More...

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

Public Types

enum  AlphaModes { Instant , Interpolate , ToDestination }
 

Public Attributes

TMP_Text TargetTMPText
 sets the inspector color for this feedback More...
 
AlphaModes AlphaMode = AlphaModes.Interpolate
 
float Duration = 0.2f
 how long the color of the text should change over time More...
 
float InstantAlpha = 1f
 the alpha to apply when in instant mode More...
 
MMTweenType Curve = new MMTweenType(MMTween.MMTweenCurve.EaseInCubic)
 the curve to use when interpolating towards the destination alpha More...
 
float CurveRemapZero = 0f
 the value to which the curve's 0 should be remapped More...
 
float CurveRemapOne = 1f
 the value to which the curve's 1 should be remapped More...
 
float DestinationAlpha = 1f
 the alpha to aim towards when in ToDestination mode More...
 
bool AllowAdditivePlays = false
 if this is true, calling that feedback will trigger it, even if it's in progress. If it's false, it'll prevent any new Play until the current one is over 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)
 On init we store our initial alpha More...
 
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play we change our text's alpha More...
 
virtual IEnumerator ChangeAlpha ()
 Changes the color of the text over time More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 Stops the animation if needed More...
 
virtual void SetAlpha (float time)
 Applies the alpha change 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 CustomReset ()
 This method describes what happens when the feedback gets reset More...
 

Protected Attributes

float _initialAlpha
 
Coroutine _coroutine
 
- 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 [getset]
 the duration of this feedback is the duration of the color transition, or 0 if instant 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...
 

Detailed Description

This feedback lets you control the alpha of a target TMP over time

Member Enumeration Documentation

◆ AlphaModes

Enumerator
Instant 
Interpolate 
ToDestination 

Member Function Documentation

◆ ChangeAlpha()

virtual IEnumerator MoreMountains.Feedbacks.MMFeedbackTMPAlpha.ChangeAlpha ( )
protectedvirtual

Changes the color of the text over time

Returns

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMFeedbackTMPAlpha.CustomInitialization ( GameObject  owner)
protectedvirtual

On init we store our initial alpha

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ CustomPlayFeedback()

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

On Play we change our text's alpha

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMFeedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMFeedbackTMPAlpha.CustomStopFeedback ( Vector3  position,
float  feedbacksIntensity = 1 
)
protectedvirtual

Stops the animation if needed

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ SetAlpha()

virtual void MoreMountains.Feedbacks.MMFeedbackTMPAlpha.SetAlpha ( float  time)
protectedvirtual

Applies the alpha change

Parameters
time

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMFeedbackTMPAlpha._coroutine
protected

◆ _initialAlpha

float MoreMountains.Feedbacks.MMFeedbackTMPAlpha._initialAlpha
protected

◆ AllowAdditivePlays

bool MoreMountains.Feedbacks.MMFeedbackTMPAlpha.AllowAdditivePlays = false

if this is true, calling that feedback will trigger it, even if it's in progress. If it's false, it'll prevent any new Play until the current one is over

◆ AlphaMode

AlphaModes MoreMountains.Feedbacks.MMFeedbackTMPAlpha.AlphaMode = AlphaModes.Interpolate

the selected color mode : None : nothing will happen, gradient : evaluates the color over time on that gradient, from left to right, interpolate : lerps from the current color to the destination one

◆ Curve

MMTweenType MoreMountains.Feedbacks.MMFeedbackTMPAlpha.Curve = new MMTweenType(MMTween.MMTweenCurve.EaseInCubic)

the curve to use when interpolating towards the destination alpha

◆ CurveRemapOne

float MoreMountains.Feedbacks.MMFeedbackTMPAlpha.CurveRemapOne = 1f

the value to which the curve's 1 should be remapped

◆ CurveRemapZero

float MoreMountains.Feedbacks.MMFeedbackTMPAlpha.CurveRemapZero = 0f

the value to which the curve's 0 should be remapped

◆ DestinationAlpha

float MoreMountains.Feedbacks.MMFeedbackTMPAlpha.DestinationAlpha = 1f

the alpha to aim towards when in ToDestination mode

◆ Duration

float MoreMountains.Feedbacks.MMFeedbackTMPAlpha.Duration = 0.2f

how long the color of the text should change over time

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMFeedbackTMPAlpha.FeedbackTypeAuthorized = true
static

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

◆ InstantAlpha

float MoreMountains.Feedbacks.MMFeedbackTMPAlpha.InstantAlpha = 1f

the alpha to apply when in instant mode

◆ TargetTMPText

TMP_Text MoreMountains.Feedbacks.MMFeedbackTMPAlpha.TargetTMPText

sets the inspector color for this feedback

the TMP_Text component to control

Property Documentation

◆ FeedbackDuration

override float? MoreMountains.Feedbacks.MMFeedbackTMPAlpha.FeedbackDuration
getset

the duration of this feedback is the duration of the color transition, or 0 if instant


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