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

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

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

Public Member Functions

virtual void OnVignetteShakeEvent (AnimationCurve intensity, float duration, float remapMin, float remapMax, bool relativeIntensity=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 RelativeIntensity = false
 whether or not to add to the initial value More...
 
AnimationCurve ShakeIntensity = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve used to animate the intensity value on More...
 
float RemapIntensityZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapIntensityOne = 1f
 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...
 
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
 
Vignette _vignette
 
float _initialIntensity
 
float _originalShakeDuration
 
AnimationCurve _originalShakeIntensity
 
float _originalRemapIntensityZero
 
float _originalRemapIntensityOne
 
bool _originalRelativeIntensity
 
- 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 vignette post processing and it'll be able to "shake" its values by getting events

Member Function Documentation

◆ GrabInitialValues()

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

Collects initial values on the target

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Initialization()

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

On init we initialize our values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ OnVignetteShakeEvent()

virtual void MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP.OnVignetteShakeEvent ( AnimationCurve  intensity,
float  duration,
float  remapMin,
float  remapMax,
bool  relativeIntensity = 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

◆ ResetShakerValues()

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

Resets the shaker's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ResetTargetValues()

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

Resets the target's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Shake()

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

Shakes values over time

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StartListening()

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

Starts listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StopListening()

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

Stops listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

◆ _initialIntensity

float MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._initialIntensity
protected

◆ _originalRelativeIntensity

bool MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._originalRelativeIntensity
protected

◆ _originalRemapIntensityOne

float MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._originalRemapIntensityOne
protected

◆ _originalRemapIntensityZero

float MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._originalRemapIntensityZero
protected

◆ _originalShakeDuration

float MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._originalShakeDuration
protected

◆ _originalShakeIntensity

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._originalShakeIntensity
protected

◆ _vignette

Vignette MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._vignette
protected

◆ _volume

Volume MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP._volume
protected

◆ RelativeIntensity

bool MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP.RelativeIntensity = false

whether or not to add to the initial value

◆ RemapIntensityOne

float MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP.RemapIntensityOne = 1f

the value to remap the curve's 1 to

◆ RemapIntensityZero

float MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP.RemapIntensityZero = 0f

the value to remap the curve's 0 to

◆ ShakeIntensity

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMVignetteShaker_HDRP.ShakeIntensity = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve used to animate the intensity value on


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