Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Feedbacks.MMF_Image 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.MMF_Image:
MoreMountains.Feedbacks.MMF_Feedback

Public Types

enum  Modes { Modes.OverTime, Modes.Instant }
 the possible modes for this feedback More...
 

Public Attributes

override bool HasChannel => true
 
override bool HasAutomatedTargetAcquisition => true
 
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 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 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...
 
bool DisableOnInit = false
 whether or not that Image should be turned off on start More...
 
bool EnableOnPlay = true
 if this is true, the target will be enabled when this feedback gets played More...
 
bool DisableOnSequenceEnd = false
 if this is true, the target disabled after the color over time change ends More...
 
bool DisableOnStop = false
 if this is true, the target will be disabled when this feedbacks is stopped 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 CustomInitialization (MMF_Player 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...
 
override void CustomRestoreInitialValues ()
 On restore, we restore our initial state More...
 

Protected Attributes

Coroutine _coroutine
 
Color _initialColor
 

Properties

override float? FeedbackDuration [get, set]
 sets the inspector color for this feedback More...
 

Additional Inherited Members

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

the possible modes for this feedback

Enumerator
OverTime 
Instant 

Member Function Documentation

◆ AutomateTargetAcquisition()

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

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_Image.CustomInitialization ( MMF_Player  owner)
protectedvirtual

On init we turn the Image off if needed

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

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

◆ CustomRestoreInitialValues()

override void MoreMountains.Feedbacks.MMF_Image.CustomRestoreInitialValues ( )
protectedvirtual

On restore, we restore our initial state

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

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

Turns the sprite renderer off on stop

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ ImageSequence()

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

This coroutine will modify the values on the Image

Returns

◆ SetImageValues()

virtual void MoreMountains.Feedbacks.MMF_Image.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.MMF_Image.Turn ( bool  status)
protectedvirtual

Turns the sprite renderer on or off

Parameters
status

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMF_Image._coroutine
protected

◆ _initialColor

Color MoreMountains.Feedbacks.MMF_Image._initialColor
protected

◆ AllowAdditivePlays

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

the Image to affect when playing the feedback

◆ ColorOverTime

Gradient MoreMountains.Feedbacks.MMF_Image.ColorOverTime

the colors to apply to the Image over time

◆ DisableOnInit

bool MoreMountains.Feedbacks.MMF_Image.DisableOnInit = false

whether or not that Image should be turned off on start

◆ DisableOnSequenceEnd

bool MoreMountains.Feedbacks.MMF_Image.DisableOnSequenceEnd = false

if this is true, the target disabled after the color over time change ends

◆ DisableOnStop

bool MoreMountains.Feedbacks.MMF_Image.DisableOnStop = false

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

◆ Duration

float MoreMountains.Feedbacks.MMF_Image.Duration = 0.2f

how long the Image should change over time

◆ EnableOnPlay

bool MoreMountains.Feedbacks.MMF_Image.EnableOnPlay = true

if this is true, the target will be enabled when this feedback gets played

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Image.FeedbackTypeAuthorized = true
static

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

◆ HasAutomatedTargetAcquisition

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

◆ HasChannel

override bool MoreMountains.Feedbacks.MMF_Image.HasChannel => true

◆ InstantColor

Color MoreMountains.Feedbacks.MMF_Image.InstantColor

the color to move to in instant mode

◆ Mode

Modes MoreMountains.Feedbacks.MMF_Image.Mode = Modes.OverTime

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

◆ ModifyColor

bool MoreMountains.Feedbacks.MMF_Image.ModifyColor = true

whether or not to modify the color of the image

Property Documentation

◆ FeedbackDuration

override float? MoreMountains.Feedbacks.MMF_Image.FeedbackDuration
getset

sets the inspector color for this feedback

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: