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

This feedback will let you change the color of a target sprite renderer over time, and flip it on X or Y. You can also use it to command one or many MMSpriteRendererShakers. More...

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

Public Types

enum  Modes { Modes.OverTime, Modes.Instant, Modes.ShakerEvent }
 sets the inspector color for this feedback More...
 

Public Attributes

Image BoundImage
 the Image to affect when playing the feedback More...
 
Modes Mode = Modes.OverTime
 whether the feedback should affect the Image instantly or over a period of time More...
 
float Duration = 0.2f
 how long the Image should change over time More...
 
bool StartsOff = false
 whether or not that Image should be turned off on start More...
 
int Channel = 0
 the channel to broadcast on 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 UseRange = false
 whether or not to broadcast a range to only affect certain shakers More...
 
float EventRange = 100f
 the range of the event, in units More...
 
Transform EventOriginTransform
 the transform to use to broadcast the event as origin point 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...
 
bool DisableOnStop = true
 if this is true, the target will be disabled when this feedbacks is stopped More...
 
bool ModifyColor = true
 whether or not to modify the color of the image More...
 
Gradient ColorOverTime
 the colors to apply to the Image over time More...
 
Color InstantColor
 the color to move to in instant mode 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 turn the Image off if needed More...
 
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play we turn our Image on and start an over time coroutine if needed More...
 
virtual IEnumerator ImageSequence ()
 This coroutine will modify the values on the Image More...
 
virtual void SetImageValues (float time)
 Sets the various values on the sprite renderer on a specified time (between 0 and 1) More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 Turns the sprite renderer off on stop More...
 
virtual void Turn (bool status)
 Turns the sprite renderer on or off 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

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
 
MMChannelData _channelData
 

Properties

override float? FeedbackDuration [get, set]
 the duration of this feedback is the duration of the Image, or 0 if instant 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 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...
 

Additional Inherited Members

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

Detailed Description

This feedback will let you change the color of a target sprite renderer over time, and flip it on X or Y. You can also use it to command one or many MMSpriteRendererShakers.

Member Enumeration Documentation

◆ Modes

sets the inspector color for this feedback

the possible modes for this feedback

Enumerator
OverTime 
Instant 
ShakerEvent 

Member Function Documentation

◆ CustomInitialization()

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

On init we turn the Image off if needed

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ CustomPlayFeedback()

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

On Play we turn our Image on and start an over time coroutine if needed

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMFeedback.

◆ CustomStopFeedback()

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

Turns the sprite renderer off on stop

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ ImageSequence()

virtual IEnumerator MoreMountains.Feedbacks.MMFeedbackImage.ImageSequence ( )
protectedvirtual

This coroutine will modify the values on the Image

Returns

◆ SetImageValues()

virtual void MoreMountains.Feedbacks.MMFeedbackImage.SetImageValues ( float  time)
protectedvirtual

Sets the various values on the sprite renderer on a specified time (between 0 and 1)

Parameters
time

◆ Turn()

virtual void MoreMountains.Feedbacks.MMFeedbackImage.Turn ( bool  status)
protectedvirtual

Turns the sprite renderer on or off

Parameters
status

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMFeedbackImage._coroutine
protected

◆ AllowAdditivePlays

bool MoreMountains.Feedbacks.MMFeedbackImage.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

◆ BoundImage

Image MoreMountains.Feedbacks.MMFeedbackImage.BoundImage

the Image to affect when playing the feedback

◆ Channel

int MoreMountains.Feedbacks.MMFeedbackImage.Channel = 0

the channel to broadcast on

◆ ColorOverTime

Gradient MoreMountains.Feedbacks.MMFeedbackImage.ColorOverTime

the colors to apply to the Image over time

◆ DisableOnStop

bool MoreMountains.Feedbacks.MMFeedbackImage.DisableOnStop = true

if this is true, the target will be disabled when this feedbacks is stopped

◆ Duration

float MoreMountains.Feedbacks.MMFeedbackImage.Duration = 0.2f

how long the Image should change over time

◆ EventOriginTransform

Transform MoreMountains.Feedbacks.MMFeedbackImage.EventOriginTransform

the transform to use to broadcast the event as origin point

◆ EventRange

float MoreMountains.Feedbacks.MMFeedbackImage.EventRange = 100f

the range of the event, in units

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMFeedbackImage.FeedbackTypeAuthorized = true
static

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

◆ InstantColor

Color MoreMountains.Feedbacks.MMFeedbackImage.InstantColor

the color to move to in instant mode

◆ Mode

Modes MoreMountains.Feedbacks.MMFeedbackImage.Mode = Modes.OverTime

whether the feedback should affect the Image instantly or over a period of time

◆ ModifyColor

bool MoreMountains.Feedbacks.MMFeedbackImage.ModifyColor = true

whether or not to modify the color of the image

◆ ResetShakerValuesAfterShake

bool MoreMountains.Feedbacks.MMFeedbackImage.ResetShakerValuesAfterShake = true

whether or not to reset shaker values after shake

◆ ResetTargetValuesAfterShake

bool MoreMountains.Feedbacks.MMFeedbackImage.ResetTargetValuesAfterShake = true

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

◆ StartsOff

bool MoreMountains.Feedbacks.MMFeedbackImage.StartsOff = false

whether or not that Image should be turned off on start

◆ UseRange

bool MoreMountains.Feedbacks.MMFeedbackImage.UseRange = false

whether or not to broadcast a range to only affect certain shakers

Property Documentation

◆ FeedbackDuration

override float? MoreMountains.Feedbacks.MMFeedbackImage.FeedbackDuration
getset

the duration of this feedback is the duration of the Image, or 0 if instant


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