Feel  4.0
The best way to improve your game's feel and make it extra juicy
MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend Class Reference

Use this class to have a global PP volume auto blend its weight on cue, between a start and end values More...

Inheritance diagram for MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend:

Public Types

enum  TimeScales { TimeScales.Scaled, TimeScales.Unscaled }
 the possible timescales this blend can operate on More...
 
enum  BlendTriggerModes { BlendTriggerModes.OnEnable, BlendTriggerModes.Script }
 the possible blend trigger modes More...
 

Public Attributes

BlendTriggerModes BlendTriggerMode = BlendTriggerModes.OnEnable
 
float BlendDuration = 1f
 the duration of the blend (in seconds) More...
 
AnimationCurve Curve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1f))
 the curve to use to blend More...
 
float InitialWeight = 0f
 the weight at the start of the blend More...
 
float FinalWeight = 1f
 the desired weight at the end of the blend More...
 
TimeScales TimeScale = TimeScales.Unscaled
 the timescale to operate on More...
 
bool DisableVolumeOnZeroWeight = true
 whether or not the associated volume should be disabled at 0 More...
 
bool DisableSelfAfterEnd = true
 whether or not this blender should disable itself at 0 More...
 
bool Interruptable = true
 whether or not this blender can be interrupted More...
 
bool StartFromCurrentValue = true
 whether or not this blender should pick the current value as its starting point More...
 
bool ResetToInitialValueOnEnd = false
 reset to initial value on end More...
 
bool TestBlend
 test blend button More...
 
bool TestBlendBackwards
 test blend back button More...
 

Protected Member Functions

float GetTime ()
 Returns the correct timescale based on the chosen settings More...
 

Protected Attributes

float _initial
 
float _destination
 
float _startTime
 
bool _blending = false
 

Detailed Description

Use this class to have a global PP volume auto blend its weight on cue, between a start and end values

Member Enumeration Documentation

◆ BlendTriggerModes

the possible blend trigger modes

Enumerator
OnEnable 
Script 

◆ TimeScales

the possible timescales this blend can operate on

Enumerator
Scaled 
Unscaled 

Member Function Documentation

◆ GetTime()

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.GetTime ( )
protected

Returns the correct timescale based on the chosen settings

Returns

Member Data Documentation

◆ _blending

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend._blending = false
protected

◆ _destination

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend._destination
protected

◆ _initial

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend._initial
protected

◆ _startTime

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend._startTime
protected

◆ BlendDuration

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.BlendDuration = 1f

the duration of the blend (in seconds)

◆ BlendTriggerMode

BlendTriggerModes MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.BlendTriggerMode = BlendTriggerModes.OnEnable

the trigger mode for this MMGlobalPostProcessingVolumeAutoBlend Start : will play automatically on enable

◆ Curve

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.Curve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1f))

the curve to use to blend

◆ DisableSelfAfterEnd

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.DisableSelfAfterEnd = true

whether or not this blender should disable itself at 0

◆ DisableVolumeOnZeroWeight

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.DisableVolumeOnZeroWeight = true

whether or not the associated volume should be disabled at 0

◆ FinalWeight

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.FinalWeight = 1f

the desired weight at the end of the blend

◆ InitialWeight

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.InitialWeight = 0f

the weight at the start of the blend

◆ Interruptable

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.Interruptable = true

whether or not this blender can be interrupted

◆ ResetToInitialValueOnEnd

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.ResetToInitialValueOnEnd = false

reset to initial value on end

◆ StartFromCurrentValue

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.StartFromCurrentValue = true

whether or not this blender should pick the current value as its starting point

◆ TestBlend

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.TestBlend

test blend button

◆ TestBlendBackwards

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.TestBlendBackwards

test blend back button

◆ TimeScale

TimeScales MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.TimeScale = TimeScales.Unscaled

the timescale to operate on


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