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

This feedback will let you trigger cross fades on a target Graphic. More...

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

Public Types

enum  Modes { Modes.Alpha, Modes.Color }
 the possible modes for this feedback More...
 

Public Attributes

override bool HasChannel => true
 
override bool HasAutomatedTargetAcquisition => true
 
Graphic TargetGraphic
 the Graphic to affect when playing the feedback More...
 
Modes Mode = Modes.Alpha
 whether the feedback should affect the Image instantly or over a period of time More...
 
float Duration = 0.2f
 how long the Graphic should change over time More...
 
float TargetAlpha = 0.2f
 the target alpha More...
 
Color TargetColor = Color.red
 the target color More...
 
bool UseAlpha = true
 whether or not the crossfade should also tween the alpha channel 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)
 This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method More...
 
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play we turn our Graphic on and start an over time coroutine if needed More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 Turns the Graphic off on stop More...
 
virtual void Turn (bool status)
 Turns the Graphic 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 trigger cross fades on a target Graphic.

Member Enumeration Documentation

◆ Modes

the possible modes for this feedback

Enumerator
Alpha 
Color 

Member Function Documentation

◆ AutomateTargetAcquisition()

override void MoreMountains.Feedbacks.MMF_GraphicCrossFade.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_GraphicCrossFade.CustomInitialization ( MMF_Player  owner)
protectedvirtual

This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

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

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

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

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

On restore, we restore our initial state

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

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

Turns the Graphic off on stop

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ Turn()

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

Turns the Graphic on or off

Parameters
status

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMF_GraphicCrossFade._coroutine
protected

◆ _initialColor

Color MoreMountains.Feedbacks.MMF_GraphicCrossFade._initialColor
protected

◆ DisableOnStop

bool MoreMountains.Feedbacks.MMF_GraphicCrossFade.DisableOnStop = false

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

◆ Duration

float MoreMountains.Feedbacks.MMF_GraphicCrossFade.Duration = 0.2f

how long the Graphic should change over time

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_GraphicCrossFade.FeedbackTypeAuthorized = true
static

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

◆ HasAutomatedTargetAcquisition

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

◆ HasChannel

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

◆ Mode

Modes MoreMountains.Feedbacks.MMF_GraphicCrossFade.Mode = Modes.Alpha

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

◆ TargetAlpha

float MoreMountains.Feedbacks.MMF_GraphicCrossFade.TargetAlpha = 0.2f

the target alpha

◆ TargetColor

Color MoreMountains.Feedbacks.MMF_GraphicCrossFade.TargetColor = Color.red

the target color

◆ TargetGraphic

Graphic MoreMountains.Feedbacks.MMF_GraphicCrossFade.TargetGraphic

the Graphic to affect when playing the feedback

◆ UseAlpha

bool MoreMountains.Feedbacks.MMF_GraphicCrossFade.UseAlpha = true

whether or not the crossfade should also tween the alpha channel

Property Documentation

◆ FeedbackDuration

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