TopDown Engine v4.5
Loading...
Searching...
No Matches
MoreMountains.Feedbacks.MMSpriteRendererShaker Class Reference

Add this to a SpriteRenderer to have it receive MMSpriteRendererShakeEvents from feedbacks or to shake it locally. More...

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

Public Member Functions

override void StartListening ()
 Starts listening for events.
override void StopListening ()
 Stops listening for events.
virtual void OnMMSpriteRendererShakeEvent (float shakeDuration, bool modifyColor, Gradient colorOverTime, bool flipX, bool flipY, float feedbacksIntensity=1.0f, MMChannelData channelData=null, bool resetShakerValuesAfterShake=true, bool resetTargetValuesAfterShake=true, bool useRange=false, float eventRange=0f, Vector3 eventOriginPosition=default(Vector3))
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.
virtual void StartShaking ()
 Starts shaking the values.
virtual void Play ()
 Starts this shaker.
virtual void Stop ()
 Stops this shaker.
virtual float ComputeRangeIntensity (bool useRange, float rangeDistance, bool useRangeFalloff, AnimationCurve rangeFalloff, Vector2 remapRangeFalloff, Vector3 rangePosition)

Public Attributes

SpriteRenderer BoundSpriteRenderer
 the SpriteRenderer to affect when playing the feedback
bool StartsOff = true
 whether or not that SpriteRenderer should be turned off on start
bool ModifyColor = true
 whether or not this shaker should modify color
Gradient ColorOverTime
 the colors to apply to the SpriteRenderer over time
bool FlipX = false
 whether or not to flip the sprite on X
bool FlipY = false
 whether or not to flip the sprite on Y
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
MMChannel MMChannelDefinition = null
float ShakeDuration = 0.2f
 the duration of the shake, in seconds
bool PlayOnAwake = false
 if this is true this shaker will play on awake
bool PermanentShake = false
 if this is true, the shaker will shake permanently as long as its game object is active
bool Interruptible = true
 if this is true, a new shake can happen while shaking
bool AlwaysResetTargetValuesAfterShake = false
 if this is true, this shaker will always reset target values, regardless of how it was called
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
float CooldownBetweenShakes = 0f
 a cooldown, in seconds, after a shake, during which no other shake can start
bool Shaking = false
 whether or not this shaker is shaking right now
bool ForwardDirection = true
TimescaleModes TimescaleMode = TimescaleModes.Scaled

Protected Member Functions

override void Initialization ()
 On init we initialize our values.
virtual void Reset ()
 When that shaker gets added, we initialize its shake duration.
override void Shake ()
 Shakes values over time.
override void GrabInitialValues ()
 Collects initial values on the target.
override void ResetTargetValues ()
 Resets the target's values.
override void ResetShakerValues ()
 Resets the shaker's values.
Protected Member Functions inherited from MoreMountains.Feedbacks.MMShaker
virtual void Awake ()
 On Awake we grab our volume and profile.
virtual void SetShakeStartedTimestamp ()
 Logs the start timestamp for this shaker.
virtual void ShakeStarts ()
 Describes what happens when a shake starts.
virtual void Update ()
 On Update, we shake our values if needed, or reset if our shake has ended.
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.
virtual Color ShakeGradient (Gradient gradient)
virtual void ShakeComplete ()
 Describes what happens when the shake is complete.
virtual void OnEnable ()
 On enable we start shaking if needed.
virtual void OnDestroy ()
 On destroy we stop listening for events.
virtual void OnDisable ()
 On disable we complete our shake if it was in progress.
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.

Protected Attributes

Color _initialColor
bool _originalModifyColor
float _originalShakeDuration
Gradient _originalColorOverTime
bool _originalFlipX
bool _originalFlipY
Protected Attributes inherited from MoreMountains.Feedbacks.MMShaker
float _shakeStartedTimestamp = -Single.MaxValue
float _shakeStartedTimestampUnscaled = -Single.MaxValue
float _remappedTimeSinceStart
bool _resetShakerValuesAfterShake
bool _resetTargetValuesAfterShake
float _journey

Additional Inherited Members

Properties inherited from MoreMountains.Feedbacks.MMShaker
virtual MMChannelData ChannelData [get]
virtual bool ListeningToEvents [get]
virtual bool InCooldown [get]
 Returns true if this shaker is currently in cooldown, false otherwise.

Detailed Description

Add this to a SpriteRenderer to have it receive MMSpriteRendererShakeEvents from feedbacks or to shake it locally.

Member Function Documentation

◆ GrabInitialValues()

override void MoreMountains.Feedbacks.MMSpriteRendererShaker.GrabInitialValues ( )
protectedvirtual

Collects initial values on the target.

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Initialization()

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

On init we initialize our values.

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ OnMMSpriteRendererShakeEvent()

virtual void MoreMountains.Feedbacks.MMSpriteRendererShaker.OnMMSpriteRendererShakeEvent ( float shakeDuration,
bool modifyColor,
Gradient colorOverTime,
bool flipX,
bool flipY,
float feedbacksIntensity = 1::0f,
MMChannelData channelData = null,
bool resetShakerValuesAfterShake = true,
bool resetTargetValuesAfterShake = true,
bool useRange = false,
float eventRange = 0f,
Vector3 eventOriginPosition = default(Vector3) )
virtual

◆ Reset()

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

When that shaker gets added, we initialize its shake duration.

◆ ResetShakerValues()

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

Resets the shaker's values.

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ResetTargetValues()

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

Resets the target's values.

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Shake()

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

Shakes values over time.

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StartListening()

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

Starts listening for events.

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StopListening()

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

Stops listening for events.

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

◆ _initialColor

Color MoreMountains.Feedbacks.MMSpriteRendererShaker._initialColor
protected

◆ _originalColorOverTime

Gradient MoreMountains.Feedbacks.MMSpriteRendererShaker._originalColorOverTime
protected

◆ _originalFlipX

bool MoreMountains.Feedbacks.MMSpriteRendererShaker._originalFlipX
protected

◆ _originalFlipY

bool MoreMountains.Feedbacks.MMSpriteRendererShaker._originalFlipY
protected

◆ _originalModifyColor

bool MoreMountains.Feedbacks.MMSpriteRendererShaker._originalModifyColor
protected

◆ _originalShakeDuration

float MoreMountains.Feedbacks.MMSpriteRendererShaker._originalShakeDuration
protected

◆ BoundSpriteRenderer

SpriteRenderer MoreMountains.Feedbacks.MMSpriteRendererShaker.BoundSpriteRenderer

the SpriteRenderer to affect when playing the feedback

◆ ColorOverTime

Gradient MoreMountains.Feedbacks.MMSpriteRendererShaker.ColorOverTime

the colors to apply to the SpriteRenderer over time

◆ FlipX

bool MoreMountains.Feedbacks.MMSpriteRendererShaker.FlipX = false

whether or not to flip the sprite on X

◆ FlipY

bool MoreMountains.Feedbacks.MMSpriteRendererShaker.FlipY = false

whether or not to flip the sprite on Y

◆ ModifyColor

bool MoreMountains.Feedbacks.MMSpriteRendererShaker.ModifyColor = true

whether or not this shaker should modify color

◆ StartsOff

bool MoreMountains.Feedbacks.MMSpriteRendererShaker.StartsOff = true

whether or not that SpriteRenderer should be turned off on start


The documentation for this class was generated from the following file:
  • H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Shakers/MMSpriteRendererShaker.cs