Infinite Runner Engine v1.9
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP Class Reference

Add this class to a Camera with a HDRP color adjustments post processing and it'll be able to "shake" its values by getting events More...

Inheritance diagram for MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP:
MoreMountains.Feedbacks.MMShaker

Public Member Functions

virtual void OnMMChannelMixerShakeEvent (AnimationCurve shakeRed, float remapRedZero, float remapRedOne, AnimationCurve shakeGreen, float remapGreenZero, float remapGreenOne, AnimationCurve shakeBlue, float remapBlueZero, float remapBlueOne, float duration, bool relativeValues=false, float attenuation=1.0f, int channel=0, bool resetShakerValuesAfterShake=true, bool resetTargetValuesAfterShake=true, bool forwardDirection=true, TimescaleModes timescaleMode=TimescaleModes.Scaled, bool stop=false)
 When we get the appropriate event, we trigger a shake More...
 
override void StartListening ()
 Starts listening for events More...
 
override void StopListening ()
 Stops listening for events More...
 
- Public Member Functions inherited from MoreMountains.Feedbacks.MMShaker
virtual float GetTime ()
 
virtual float GetDeltaTime ()
 
virtual void StartShaking ()
 Starts shaking the values More...
 
virtual void Play ()
 Starts this shaker More...
 
virtual void Stop ()
 Stops this shaker More...
 

Public Attributes

bool RelativeValues = true
 whether or not to add to the initial value More...
 
AnimationCurve ShakeRed = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the red value on More...
 
float RemapRedZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapRedOne = 200f
 the value to remap the curve's 1 to More...
 
AnimationCurve ShakeGreen = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the green value on More...
 
float RemapGreenZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapGreenOne = 200f
 the value to remap the curve's 1 to More...
 
AnimationCurve ShakeBlue = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the blue value on More...
 
float RemapBlueZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapBlueOne = 200f
 the value to remap the curve's 1 to More...
 
- Public Attributes inherited from MoreMountains.Feedbacks.MMShaker
int Channel = 0
 the channel to listen to - has to match the one on the feedback More...
 
float ShakeDuration = 0.2f
 the duration of the shake, in seconds More...
 
bool PlayOnAwake = false
 if this is true this shaker will play on awake More...
 
bool Interruptible = true
 if this is true, a new shake can happen while shaking More...
 
bool AlwaysResetTargetValuesAfterShake = false
 if this is true, this shaker will always reset target values, regardless of how it was called More...
 
float CooldownBetweenShakes = 0f
 a cooldown, in seconds, after a shake, during which no other shake can start More...
 
bool Shaking = false
 whether or not this shaker is shaking right now More...
 
bool ForwardDirection = true
 
TimescaleModes TimescaleMode = TimescaleModes.Scaled
 

Protected Member Functions

override void Initialization ()
 On init we initialize our values More...
 
virtual void Reset ()
 When that shaker gets added, we initialize its shake duration More...
 
override void Shake ()
 Shakes values over time More...
 
override void GrabInitialValues ()
 Collects initial values on the target More...
 
override void ResetTargetValues ()
 Resets the target's values More...
 
override void ResetShakerValues ()
 Resets the shaker's values More...
 
- Protected Member Functions inherited from MoreMountains.Feedbacks.MMShaker
virtual void Awake ()
 On Awake we grab our volume and profile More...
 
virtual void ShakeStarts ()
 Describes what happens when a shake starts More...
 
virtual void Update ()
 On Update, we shake our values if needed, or reset if our shake has ended More...
 
virtual float ShakeFloat (AnimationCurve curve, float remapMin, float remapMax, bool relativeIntensity, float initialValue)
 A method used to "shake" a flot over time along a curve More...
 
virtual void ShakeComplete ()
 Describes what happens when the shake is complete More...
 
virtual void OnEnable ()
 On enable we start shaking if needed More...
 
virtual void OnDestroy ()
 On destroy we stop listening for events More...
 
virtual void OnDisable ()
 On disable we complete our shake if it was in progress More...
 
virtual bool CheckEventAllowed (int channel, bool useRange=false, float range=0f, Vector3 eventOriginPosition=default(Vector3))
 Returns true if this shaker should listen to events, false otherwise More...
 

Protected Attributes

Volume _volume
 
ChannelMixer _channelMixer
 
float _initialRed
 
float _initialGreen
 
float _initialBlue
 
float _initialContrast
 
Color _initialColorFilterColor
 
float _originalShakeDuration
 
bool _originalRelativeValues
 
AnimationCurve _originalShakeRed
 
float _originalRemapRedZero
 
float _originalRemapRedOne
 
AnimationCurve _originalShakeGreen
 
float _originalRemapGreenZero
 
float _originalRemapGreenOne
 
AnimationCurve _originalShakeBlue
 
float _originalRemapBlueZero
 
float _originalRemapBlueOne
 
- Protected Attributes inherited from MoreMountains.Feedbacks.MMShaker
float _shakeStartedTimestamp = -Single.MaxValue
 
float _remappedTimeSinceStart
 
bool _resetShakerValuesAfterShake
 
bool _resetTargetValuesAfterShake
 
float _journey
 

Additional Inherited Members

- Properties inherited from MoreMountains.Feedbacks.MMShaker
bool ListeningToEvents [get]
 

Detailed Description

Add this class to a Camera with a HDRP color adjustments post processing and it'll be able to "shake" its values by getting events

Member Function Documentation

◆ GrabInitialValues()

override void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.GrabInitialValues ( )
protectedvirtual

Collects initial values on the target

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Initialization()

override void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.Initialization ( )
protectedvirtual

On init we initialize our values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ OnMMChannelMixerShakeEvent()

virtual void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.OnMMChannelMixerShakeEvent ( AnimationCurve  shakeRed,
float  remapRedZero,
float  remapRedOne,
AnimationCurve  shakeGreen,
float  remapGreenZero,
float  remapGreenOne,
AnimationCurve  shakeBlue,
float  remapBlueZero,
float  remapBlueOne,
float  duration,
bool  relativeValues = false,
float  attenuation = 1.0f,
int  channel = 0,
bool  resetShakerValuesAfterShake = true,
bool  resetTargetValuesAfterShake = true,
bool  forwardDirection = true,
TimescaleModes  timescaleMode = TimescaleModes.Scaled,
bool  stop = false 
)
virtual

When we get the appropriate event, we trigger a shake

Parameters
intensity
duration
amplitude
relativeIntensity
attenuation
channel

◆ Reset()

virtual void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.Reset ( )
protectedvirtual

When that shaker gets added, we initialize its shake duration

◆ ResetShakerValues()

override void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.ResetShakerValues ( )
protectedvirtual

Resets the shaker's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ResetTargetValues()

override void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.ResetTargetValues ( )
protectedvirtual

Resets the target's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Shake()

override void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.Shake ( )
protectedvirtual

Shakes values over time

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StartListening()

override void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.StartListening ( )
virtual

Starts listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StopListening()

override void MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.StopListening ( )
virtual

Stops listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

◆ _channelMixer

ChannelMixer MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._channelMixer
protected

◆ _initialBlue

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._initialBlue
protected

◆ _initialColorFilterColor

Color MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._initialColorFilterColor
protected

◆ _initialContrast

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._initialContrast
protected

◆ _initialGreen

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._initialGreen
protected

◆ _initialRed

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._initialRed
protected

◆ _originalRelativeValues

bool MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalRelativeValues
protected

◆ _originalRemapBlueOne

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalRemapBlueOne
protected

◆ _originalRemapBlueZero

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalRemapBlueZero
protected

◆ _originalRemapGreenOne

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalRemapGreenOne
protected

◆ _originalRemapGreenZero

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalRemapGreenZero
protected

◆ _originalRemapRedOne

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalRemapRedOne
protected

◆ _originalRemapRedZero

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalRemapRedZero
protected

◆ _originalShakeBlue

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalShakeBlue
protected

◆ _originalShakeDuration

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalShakeDuration
protected

◆ _originalShakeGreen

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalShakeGreen
protected

◆ _originalShakeRed

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._originalShakeRed
protected

◆ _volume

Volume MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP._volume
protected

◆ RelativeValues

bool MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.RelativeValues = true

whether or not to add to the initial value

◆ RemapBlueOne

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.RemapBlueOne = 200f

the value to remap the curve's 1 to

◆ RemapBlueZero

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.RemapBlueZero = 0f

the value to remap the curve's 0 to

◆ RemapGreenOne

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.RemapGreenOne = 200f

the value to remap the curve's 1 to

◆ RemapGreenZero

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.RemapGreenZero = 0f

the value to remap the curve's 0 to

◆ RemapRedOne

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.RemapRedOne = 200f

the value to remap the curve's 1 to

◆ RemapRedZero

float MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.RemapRedZero = 0f

the value to remap the curve's 0 to

◆ ShakeBlue

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.ShakeBlue = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the blue value on

◆ ShakeGreen

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.ShakeGreen = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the green value on

◆ ShakeRed

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMChannelMixerShaker_HDRP.ShakeRed = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the red value on


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