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

This feedback will let you change the fill value of a target Image over time. More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_ImageFill:
MoreMountains.Feedbacks.MMF_Feedback

Public Types

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

Public Attributes

override bool HasCustomInspectors => true
 sets the inspector color for this feedback More...
 
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...
 
float InstantFill = 1f
 the fill to move to in instant mode More...
 
MMTweenType Curve = new MMTweenType(MMTween.MMTweenCurve.EaseInCubic)
 the curve to use when interpolating towards the destination fill 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 DestinationFill = 1f
 the fill to aim towards when in ToDestination mode 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 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 SetFill (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 put our object back at its initial position More...
 

Protected Attributes

Coroutine _coroutine
 
float _initialFill
 
bool _initialState
 

Properties

override float? FeedbackDuration [get, set]
 the duration of this feedback is the duration of the Image, or 0 if instant More...
 

Additional Inherited Members

Detailed Description

This feedback will let you change the fill value of a target Image over time.

Member Enumeration Documentation

◆ Modes

the possible modes for this feedback

Enumerator
OverTime 
Instant 
ToDestination 

Member Function Documentation

◆ AutomateTargetAcquisition()

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

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_ImageFill.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_ImageFill.CustomRestoreInitialValues ( )
protectedvirtual

On restore, we put our object back at its initial position

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_ImageFill.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_ImageFill.ImageSequence ( )
protectedvirtual

This coroutine will modify the values on the Image

Returns

◆ SetFill()

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

Turns the sprite renderer on or off

Parameters
status

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMF_ImageFill._coroutine
protected

◆ _initialFill

float MoreMountains.Feedbacks.MMF_ImageFill._initialFill
protected

◆ _initialState

bool MoreMountains.Feedbacks.MMF_ImageFill._initialState
protected

◆ AllowAdditivePlays

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

the Image to affect when playing the feedback

◆ Curve

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

the curve to use when interpolating towards the destination fill

◆ CurveRemapOne

float MoreMountains.Feedbacks.MMF_ImageFill.CurveRemapOne = 1f

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

◆ CurveRemapZero

float MoreMountains.Feedbacks.MMF_ImageFill.CurveRemapZero = 0f

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

◆ DestinationFill

float MoreMountains.Feedbacks.MMF_ImageFill.DestinationFill = 1f

the fill to aim towards when in ToDestination mode

◆ DisableOnStop

bool MoreMountains.Feedbacks.MMF_ImageFill.DisableOnStop = false

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

◆ Duration

float MoreMountains.Feedbacks.MMF_ImageFill.Duration = 0.2f

how long the Image should change over time

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_ImageFill.FeedbackTypeAuthorized = true
static

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

◆ HasAutomatedTargetAcquisition

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

◆ HasCustomInspectors

override bool MoreMountains.Feedbacks.MMF_ImageFill.HasCustomInspectors => true

sets the inspector color for this feedback

◆ InstantFill

float MoreMountains.Feedbacks.MMF_ImageFill.InstantFill = 1f

the fill to move to in instant mode

◆ Mode

Modes MoreMountains.Feedbacks.MMF_ImageFill.Mode = Modes.OverTime

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

Property Documentation

◆ FeedbackDuration

override float? MoreMountains.Feedbacks.MMF_ImageFill.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: