Feel  5.4
The best way to improve your game's feel and make it extra juicy
MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP 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_URP:
MoreMountains.Tools.MMEventListener< MMPostProcessingVolumeAutoBlendURPShakeEvent >

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 Member Functions

virtual void Blend ()
 Blends the volume's weight from the initial value to the final one More...
 
virtual void BlendBack ()
 Blends the volume's weight from the final value to the initial one More...
 
virtual void StopBlending ()
 Stops any blending that may be in progress More...
 
virtual void RestoreInitialValues ()
 
void OnMMEvent (MMPostProcessingVolumeAutoBlendURPShakeEvent shakeEvent)
 When we catch a MMPostProcessingVolumeAutoBlendShakeEvent, we start blending More...
 
- Public Member Functions inherited from MoreMountains.Tools.MMEventListener< MMPostProcessingVolumeAutoBlendURPShakeEvent >
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 More...
 
MMChannel MMChannelDefinition = null
 
BlendTriggerModes BlendTriggerMode = BlendTriggerModes.Script
 
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...
 
virtual void OnEnable ()
 On start we start blending if needed More...
 
virtual void StartBlending ()
 Internal method used to start blending More...
 
virtual void Update ()
 On update, processes the blend if needed More...
 
void OnDestroy ()
 On Destroy, we stop listening for events 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

◆ Blend()

virtual void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.Blend ( )
virtual

Blends the volume's weight from the initial value to the final one

◆ BlendBack()

virtual void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.BlendBack ( )
virtual

Blends the volume's weight from the final value to the initial one

◆ GetTime()

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.GetTime ( )
protected

Returns the correct timescale based on the chosen settings

Returns

◆ OnDestroy()

void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.OnDestroy ( )
protected

On Destroy, we stop listening for events

◆ OnEnable()

virtual void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.OnEnable ( )
protectedvirtual

On start we start blending if needed

◆ OnMMEvent()

void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.OnMMEvent ( MMPostProcessingVolumeAutoBlendURPShakeEvent  shakeEvent)

When we catch a MMPostProcessingVolumeAutoBlendShakeEvent, we start blending

Parameters
eventType
Exceptions
NotImplementedException

◆ RestoreInitialValues()

virtual void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.RestoreInitialValues ( )
virtual

◆ StartBlending()

virtual void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.StartBlending ( )
protectedvirtual

Internal method used to start blending

◆ StopBlending()

virtual void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.StopBlending ( )
virtual

Stops any blending that may be in progress

◆ Update()

virtual void MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.Update ( )
protectedvirtual

On update, processes the blend if needed

Member Data Documentation

◆ _blending

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP._blending = false
protected

◆ _destination

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP._destination
protected

◆ _initial

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP._initial
protected

◆ _startTime

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP._startTime
protected

◆ BlendDuration

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.BlendDuration = 1f

the duration of the blend (in seconds)

◆ BlendTriggerMode

BlendTriggerModes MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.BlendTriggerMode = BlendTriggerModes.Script

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

◆ Channel

int MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.Channel = 0

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

◆ ChannelMode

MMChannelModes MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.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_URP.Curve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(1, 1f))

the curve to use to blend

◆ DisableSelfAfterEnd

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.DisableSelfAfterEnd = true

whether or not this blender should disable itself at 0

◆ DisableVolumeOnZeroWeight

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.DisableVolumeOnZeroWeight = true

whether or not the associated volume should be disabled at 0

◆ FinalWeight

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.FinalWeight = 1f

the desired weight at the end of the blend

◆ InitialWeight

float MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.InitialWeight = 0f

the weight at the start of the blend

◆ Interruptable

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.Interruptable = true

whether or not this blender can be interrupted

◆ MMChannelDefinition

MMChannel MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.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_URP.ResetToInitialValueOnEnd = false

reset to initial value on end

◆ StartFromCurrentValue

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.StartFromCurrentValue = true

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

◆ TestBlend

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.TestBlend

test blend button

◆ TestBlendBackwards

bool MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.TestBlendBackwards

test blend back button

◆ TimeScale

TimeScales MoreMountains.FeedbacksForThirdParty.MMGlobalPostProcessingVolumeAutoBlend_URP.TimeScale = TimeScales.Unscaled

the timescale to operate on


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