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

This shaker will let you move the scale of a transform, either once or permanently, shaking its scale for the specified duration and within the specified range. You can apply that shake along a direction, randomized or not, with optional noise and attenuation More...

Inheritance diagram for MoreMountains.Feedbacks.MMScaleShaker:
MoreMountains.Feedbacks.MMShaker MoreMountains.Tools.MMMonoBehaviour

Public Types

enum  Modes { Modes.Transform, Modes.RectTransform }
 

Public Member Functions

virtual void GrabInitialScale ()
 
virtual void OnMMScaleShakeEvent (float duration, float shakeSpeed, float shakeRange, Vector3 shakeMainDirection, bool randomizeDirection, Vector3 shakeAltDirection, bool randomizeDirectionOnPlay, bool addDirectionalNoise, Vector3 directionalNoiseStrengthMin, Vector3 directionalNoiseStrengthMax, Vector3 randomnessSeed, bool randomizeSeedOnShake, bool useAttenuation, AnimationCurve attenuationCurve, bool useRange=false, float rangeDistance=0f, bool useRangeFalloff=false, AnimationCurve rangeFalloff=null, Vector2 remapRangeFalloff=default(Vector2), Vector3 rangePosition=default(Vector3), float feedbacksIntensity=1.0f, MMChannelData channelData=null, bool resetShakerValuesAfterShake=true, bool resetTargetValuesAfterShake=true, bool forwardDirection=true, TimescaleModes timescaleMode=TimescaleModes.Scaled, bool stop=false, bool restore=false)
 
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 ForceInitialization ()
 Call this externally if you need to force a new initialization More...
 
virtual void StartShaking ()
 Starts shaking the values More...
 
virtual void Play ()
 Starts this shaker More...
 
virtual void Stop ()
 Stops this shaker More...
 
virtual float ComputeRangeIntensity (bool useRange, float rangeDistance, bool useRangeFalloff, AnimationCurve rangeFalloff, Vector2 remapRangeFalloff, Vector3 rangePosition)
 

Public Attributes

Modes Mode = Modes.Transform
 whether this shaker should target Transforms or RectTransforms More...
 
Transform TargetTransform
 the transform to shake the scale of. If left blank, this component will target the transform it's put on. More...
 
RectTransform TargetRectTransform
 the rect transform to shake the scale of. If left blank, this component will target the transform it's put on. More...
 
float ShakeSpeed = 20f
 the speed at which the transform should shake More...
 
float ShakeRange = 0.5f
 the maximum distance from its initial scale the transform will move to during the shake More...
 
Vector3 ShakeMainDirection = Vector3.up
 the direction along which to shake the transform's scale More...
 
bool RandomizeDirection = false
 if this is true, instead of using ShakeMainDirection as the direction of the shake, a random vector3 will be generated, randomized between ShakeMainDirection and ShakeAltDirection More...
 
Vector3 ShakeAltDirection = Vector3.up
 when in RandomizeDirection mode, a vector against which to randomize the main direction More...
 
bool RandomizeDirectionOnPlay = false
 if this is true, a new direction will be randomized every time a shake happens More...
 
bool AddDirectionalNoise = true
 whether or not to add noise to the main direction More...
 
Vector3 DirectionalNoiseStrengthMin = new Vector3(0.25f, 0.25f, 0.25f)
 when adding directional noise, noise strength will be randomized between this value and DirectionalNoiseStrengthMax More...
 
Vector3 DirectionalNoiseStrengthMax = new Vector3(0.25f, 0.25f, 0.25f)
 when adding directional noise, noise strength will be randomized between this value and DirectionalNoiseStrengthMin More...
 
Vector3 RandomnessSeed
 a unique seed you can use to get different outcomes when shaking more than one transform at once More...
 
bool RandomizeSeedOnShake = true
 whether or not to generate a unique seed automatically on every shake More...
 
bool UseAttenuation = true
 whether or not to use attenuation, which will impact the amplitude of the shake, along the defined curve More...
 
AnimationCurve AttenuationCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))
 the animation curve used to define attenuation, impacting the amplitude of the shake More...
 
bool StartShakingButton
 
virtual float Randomness => RandomnessSeed.x + RandomnessSeed.y + RandomnessSeed.z
 
- Public Attributes inherited from MoreMountains.Feedbacks.MMShaker
MMChannelModes ChannelMode = MMChannelModes.Int
 
int Channel = 0
 the channel to listen to - has to match the one on the feedback More...
 
MMChannel MMChannelDefinition = null
 
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 PermanentShake = false
 if this is true, the shaker will shake permanently as long as its game object is active 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...
 
bool OnlyUseShakerValues = false
 if this is true, this shaker will ignore any value passed in an event that triggered it, and will instead use the values set on its inspector 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
 
virtual MMChannelData ChannelData => new MMChannelData(ChannelMode, Channel, MMChannelDefinition)
 
virtual bool ListeningToEvents => _listeningToEvents
 

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 ShakeStarts ()
 Describes what happens when a shake starts More...
 
override void Shake ()
 Override this method to implement shake over time More...
 
override void ShakeComplete ()
 Describes what happens when the shake is complete More...
 
virtual void ApplyNewScale (Vector3 newScale)
 
virtual Vector3 ComputeNewScale ()
 
virtual float ComputeAttenuation (float remappedTime)
 
virtual Vector3 ComputeNoise (float time)
 
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 GrabInitialValues ()
 A method designed to collect initial values 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 Color ShakeGradient (Gradient gradient)
 
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 (MMChannelData channelData, bool useRange=false, float range=0f, Vector3 eventOriginPosition=default(Vector3))
 Returns true if this shaker should listen to events, false otherwise More...
 

Protected Attributes

float _attenuation = 1f
 
float _oscillation
 
Vector3 _initialScale
 
Vector3 _workDirection
 
Vector3 _noiseVector
 
Vector3 _newScale
 
Vector3 _randomNoiseStrength
 
Vector3 _noNoise = Vector3.zero
 
Vector3 _randomizedDirection
 
float _originalDuration
 
float _originalShakeSpeed
 
float _originalShakeRange
 
Vector3 _originalShakeMainDirection
 
bool _originalRandomizeDirection
 
Vector3 _originalShakeAltDirection
 
bool _originalRandomizeDirectionOnPlay
 
bool _originalAddDirectionalNoise
 
Vector3 _originalDirectionalNoiseStrengthMin
 
Vector3 _originalDirectionalNoiseStrengthMax
 
Vector3 _originalRandomnessSeed
 
bool _originalRandomizeSeedOnShake
 
bool _originalUseAttenuation
 
AnimationCurve _originalAttenuationCurve
 
- Protected Attributes inherited from MoreMountains.Feedbacks.MMShaker
float _shakeStartedTimestamp = -Single.MaxValue
 
float _remappedTimeSinceStart
 
bool _resetShakerValuesAfterShake
 
bool _resetTargetValuesAfterShake
 
float _journey
 

Detailed Description

This shaker will let you move the scale of a transform, either once or permanently, shaking its scale for the specified duration and within the specified range. You can apply that shake along a direction, randomized or not, with optional noise and attenuation

Member Enumeration Documentation

◆ Modes

Enumerator
Transform 
RectTransform 

Member Function Documentation

◆ ApplyNewScale()

virtual void MoreMountains.Feedbacks.MMScaleShaker.ApplyNewScale ( Vector3  newScale)
protectedvirtual

◆ ComputeAttenuation()

virtual float MoreMountains.Feedbacks.MMScaleShaker.ComputeAttenuation ( float  remappedTime)
protectedvirtual

◆ ComputeNewScale()

virtual Vector3 MoreMountains.Feedbacks.MMScaleShaker.ComputeNewScale ( )
protectedvirtual

◆ ComputeNoise()

virtual Vector3 MoreMountains.Feedbacks.MMScaleShaker.ComputeNoise ( float  time)
protectedvirtual

◆ GrabInitialScale()

virtual void MoreMountains.Feedbacks.MMScaleShaker.GrabInitialScale ( )
virtual

◆ Initialization()

override void MoreMountains.Feedbacks.MMScaleShaker.Initialization ( )
protectedvirtual

On init we initialize our values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ OnMMScaleShakeEvent()

virtual void MoreMountains.Feedbacks.MMScaleShaker.OnMMScaleShakeEvent ( float  duration,
float  shakeSpeed,
float  shakeRange,
Vector3  shakeMainDirection,
bool  randomizeDirection,
Vector3  shakeAltDirection,
bool  randomizeDirectionOnPlay,
bool  addDirectionalNoise,
Vector3  directionalNoiseStrengthMin,
Vector3  directionalNoiseStrengthMax,
Vector3  randomnessSeed,
bool  randomizeSeedOnShake,
bool  useAttenuation,
AnimationCurve  attenuationCurve,
bool  useRange = false,
float  rangeDistance = 0f,
bool  useRangeFalloff = false,
AnimationCurve  rangeFalloff = null,
Vector2  remapRangeFalloff = default(Vector2),
Vector3  rangePosition = default(Vector3),
float  feedbacksIntensity = 1.0f,
MMChannelData  channelData = null,
bool  resetShakerValuesAfterShake = true,
bool  resetTargetValuesAfterShake = true,
bool  forwardDirection = true,
TimescaleModes  timescaleMode = TimescaleModes.Scaled,
bool  stop = false,
bool  restore = false 
)
virtual

◆ Reset()

virtual void MoreMountains.Feedbacks.MMScaleShaker.Reset ( )
protectedvirtual

When that shaker gets added, we initialize its shake duration

◆ ResetShakerValues()

override void MoreMountains.Feedbacks.MMScaleShaker.ResetShakerValues ( )
protectedvirtual

Resets the shaker's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ResetTargetValues()

override void MoreMountains.Feedbacks.MMScaleShaker.ResetTargetValues ( )
protectedvirtual

Resets the target's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Shake()

override void MoreMountains.Feedbacks.MMScaleShaker.Shake ( )
protectedvirtual

Override this method to implement shake over time

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ShakeComplete()

override void MoreMountains.Feedbacks.MMScaleShaker.ShakeComplete ( )
protectedvirtual

Describes what happens when the shake is complete

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ShakeStarts()

override void MoreMountains.Feedbacks.MMScaleShaker.ShakeStarts ( )
protectedvirtual

Describes what happens when a shake starts

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StartListening()

override void MoreMountains.Feedbacks.MMScaleShaker.StartListening ( )
virtual

Starts listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StopListening()

override void MoreMountains.Feedbacks.MMScaleShaker.StopListening ( )
virtual

Stops listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

◆ _attenuation

float MoreMountains.Feedbacks.MMScaleShaker._attenuation = 1f
protected

◆ _initialScale

Vector3 MoreMountains.Feedbacks.MMScaleShaker._initialScale
protected

◆ _newScale

Vector3 MoreMountains.Feedbacks.MMScaleShaker._newScale
protected

◆ _noiseVector

Vector3 MoreMountains.Feedbacks.MMScaleShaker._noiseVector
protected

◆ _noNoise

Vector3 MoreMountains.Feedbacks.MMScaleShaker._noNoise = Vector3.zero
protected

◆ _originalAddDirectionalNoise

bool MoreMountains.Feedbacks.MMScaleShaker._originalAddDirectionalNoise
protected

◆ _originalAttenuationCurve

AnimationCurve MoreMountains.Feedbacks.MMScaleShaker._originalAttenuationCurve
protected

◆ _originalDirectionalNoiseStrengthMax

Vector3 MoreMountains.Feedbacks.MMScaleShaker._originalDirectionalNoiseStrengthMax
protected

◆ _originalDirectionalNoiseStrengthMin

Vector3 MoreMountains.Feedbacks.MMScaleShaker._originalDirectionalNoiseStrengthMin
protected

◆ _originalDuration

float MoreMountains.Feedbacks.MMScaleShaker._originalDuration
protected

◆ _originalRandomizeDirection

bool MoreMountains.Feedbacks.MMScaleShaker._originalRandomizeDirection
protected

◆ _originalRandomizeDirectionOnPlay

bool MoreMountains.Feedbacks.MMScaleShaker._originalRandomizeDirectionOnPlay
protected

◆ _originalRandomizeSeedOnShake

bool MoreMountains.Feedbacks.MMScaleShaker._originalRandomizeSeedOnShake
protected

◆ _originalRandomnessSeed

Vector3 MoreMountains.Feedbacks.MMScaleShaker._originalRandomnessSeed
protected

◆ _originalShakeAltDirection

Vector3 MoreMountains.Feedbacks.MMScaleShaker._originalShakeAltDirection
protected

◆ _originalShakeMainDirection

Vector3 MoreMountains.Feedbacks.MMScaleShaker._originalShakeMainDirection
protected

◆ _originalShakeRange

float MoreMountains.Feedbacks.MMScaleShaker._originalShakeRange
protected

◆ _originalShakeSpeed

float MoreMountains.Feedbacks.MMScaleShaker._originalShakeSpeed
protected

◆ _originalUseAttenuation

bool MoreMountains.Feedbacks.MMScaleShaker._originalUseAttenuation
protected

◆ _oscillation

float MoreMountains.Feedbacks.MMScaleShaker._oscillation
protected

◆ _randomizedDirection

Vector3 MoreMountains.Feedbacks.MMScaleShaker._randomizedDirection
protected

◆ _randomNoiseStrength

Vector3 MoreMountains.Feedbacks.MMScaleShaker._randomNoiseStrength
protected

◆ _workDirection

Vector3 MoreMountains.Feedbacks.MMScaleShaker._workDirection
protected

◆ AddDirectionalNoise

bool MoreMountains.Feedbacks.MMScaleShaker.AddDirectionalNoise = true

whether or not to add noise to the main direction

◆ AttenuationCurve

AnimationCurve MoreMountains.Feedbacks.MMScaleShaker.AttenuationCurve = new AnimationCurve(new Keyframe(0, 0), new Keyframe(0.5f, 1), new Keyframe(1, 0))

the animation curve used to define attenuation, impacting the amplitude of the shake

◆ DirectionalNoiseStrengthMax

Vector3 MoreMountains.Feedbacks.MMScaleShaker.DirectionalNoiseStrengthMax = new Vector3(0.25f, 0.25f, 0.25f)

when adding directional noise, noise strength will be randomized between this value and DirectionalNoiseStrengthMin

◆ DirectionalNoiseStrengthMin

Vector3 MoreMountains.Feedbacks.MMScaleShaker.DirectionalNoiseStrengthMin = new Vector3(0.25f, 0.25f, 0.25f)

when adding directional noise, noise strength will be randomized between this value and DirectionalNoiseStrengthMax

◆ Mode

Modes MoreMountains.Feedbacks.MMScaleShaker.Mode = Modes.Transform

whether this shaker should target Transforms or RectTransforms

◆ RandomizeDirection

bool MoreMountains.Feedbacks.MMScaleShaker.RandomizeDirection = false

if this is true, instead of using ShakeMainDirection as the direction of the shake, a random vector3 will be generated, randomized between ShakeMainDirection and ShakeAltDirection

◆ RandomizeDirectionOnPlay

bool MoreMountains.Feedbacks.MMScaleShaker.RandomizeDirectionOnPlay = false

if this is true, a new direction will be randomized every time a shake happens

◆ RandomizeSeedOnShake

bool MoreMountains.Feedbacks.MMScaleShaker.RandomizeSeedOnShake = true

whether or not to generate a unique seed automatically on every shake

◆ Randomness

virtual float MoreMountains.Feedbacks.MMScaleShaker.Randomness => RandomnessSeed.x + RandomnessSeed.y + RandomnessSeed.z

◆ RandomnessSeed

Vector3 MoreMountains.Feedbacks.MMScaleShaker.RandomnessSeed

a unique seed you can use to get different outcomes when shaking more than one transform at once

◆ ShakeAltDirection

Vector3 MoreMountains.Feedbacks.MMScaleShaker.ShakeAltDirection = Vector3.up

when in RandomizeDirection mode, a vector against which to randomize the main direction

◆ ShakeMainDirection

Vector3 MoreMountains.Feedbacks.MMScaleShaker.ShakeMainDirection = Vector3.up

the direction along which to shake the transform's scale

◆ ShakeRange

float MoreMountains.Feedbacks.MMScaleShaker.ShakeRange = 0.5f

the maximum distance from its initial scale the transform will move to during the shake

◆ ShakeSpeed

float MoreMountains.Feedbacks.MMScaleShaker.ShakeSpeed = 20f

the speed at which the transform should shake

◆ StartShakingButton

bool MoreMountains.Feedbacks.MMScaleShaker.StartShakingButton

◆ TargetRectTransform

RectTransform MoreMountains.Feedbacks.MMScaleShaker.TargetRectTransform

the rect transform to shake the scale of. If left blank, this component will target the transform it's put on.

◆ TargetTransform

Transform MoreMountains.Feedbacks.MMScaleShaker.TargetTransform

the transform to shake the scale of. If left blank, this component will target the transform it's put on.

◆ UseAttenuation

bool MoreMountains.Feedbacks.MMScaleShaker.UseAttenuation = true

whether or not to use attenuation, which will impact the amplitude of the shake, along the defined curve


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