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

Public Types

enum  Modes { Modes.OverTime, Modes.Instant }
 sets the inspector color for this feedback More...
 

Public Attributes

Modes Mode = Modes.OverTime
 whether the feedback should affect the sprite renderer instantly or over a period of time More...
 
float Duration = 0.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...
 
- Public Attributes inherited from MoreMountains.Feedbacks.MMFeedback
bool Active = true
 whether or not this feedback is active More...
 
string Label = "MMFeedback"
 the name of this feedback to display in the inspector More...
 
float Chance = 100f
 the chance of this feedback happening (in percent : 100 : happens all the time, 0 : never happens, 50 : happens once every two calls, etc) More...
 
MMFeedbackTiming Timing
 a number of timing-related values (delay, repeat, etc) More...
 
bool DebugActive = false
 whether or not this feedback is in debug 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...
 
- Protected Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual void OnEnable ()
 
virtual IEnumerator PlayCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
 An internal coroutine delaying the initial play of the feedback More...
 
virtual void RegularPlay (Vector3 position, float feedbacksIntensity=1.0f)
 Triggers delaying coroutines if needed More...
 
virtual IEnumerator InfinitePlay (Vector3 position, float feedbacksIntensity=1.0f)
 Internal coroutine used for repeated play without end More...
 
virtual IEnumerator RepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f)
 Internal coroutine used for repeated play More...
 
virtual IEnumerator SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
 A coroutine used to play this feedback on a sequence More...
 
virtual float ApplyDirection (float normalizedTime)
 Returns a new value of the normalized time based on the current play direction of this feedback More...
 
virtual float ApplyTimeMultiplier (float duration)
 Applies the host MMFeedbacks' time multiplier to this feedback More...
 
virtual void CustomInitialization (GameObject owner)
 This method describes all custom initialization processes the feedback requires, in addition to the main Initialization method More...
 
virtual void CustomReset ()
 This method describes what happens when the feedback gets reset More...
 

Protected Attributes

Coroutine _coroutine
 
- Protected Attributes inherited from MoreMountains.Feedbacks.MMFeedback
float _lastPlayTimestamp = -1f
 
int _playsLeft
 
bool _initialized = false
 
Coroutine _playCoroutine
 
Coroutine _infinitePlayCoroutine
 
Coroutine _sequenceCoroutine
 
Coroutine _repeatedPlayCoroutine
 
int _sequenceTrackID = 0
 
MMFeedbacks _hostMMFeedbacks
 
float _beatInterval
 
bool BeatThisFrame = false
 
int LastBeatIndex = 0
 
int CurrentSequenceIndex = 0
 
float LastBeatTimestamp = 0f
 
bool _isHostMMFeedbacksNotNull
 
MMChannelData _channelData
 

Properties

override float? FeedbackDuration [get, set]
 the duration of this feedback is the duration of the sprite renderer, or 0 if instant More...
 
- Properties inherited from MoreMountains.Feedbacks.MMFeedback
GameObject Owner [get, set]
 the Owner of the feedback, as defined when calling the Initialization method More...
 
virtual IEnumerator Pause [get]
 set this to true if your feedback should pause the execution of the feedback sequence More...
 
virtual bool HoldingPause [get]
 if this is true, this feedback will wait until all previous feedbacks have run More...
 
virtual bool LooperPause [get]
 if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...
 
virtual bool ScriptDrivenPause [get, set]
 if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution More...
 
virtual float ScriptDrivenPauseAutoResume [get, set]
 if this is a positive value, the feedback will auto resume after that duration if it hasn't been resumed via script already More...
 
virtual bool LooperStart [get]
 if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...
 
virtual bool InCooldown [get]
 returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise More...
 
virtual bool IsPlaying [get, set]
 if this is true, this feedback is currently playing More...
 
float FeedbackTime [get]
 the time (or unscaled time) based on the selected Timing settings More...
 
float FeedbackDeltaTime [get]
 the delta time (or unscaled delta time) based on the selected Timing settings More...
 
float TotalDuration [get]
 The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats)
More...
 
virtual float FeedbackStartedAt [get]
 
virtual float FeedbackDuration [get, set]
 
virtual bool FeedbackPlaying [get]
 whether or not this feedback is playing right now More...
 
virtual bool NormalPlayDirection [get]
 Returns true if this feedback should play normally, or false if it should play in rewind More...
 
virtual bool ShouldPlayInThisSequenceDirection [get]
 Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting More...
 
virtual float? FinalNormalizedTime [get]
 Returns the t value at which to evaluate a curve at the end of this feedback's play time More...
 

Additional Inherited Members

- Public Member Functions inherited from MoreMountains.Feedbacks.MMFeedback
virtual MMChannelData ChannelData (int channel)
 
virtual void Initialization (GameObject owner)
 Initializes the feedback and its timing related variables More...
 
virtual void Play (Vector3 position, float feedbacksIntensity=1.0f)
 Plays the feedback More...
 
virtual void Stop (Vector3 position, float feedbacksIntensity=1.0f)
 Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations More...
 
virtual void ResetFeedback ()
 Calls this feedback's custom reset More...
 
virtual void SetSequence (MMSequence newSequence)
 Use this method to change this feedback's sequence at runtime More...
 
virtual void SetDelayBetweenRepeats (float delay)
 Use this method to specify a new delay between repeats at runtime More...
 
virtual void SetInitialDelay (float delay)
 Use this method to specify a new initial delay at runtime More...
 

Detailed Description

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

Member Enumeration Documentation

◆ Modes

sets the inspector color for this feedback

the possible modes for this feedback

Enumerator
OverTime 
Instant 

Member Function Documentation

◆ CustomPlayFeedback()

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

On Play we change the values of our fog

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMFeedback.

◆ CustomStopFeedback()

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

Stops this feedback

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMFeedback.

◆ FogSequence()

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

This coroutine will modify the values on the fog settings

Returns

◆ SetFogValues()

virtual void MoreMountains.Feedbacks.MMFeedbackFog.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.MMFeedbackFog._coroutine
protected

◆ AllowAdditivePlays

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

the colors to apply to the sprite renderer over time

◆ DensityCurve

MMTweenType MoreMountains.Feedbacks.MMFeedbackFog.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.MMFeedbackFog.DensityInstantChange

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

◆ DensityRemapOne

float MoreMountains.Feedbacks.MMFeedbackFog.DensityRemapOne = 0.05f

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

◆ DensityRemapZero

float MoreMountains.Feedbacks.MMFeedbackFog.DensityRemapZero = 0.01f

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

◆ Duration

float MoreMountains.Feedbacks.MMFeedbackFog.Duration = 0.2f

how long the sprite renderer should change over time

◆ EndDistanceCurve

MMTweenType MoreMountains.Feedbacks.MMFeedbackFog.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.MMFeedbackFog.EndDistanceInstantChange

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

◆ EndDistanceRemapOne

float MoreMountains.Feedbacks.MMFeedbackFog.EndDistanceRemapOne = 300f

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

◆ EndDistanceRemapZero

float MoreMountains.Feedbacks.MMFeedbackFog.EndDistanceRemapZero = 0f

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

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMFeedbackFog.FeedbackTypeAuthorized = true
static

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

◆ InstantColor

Color MoreMountains.Feedbacks.MMFeedbackFog.InstantColor

the color to move to in instant mode

◆ Mode

Modes MoreMountains.Feedbacks.MMFeedbackFog.Mode = Modes.OverTime

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

◆ ModifyColor

bool MoreMountains.Feedbacks.MMFeedbackFog.ModifyColor = true

whether or not to modify the fog's color

◆ ModifyEndDistance

bool MoreMountains.Feedbacks.MMFeedbackFog.ModifyEndDistance = true

whether or not to modify the fog's end distance

◆ ModifyFogDensity

bool MoreMountains.Feedbacks.MMFeedbackFog.ModifyFogDensity = true

whether or not to modify the fog's density

◆ ModifyStartDistance

bool MoreMountains.Feedbacks.MMFeedbackFog.ModifyStartDistance = true

whether or not to modify the fog's start distance

◆ StartDistanceCurve

MMTweenType MoreMountains.Feedbacks.MMFeedbackFog.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.MMFeedbackFog.StartDistanceInstantChange

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

◆ StartDistanceRemapOne

float MoreMountains.Feedbacks.MMFeedbackFog.StartDistanceRemapOne = 0f

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

◆ StartDistanceRemapZero

float MoreMountains.Feedbacks.MMFeedbackFog.StartDistanceRemapZero = 0f

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

Property Documentation

◆ FeedbackDuration

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