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

Inheritance diagram for MoreMountains.Feedbacks.MMSpriteRendererShaker:

Public Member Functions
override void	StartListening ()
	Starts listening for events More...

override void	StopListening ()
	Stops listening for events More...

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 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
SpriteRenderer	BoundSpriteRenderer
	the SpriteRenderer to affect when playing the feedback More...

bool	StartsOff = true
	whether or not that SpriteRenderer should be turned off on start More...

bool	ModifyColor = true
	whether or not this shaker should modify color More...

Gradient	ColorOverTime
	the colors to apply to the SpriteRenderer over time More...

bool	FlipX = false
	whether or not to flip the sprite on X More...

bool	FlipY = false
	whether or not to flip the sprite on Y More...

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	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 Color	ShakeGradient (Gradient gradient)

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 (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
Color	_initialColor

bool	_originalModifyColor

float	_originalShakeDuration

Gradient	_originalColorOverTime

bool	_originalFlipX

bool	_originalFlipY

Protected Attributes inherited from MoreMountains.Feedbacks.MMShaker
float	_shakeStartedTimestamp = -Single.MaxValue

float	_remappedTimeSinceStart

bool	_resetShakerValuesAfterShake

bool	_resetTargetValuesAfterShake

float	_journey

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:

F:/Github/Store/Feel/Assets/Feel/MMFeedbacks/MMFeedbacks/Shakers/MMSpriteRendererShaker.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ GrabInitialValues()

◆ Initialization()

◆ OnMMSpriteRendererShakeEvent()

◆ Reset()

◆ ResetShakerValues()

◆ ResetTargetValues()

◆ Shake()

◆ StartListening()

◆ StopListening()

Member Data Documentation

◆ _initialColor

◆ _originalColorOverTime

◆ _originalFlipX

◆ _originalFlipY

◆ _originalModifyColor

◆ _originalShakeDuration

◆ BoundSpriteRenderer

◆ ColorOverTime

◆ FlipX

◆ FlipY

◆ ModifyColor

◆ StartsOff