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

This feedback will let you animate the density, color, end and start distance of your scene's fog More...

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

Public Types

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

Public Attributes

override bool HasRandomness => true
 sets the inspector color for this feedback More...
 
Modes Mode = Modes.OverTime
 whether the feedback should affect the sprite renderer instantly or over a period of time More...
 
float Duration = 2f
 how long the sprite renderer 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 ModifyFogDensity = true
 whether or not to modify the fog's density More...
 
MMTweenType DensityCurve = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1f), new Keyframe(1, 0)))
 a curve to use to animate the fog's density over time More...
 
float DensityRemapZero = 0.01f
 the value to remap the fog's density curve zero value to More...
 
float DensityRemapOne = 0.05f
 the value to remap the fog's density curve one value to More...
 
float DensityInstantChange
 the value to change the fog's density to when in instant mode More...
 
bool ModifyStartDistance = true
 whether or not to modify the fog's start distance More...
 
MMTweenType StartDistanceCurve = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1f), new Keyframe(1, 0)))
 a curve to use to animate the fog's start distance over time More...
 
float StartDistanceRemapZero = 0f
 the value to remap the fog's start distance curve zero value to More...
 
float StartDistanceRemapOne = 0f
 the value to remap the fog's start distance curve one value to More...
 
float StartDistanceInstantChange
 the value to change the fog's start distance to when in instant mode More...
 
bool ModifyEndDistance = true
 whether or not to modify the fog's end distance More...
 
MMTweenType EndDistanceCurve = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1f), new Keyframe(1, 0)))
 a curve to use to animate the fog's end distance over time More...
 
float EndDistanceRemapZero = 0f
 the value to remap the fog's end distance curve zero value to More...
 
float EndDistanceRemapOne = 300f
 the value to remap the fog's end distance curve one value to More...
 
float EndDistanceInstantChange
 the value to change the fog's end distance to when in instant mode More...
 
bool ModifyColor = true
 whether or not to modify the fog's color More...
 
Gradient ColorOverTime
 the colors to apply to the sprite renderer over time More...
 
Color InstantColor
 the color to move to in instant 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 CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play we change the values of our fog More...
 
virtual IEnumerator FogSequence (float intensityMultiplier)
 This coroutine will modify the values on the fog settings More...
 
virtual void SetFogValues (float time, float intensityMultiplier)
 Sets the various values on the fog on a specified time (between 0 and 1) More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 Stops this feedback More...
 
override void CustomRestoreInitialValues ()
 On restore, we put our object back at its initial position More...
 

Protected Attributes

Coroutine _coroutine
 
Color _initialColor
 
float _initialStartDistance
 
float _initialEndDistance
 
float _initialDensity
 

Properties

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

Additional Inherited Members

Detailed Description

This feedback will let you animate the density, color, end and start distance of your scene's fog

Member Enumeration Documentation

◆ Modes

the possible modes for this feedback

Enumerator
OverTime 
Instant 

Member Function Documentation

◆ CustomPlayFeedback()

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

On Play we change the values of our fog

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

override void MoreMountains.Feedbacks.MMF_Fog.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_Fog.CustomStopFeedback ( Vector3  position,
float  feedbacksIntensity = 1 
)
protectedvirtual

Stops this feedback

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ FogSequence()

virtual IEnumerator MoreMountains.Feedbacks.MMF_Fog.FogSequence ( float  intensityMultiplier)
protectedvirtual

This coroutine will modify the values on the fog settings

Returns

◆ SetFogValues()

virtual void MoreMountains.Feedbacks.MMF_Fog.SetFogValues ( float  time,
float  intensityMultiplier 
)
protectedvirtual

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

Parameters
time

Member Data Documentation

◆ _coroutine

Coroutine MoreMountains.Feedbacks.MMF_Fog._coroutine
protected

◆ _initialColor

Color MoreMountains.Feedbacks.MMF_Fog._initialColor
protected

◆ _initialDensity

float MoreMountains.Feedbacks.MMF_Fog._initialDensity
protected

◆ _initialEndDistance

float MoreMountains.Feedbacks.MMF_Fog._initialEndDistance
protected

◆ _initialStartDistance

float MoreMountains.Feedbacks.MMF_Fog._initialStartDistance
protected

◆ AllowAdditivePlays

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

◆ ColorOverTime

Gradient MoreMountains.Feedbacks.MMF_Fog.ColorOverTime

the colors to apply to the sprite renderer over time

◆ DensityCurve

MMTweenType MoreMountains.Feedbacks.MMF_Fog.DensityCurve = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1f), new Keyframe(1, 0)))

a curve to use to animate the fog's density over time

◆ DensityInstantChange

float MoreMountains.Feedbacks.MMF_Fog.DensityInstantChange

the value to change the fog's density to when in instant mode

◆ DensityRemapOne

float MoreMountains.Feedbacks.MMF_Fog.DensityRemapOne = 0.05f

the value to remap the fog's density curve one value to

◆ DensityRemapZero

float MoreMountains.Feedbacks.MMF_Fog.DensityRemapZero = 0.01f

the value to remap the fog's density curve zero value to

◆ Duration

float MoreMountains.Feedbacks.MMF_Fog.Duration = 2f

how long the sprite renderer should change over time

◆ EndDistanceCurve

MMTweenType MoreMountains.Feedbacks.MMF_Fog.EndDistanceCurve = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1f), new Keyframe(1, 0)))

a curve to use to animate the fog's end distance over time

◆ EndDistanceInstantChange

float MoreMountains.Feedbacks.MMF_Fog.EndDistanceInstantChange

the value to change the fog's end distance to when in instant mode

◆ EndDistanceRemapOne

float MoreMountains.Feedbacks.MMF_Fog.EndDistanceRemapOne = 300f

the value to remap the fog's end distance curve one value to

◆ EndDistanceRemapZero

float MoreMountains.Feedbacks.MMF_Fog.EndDistanceRemapZero = 0f

the value to remap the fog's end distance curve zero value to

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Fog.FeedbackTypeAuthorized = true
static

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

◆ HasRandomness

override bool MoreMountains.Feedbacks.MMF_Fog.HasRandomness => true

sets the inspector color for this feedback

◆ InstantColor

Color MoreMountains.Feedbacks.MMF_Fog.InstantColor

the color to move to in instant mode

◆ Mode

Modes MoreMountains.Feedbacks.MMF_Fog.Mode = Modes.OverTime

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

◆ ModifyColor

bool MoreMountains.Feedbacks.MMF_Fog.ModifyColor = true

whether or not to modify the fog's color

◆ ModifyEndDistance

bool MoreMountains.Feedbacks.MMF_Fog.ModifyEndDistance = true

whether or not to modify the fog's end distance

◆ ModifyFogDensity

bool MoreMountains.Feedbacks.MMF_Fog.ModifyFogDensity = true

whether or not to modify the fog's density

◆ ModifyStartDistance

bool MoreMountains.Feedbacks.MMF_Fog.ModifyStartDistance = true

whether or not to modify the fog's start distance

◆ StartDistanceCurve

MMTweenType MoreMountains.Feedbacks.MMF_Fog.StartDistanceCurve = new MMTweenType(new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.3f, 1f), new Keyframe(1, 0)))

a curve to use to animate the fog's start distance over time

◆ StartDistanceInstantChange

float MoreMountains.Feedbacks.MMF_Fog.StartDistanceInstantChange

the value to change the fog's start distance to when in instant mode

◆ StartDistanceRemapOne

float MoreMountains.Feedbacks.MMF_Fog.StartDistanceRemapOne = 0f

the value to remap the fog's start distance curve one value to

◆ StartDistanceRemapZero

float MoreMountains.Feedbacks.MMF_Fog.StartDistanceRemapZero = 0f

the value to remap the fog's start distance curve zero value to

Property Documentation

◆ FeedbackDuration

override float? MoreMountains.Feedbacks.MMF_Fog.FeedbackDuration
getset

the duration of this feedback is the duration of the sprite renderer, or 0 if instant


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