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

This feedback allows you to control vignette intensity over time. It requires you have in your scene an object with a PostProcessVolume with Vignette active, and a MMVignetteShaker component. More...

Inheritance diagram for MoreMountains.FeedbacksForThirdParty.MMF_Vignette:
MoreMountains.Feedbacks.MMF_Feedback

Public Attributes

override bool HasChannel => true
 
override bool HasRandomness => true
 
float Duration = 0.2f
 the duration of the shake, in seconds More...
 
bool ResetShakerValuesAfterShake = true
 whether or not to reset shaker values after shake More...
 
bool ResetTargetValuesAfterShake = true
 whether or not to reset the target's values after shake More...
 
AnimationCurve Intensity = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the curve to animate the intensity on More...
 
float RemapIntensityZero = 0f
 the value to remap the intensity's zero to More...
 
float RemapIntensityOne = 1.0f
 the value to remap the intensity's one to More...
 
bool RelativeIntensity = false
 whether or not to add to the initial intensity More...
 
bool InterpolateColor = false
 whether or not to also animate the vignette's color More...
 
AnimationCurve ColorCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.05f, 1f), new Keyframe(0.95f, 1), new Keyframe(1, 0))
 the curve to animate the color on More...
 
float RemapColorZero = 0f
 the value to remap the curve's 0 to More...
 
float RemapColorOne = 1f
 the value to remap the curve's 1 to More...
 
Color TargetColor = Color.red
 the color to lerp towards More...
 

Static Public Attributes

static bool FeedbackTypeAuthorized = true
 a static bool used to disable all feedbacks of this type at once More...
 

Protected Member Functions

override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 Triggers a vignette shake More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 On stop we stop our transition More...
 
override void CustomRestoreInitialValues ()
 On restore, we put our object back at its initial position More...
 

Properties

override float FeedbackDuration [get, set]
 sets the inspector color for this feedback More...
 

Additional Inherited Members

Detailed Description

This feedback allows you to control vignette intensity over time. It requires you have in your scene an object with a PostProcessVolume with Vignette active, and a MMVignetteShaker component.

Member Function Documentation

◆ CustomPlayFeedback()

override void MoreMountains.FeedbacksForThirdParty.MMF_Vignette.CustomPlayFeedback ( Vector3  position,
float  feedbacksIntensity = 1.0f 
)
protectedvirtual

Triggers a vignette shake

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

override void MoreMountains.FeedbacksForThirdParty.MMF_Vignette.CustomRestoreInitialValues ( )
protectedvirtual

On restore, we put our object back at its initial position

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.FeedbacksForThirdParty.MMF_Vignette.CustomStopFeedback ( Vector3  position,
float  feedbacksIntensity = 1 
)
protectedvirtual

On stop we stop our transition

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ ColorCurve

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMF_Vignette.ColorCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.05f, 1f), new Keyframe(0.95f, 1), new Keyframe(1, 0))

the curve to animate the color on

◆ Duration

float MoreMountains.FeedbacksForThirdParty.MMF_Vignette.Duration = 0.2f

the duration of the shake, in seconds

◆ FeedbackTypeAuthorized

bool MoreMountains.FeedbacksForThirdParty.MMF_Vignette.FeedbackTypeAuthorized = true
static

a static bool used to disable all feedbacks of this type at once

◆ HasChannel

override bool MoreMountains.FeedbacksForThirdParty.MMF_Vignette.HasChannel => true

◆ HasRandomness

override bool MoreMountains.FeedbacksForThirdParty.MMF_Vignette.HasRandomness => true

◆ Intensity

AnimationCurve MoreMountains.FeedbacksForThirdParty.MMF_Vignette.Intensity = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the curve to animate the intensity on

◆ InterpolateColor

bool MoreMountains.FeedbacksForThirdParty.MMF_Vignette.InterpolateColor = false

whether or not to also animate the vignette's color

◆ RelativeIntensity

bool MoreMountains.FeedbacksForThirdParty.MMF_Vignette.RelativeIntensity = false

whether or not to add to the initial intensity

◆ RemapColorOne

float MoreMountains.FeedbacksForThirdParty.MMF_Vignette.RemapColorOne = 1f

the value to remap the curve's 1 to

◆ RemapColorZero

float MoreMountains.FeedbacksForThirdParty.MMF_Vignette.RemapColorZero = 0f

the value to remap the curve's 0 to

◆ RemapIntensityOne

float MoreMountains.FeedbacksForThirdParty.MMF_Vignette.RemapIntensityOne = 1.0f

the value to remap the intensity's one to

◆ RemapIntensityZero

float MoreMountains.FeedbacksForThirdParty.MMF_Vignette.RemapIntensityZero = 0f

the value to remap the intensity's zero to

◆ ResetShakerValuesAfterShake

bool MoreMountains.FeedbacksForThirdParty.MMF_Vignette.ResetShakerValuesAfterShake = true

whether or not to reset shaker values after shake

◆ ResetTargetValuesAfterShake

bool MoreMountains.FeedbacksForThirdParty.MMF_Vignette.ResetTargetValuesAfterShake = true

whether or not to reset the target's values after shake

◆ TargetColor

Color MoreMountains.FeedbacksForThirdParty.MMF_Vignette.TargetColor = Color.red

the color to lerp towards

Property Documentation

◆ FeedbackDuration

override float MoreMountains.FeedbacksForThirdParty.MMF_Vignette.FeedbackDuration
getset

sets the inspector color for this feedback

the duration of this feedback is the duration of the shake


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