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

This feedback will trigger a one time play on a target FloatController More...

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

Public Types

enum  FadeTypes { FadeTypes.FadeIn, FadeTypes.FadeOut, FadeTypes.Custom }
 sets the inspector color for this feedback More...
 
enum  PositionModes { PositionModes.FeedbackPosition, PositionModes.Transform, PositionModes.WorldPosition, PositionModes.Script }
 

Public Attributes

FadeTypes FadeType
 the type of fade we want to use when this feedback gets played More...
 
int ID = 0
 the ID of the fader(s) to pilot More...
 
float Duration = 1f
 the duration (in seconds) of the fade More...
 
MMTweenType Curve = new MMTweenType(MMTween.MMTweenCurve.EaseInCubic)
 the curve to use for this fade More...
 
bool IgnoreTimeScale = true
 whether or not this fade should ignore timescale More...
 
float TargetAlpha
 the target alpha we're aiming for with this fade More...
 
PositionModes PositionMode = PositionModes.FeedbackPosition
 the chosen way to position the fade More...
 
Transform TargetTransform
 the transform on which to center the fade More...
 
Vector3 TargetPosition
 the coordinates on which to center the fadet More...
 
Vector3 PositionOffset
 the position offset to apply when centering the fade 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 CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On play we trigger the selected fade event More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 Stops the animation if needed More...
 
virtual Vector3 GetPosition (Vector3 position)
 Computes the proper position for this fade More...
 
override void CustomRestoreInitialValues ()
 On restore, we restore our initial state More...
 

Protected Attributes

Vector3 _position
 
FadeTypes _fadeType
 

Properties

override float FeedbackDuration [get, set]
 the duration of this feedback is the duration of the fade More...
 

Additional Inherited Members

Detailed Description

This feedback will trigger a one time play on a target FloatController

Member Enumeration Documentation

◆ FadeTypes

sets the inspector color for this feedback

the different possible types of fades

Enumerator
FadeIn 
FadeOut 
Custom 

◆ PositionModes

the different ways to send the position to the fader :

  • FeedbackPosition : fade at the position of the feedback, plus an optional offset
  • Transform : fade at the specified Transform's position, plus an optional offset
  • WorldPosition : fade at the specified world position vector, plus an optional offset
  • Script : the position passed in parameters when calling the feedback
Enumerator
FeedbackPosition 
Transform 
WorldPosition 
Script 

Member Function Documentation

◆ CustomPlayFeedback()

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

On play we trigger the selected fade event

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

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

On restore, we restore our initial state

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

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

Stops the animation if needed

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ GetPosition()

virtual Vector3 MoreMountains.Feedbacks.MMF_Fade.GetPosition ( Vector3  position)
protectedvirtual

Computes the proper position for this fade

Parameters
position
Returns

Member Data Documentation

◆ _fadeType

FadeTypes MoreMountains.Feedbacks.MMF_Fade._fadeType
protected

◆ _position

Vector3 MoreMountains.Feedbacks.MMF_Fade._position
protected

◆ Curve

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

the curve to use for this fade

◆ Duration

float MoreMountains.Feedbacks.MMF_Fade.Duration = 1f

the duration (in seconds) of the fade

◆ FadeType

FadeTypes MoreMountains.Feedbacks.MMF_Fade.FadeType

the type of fade we want to use when this feedback gets played

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Fade.FeedbackTypeAuthorized = true
static

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

◆ ID

int MoreMountains.Feedbacks.MMF_Fade.ID = 0

the ID of the fader(s) to pilot

◆ IgnoreTimeScale

bool MoreMountains.Feedbacks.MMF_Fade.IgnoreTimeScale = true

whether or not this fade should ignore timescale

◆ PositionMode

PositionModes MoreMountains.Feedbacks.MMF_Fade.PositionMode = PositionModes.FeedbackPosition

the chosen way to position the fade

◆ PositionOffset

Vector3 MoreMountains.Feedbacks.MMF_Fade.PositionOffset

the position offset to apply when centering the fade

◆ TargetAlpha

float MoreMountains.Feedbacks.MMF_Fade.TargetAlpha

the target alpha we're aiming for with this fade

◆ TargetPosition

Vector3 MoreMountains.Feedbacks.MMF_Fade.TargetPosition

the coordinates on which to center the fadet

◆ TargetTransform

Transform MoreMountains.Feedbacks.MMF_Fade.TargetTransform

the transform on which to center the fade

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_Fade.FeedbackDuration
getset

the duration of this feedback is the duration of the fade


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