Corgi Engine v9.4
Loading...
Searching...
No Matches
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:
MoreMountains.Tools.MMEventListener< T > MoreMountains.Tools.MMEventListenerBase

Public Types

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

Public Member Functions

void OnMMEvent (MMPostProcessingVolumeAutoBlendShakeEvent shakeEvent)
 When we catch a MMPostProcessingVolumeAutoBlendShakeEvent, we start blending.
Public Member Functions inherited from MoreMountains.Tools.MMEventListener< T >
void OnMMEvent (T eventType)

Public Attributes

MMChannelModes ChannelMode = MMChannelModes.Int
int Channel = 0
 the channel to listen to - has to match the one on the feedback
MMChannel MMChannelDefinition = null
BlendTriggerModes BlendTriggerMode = BlendTriggerModes.Script
 the trigger mode for this MMGlobalPostProcessingVolumeAutoBlend
float BlendDuration = 1f
 the duration of the blend (in seconds)
AnimationCurve Curve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1f))
 the curve to use to blend
float InitialWeight = 0f
 the weight at the start of the blend
float FinalWeight = 1f
 the desired weight at the end of the blend
TimeScales TimeScale = TimeScales.Unscaled
 the timescale to operate on
bool DisableVolumeOnZeroWeight = true
 whether or not the associated volume should be disabled at 0
bool DisableSelfAfterEnd = true
 whether or not this blender should disable itself at 0
bool Interruptable = true
 whether or not this blender can be interrupted
bool StartFromCurrentValue = true
 whether or not this blender should pick the current value as its starting point
bool ResetToInitialValueOnEnd = false
 reset to initial value on end
bool TestBlend
 test blend button
bool TestBlendBackwards
 test blend back button

Protected Member Functions

float GetTime ()
 Returns the correct timescale based on the chosen settings.
void OnDestroy ()
 On Destroy, we stop listening for events.

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

enum MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.BlendTriggerModes

the possible blend trigger modes

Enumerator
OnEnable 
Script 

◆ TimeScales

enum MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.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

◆ OnDestroy()

void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.OnDestroy ( )
protected

On Destroy, we stop listening for events.

◆ OnMMEvent()

void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.OnMMEvent ( MMPostProcessingVolumeAutoBlendShakeEvent shakeEvent)

When we catch a MMPostProcessingVolumeAutoBlendShakeEvent, we start blending.

Parameters
eventType
Exceptions
NotImplementedException

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.Script

the trigger mode for this MMGlobalPostProcessingVolumeAutoBlend

◆ Channel

int MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.Channel = 0

the channel to listen to - has to match the one on the feedback

◆ ChannelMode

MMChannelModes MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.ChannelMode = MMChannelModes.Int

whether to listen on a channel defined by an int or by a MMChannel scriptable object. Ints are simple to setup but can get messy and make it harder to remember what int corresponds to what. MMChannel scriptable objects require you to create them in advance, but come with a readable name and are more scalable

◆ 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

◆ MMChannelDefinition

MMChannel MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend.MMChannelDefinition = null

the MMChannel definition asset to use to listen for events. The feedbacks targeting this shaker will have to reference that same MMChannel definition to receive events - to create a MMChannel, right click anywhere in your project (usually in a Data folder) and go MoreMountains > MMChannel, then name it with some unique name

◆ 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: