This shaker will let you move the position of a transform, either once or permanently, shaking its position 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.MMPositionShaker:

Public Types
enum	Modes { Modes.Transform, Modes.RectTransform }

Public Member Functions
virtual void	GrabInitialPosition ()

virtual void	OnMMPositionShakeEvent (float duration, float shakeSpeed, float shakeRange, Vector3 shakeMainDirection, bool randomizeDirection, Vector3 shakeAltDirection, bool randomizeDirectionOnPlay, bool randomizeDirectionX, bool randomizeDirectionY, bool randomizeDirectionZ, 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 position of. If left blank, this component will target the transform it's put on. More...

RectTransform	TargetRectTransform
	the rect transform to shake the position 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 position the transform will move to during the shake More...

float	OscillationOffset = 0f
	an offset to apply to the oscillation More...

Vector3	ShakeMainDirection = Vector3.up
	the direction along which to shake the transform's position 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	RandomizeDirectionX = true
	whether or not to randomize the x value of the main direction More...

bool	RandomizeDirectionY = true
	whether or not to randomize the y value of the main direction More...

bool	RandomizeDirectionZ = true
	whether or not to randomize the z value of the main direction 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	ApplyNewPosition (Vector3 newPosition)

virtual Vector3	ComputeNewPosition ()

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	_initialPosition

Vector3	_workDirection

Vector3	_noiseVector

Vector3	_newPosition

Vector3	_randomNoiseStrength

Vector3	_noNoise = Vector3.zero

Vector3	_randomizedDirection

float	_originalDuration

float	_originalShakeSpeed

float	_originalShakeRange

Vector3	_originalShakeMainDirection

bool	_originalRandomizeDirection

Vector3	_originalShakeAltDirection

bool	_originalRandomizeDirectionOnPlay

bool	_originalRandomizeDirectionX

bool	_originalRandomizeDirectionY

bool	_originalRandomizeDirectionZ

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 position of a transform, either once or permanently, shaking its position 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

enum MoreMountains.Feedbacks.MMPositionShaker.Modes

strong

Enumerator
Transform
RectTransform

Member Function Documentation

◆ ApplyNewPosition()

virtual void MoreMountains.Feedbacks.MMPositionShaker.ApplyNewPosition ( Vector3 newPosition )

protectedvirtual

◆ ComputeAttenuation()

virtual float MoreMountains.Feedbacks.MMPositionShaker.ComputeAttenuation ( float remappedTime )

protectedvirtual

◆ ComputeNewPosition()

virtual Vector3 MoreMountains.Feedbacks.MMPositionShaker.ComputeNewPosition ( )

protectedvirtual

◆ ComputeNoise()

virtual Vector3 MoreMountains.Feedbacks.MMPositionShaker.ComputeNoise ( float time )

protectedvirtual

◆ GrabInitialPosition()

virtual void MoreMountains.Feedbacks.MMPositionShaker.GrabInitialPosition ( )

virtual

◆ Initialization()

override void MoreMountains.Feedbacks.MMPositionShaker.Initialization ( )

protectedvirtual

On init we initialize our values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ OnMMPositionShakeEvent()

virtual void MoreMountains.Feedbacks.MMPositionShaker.OnMMPositionShakeEvent	(	float	duration,
		float	shakeSpeed,
		float	shakeRange,
		Vector3	shakeMainDirection,
		bool	randomizeDirection,
		Vector3	shakeAltDirection,
		bool	randomizeDirectionOnPlay,
		bool	randomizeDirectionX,
		bool	randomizeDirectionY,
		bool	randomizeDirectionZ,
		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.MMPositionShaker.Reset ( )

protectedvirtual

When that shaker gets added, we initialize its shake duration

◆ ResetShakerValues()

override void MoreMountains.Feedbacks.MMPositionShaker.ResetShakerValues ( )

protectedvirtual

Resets the shaker's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ResetTargetValues()

override void MoreMountains.Feedbacks.MMPositionShaker.ResetTargetValues ( )

protectedvirtual

Resets the target's values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ Shake()

override void MoreMountains.Feedbacks.MMPositionShaker.Shake ( )

protectedvirtual

Override this method to implement shake over time

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ShakeComplete()

override void MoreMountains.Feedbacks.MMPositionShaker.ShakeComplete ( )

protectedvirtual

Describes what happens when the shake is complete

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ ShakeStarts()

override void MoreMountains.Feedbacks.MMPositionShaker.ShakeStarts ( )

protectedvirtual

Describes what happens when a shake starts

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StartListening()

override void MoreMountains.Feedbacks.MMPositionShaker.StartListening ( )

virtual

Starts listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

◆ StopListening()

override void MoreMountains.Feedbacks.MMPositionShaker.StopListening ( )

virtual

Stops listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

◆ _attenuation

float MoreMountains.Feedbacks.MMPositionShaker._attenuation = 1f

protected

◆ _initialPosition

Vector3 MoreMountains.Feedbacks.MMPositionShaker._initialPosition

protected

◆ _newPosition

Vector3 MoreMountains.Feedbacks.MMPositionShaker._newPosition

protected

◆ _noiseVector

Vector3 MoreMountains.Feedbacks.MMPositionShaker._noiseVector

protected

◆ _noNoise

Vector3 MoreMountains.Feedbacks.MMPositionShaker._noNoise = Vector3.zero

protected

◆ _originalAddDirectionalNoise

bool MoreMountains.Feedbacks.MMPositionShaker._originalAddDirectionalNoise

protected

◆ _originalAttenuationCurve

AnimationCurve MoreMountains.Feedbacks.MMPositionShaker._originalAttenuationCurve

protected

◆ _originalDirectionalNoiseStrengthMax

Vector3 MoreMountains.Feedbacks.MMPositionShaker._originalDirectionalNoiseStrengthMax

protected

◆ _originalDirectionalNoiseStrengthMin

Vector3 MoreMountains.Feedbacks.MMPositionShaker._originalDirectionalNoiseStrengthMin

protected

◆ _originalDuration

float MoreMountains.Feedbacks.MMPositionShaker._originalDuration

protected

◆ _originalRandomizeDirection

bool MoreMountains.Feedbacks.MMPositionShaker._originalRandomizeDirection

protected

◆ _originalRandomizeDirectionOnPlay

bool MoreMountains.Feedbacks.MMPositionShaker._originalRandomizeDirectionOnPlay

protected

◆ _originalRandomizeDirectionX

bool MoreMountains.Feedbacks.MMPositionShaker._originalRandomizeDirectionX

protected

◆ _originalRandomizeDirectionY

bool MoreMountains.Feedbacks.MMPositionShaker._originalRandomizeDirectionY

protected

◆ _originalRandomizeDirectionZ

bool MoreMountains.Feedbacks.MMPositionShaker._originalRandomizeDirectionZ

protected

◆ _originalRandomizeSeedOnShake

bool MoreMountains.Feedbacks.MMPositionShaker._originalRandomizeSeedOnShake

protected

◆ _originalRandomnessSeed

Vector3 MoreMountains.Feedbacks.MMPositionShaker._originalRandomnessSeed

protected

◆ _originalShakeAltDirection

Vector3 MoreMountains.Feedbacks.MMPositionShaker._originalShakeAltDirection

protected

◆ _originalShakeMainDirection

Vector3 MoreMountains.Feedbacks.MMPositionShaker._originalShakeMainDirection

protected

◆ _originalShakeRange

float MoreMountains.Feedbacks.MMPositionShaker._originalShakeRange

protected

◆ _originalShakeSpeed

float MoreMountains.Feedbacks.MMPositionShaker._originalShakeSpeed

protected

◆ _originalUseAttenuation

bool MoreMountains.Feedbacks.MMPositionShaker._originalUseAttenuation

protected

◆ _oscillation

float MoreMountains.Feedbacks.MMPositionShaker._oscillation

protected

◆ _randomizedDirection

Vector3 MoreMountains.Feedbacks.MMPositionShaker._randomizedDirection

protected

◆ _randomNoiseStrength

Vector3 MoreMountains.Feedbacks.MMPositionShaker._randomNoiseStrength

protected

◆ _workDirection

Vector3 MoreMountains.Feedbacks.MMPositionShaker._workDirection

protected

◆ AddDirectionalNoise

bool MoreMountains.Feedbacks.MMPositionShaker.AddDirectionalNoise = true

whether or not to add noise to the main direction

◆ AttenuationCurve

AnimationCurve MoreMountains.Feedbacks.MMPositionShaker.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.MMPositionShaker.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.MMPositionShaker.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.MMPositionShaker.Mode = Modes.Transform

whether this shaker should target Transforms or RectTransforms

◆ OscillationOffset

float MoreMountains.Feedbacks.MMPositionShaker.OscillationOffset = 0f

an offset to apply to the oscillation

◆ RandomizeDirection

bool MoreMountains.Feedbacks.MMPositionShaker.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.MMPositionShaker.RandomizeDirectionOnPlay = false

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

◆ RandomizeDirectionX

bool MoreMountains.Feedbacks.MMPositionShaker.RandomizeDirectionX = true

whether or not to randomize the x value of the main direction

◆ RandomizeDirectionY

bool MoreMountains.Feedbacks.MMPositionShaker.RandomizeDirectionY = true

whether or not to randomize the y value of the main direction

◆ RandomizeDirectionZ

bool MoreMountains.Feedbacks.MMPositionShaker.RandomizeDirectionZ = true

whether or not to randomize the z value of the main direction

◆ RandomizeSeedOnShake

bool MoreMountains.Feedbacks.MMPositionShaker.RandomizeSeedOnShake = true

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

◆ Randomness

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

◆ RandomnessSeed

Vector3 MoreMountains.Feedbacks.MMPositionShaker.RandomnessSeed

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

◆ ShakeAltDirection

Vector3 MoreMountains.Feedbacks.MMPositionShaker.ShakeAltDirection = Vector3.up

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

◆ ShakeMainDirection

Vector3 MoreMountains.Feedbacks.MMPositionShaker.ShakeMainDirection = Vector3.up

the direction along which to shake the transform's position

◆ ShakeRange

float MoreMountains.Feedbacks.MMPositionShaker.ShakeRange = 0.5f

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

◆ ShakeSpeed

float MoreMountains.Feedbacks.MMPositionShaker.ShakeSpeed = 20f

the speed at which the transform should shake

◆ StartShakingButton

bool MoreMountains.Feedbacks.MMPositionShaker.StartShakingButton

◆ TargetRectTransform

RectTransform MoreMountains.Feedbacks.MMPositionShaker.TargetRectTransform

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

◆ TargetTransform

Transform MoreMountains.Feedbacks.MMPositionShaker.TargetTransform

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

◆ UseAttenuation

bool MoreMountains.Feedbacks.MMPositionShaker.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:

F:/Github/Store/TopDownEngine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Shakers/MMPositionShaker.cs

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Modes

Member Function Documentation

◆ ApplyNewPosition()

◆ ComputeAttenuation()

◆ ComputeNewPosition()

◆ ComputeNoise()

◆ GrabInitialPosition()

◆ Initialization()

◆ OnMMPositionShakeEvent()

◆ Reset()

◆ ResetShakerValues()

◆ ResetTargetValues()

◆ Shake()

◆ ShakeComplete()

◆ ShakeStarts()

◆ StartListening()

◆ StopListening()

Member Data Documentation

◆ _attenuation

◆ _initialPosition

◆ _newPosition

◆ _noiseVector

◆ _noNoise

◆ _originalAddDirectionalNoise

◆ _originalAttenuationCurve

◆ _originalDirectionalNoiseStrengthMax

◆ _originalDirectionalNoiseStrengthMin

◆ _originalDuration

◆ _originalRandomizeDirection

◆ _originalRandomizeDirectionOnPlay

◆ _originalRandomizeDirectionX

◆ _originalRandomizeDirectionY

◆ _originalRandomizeDirectionZ

◆ _originalRandomizeSeedOnShake

◆ _originalRandomnessSeed

◆ _originalShakeAltDirection

◆ _originalShakeMainDirection

◆ _originalShakeRange

◆ _originalShakeSpeed

◆ _originalUseAttenuation

◆ _oscillation

◆ _randomizedDirection

◆ _randomNoiseStrength

◆ _workDirection

◆ AddDirectionalNoise

◆ AttenuationCurve

◆ DirectionalNoiseStrengthMax

◆ DirectionalNoiseStrengthMin

◆ Mode

◆ OscillationOffset

◆ RandomizeDirection

◆ RandomizeDirectionOnPlay

◆ RandomizeDirectionX

◆ RandomizeDirectionY

◆ RandomizeDirectionZ

◆ RandomizeSeedOnShake

◆ Randomness

◆ RandomnessSeed

◆ ShakeAltDirection

◆ ShakeMainDirection

◆ ShakeRange

◆ ShakeSpeed

◆ StartShakingButton

◆ TargetRectTransform

◆ TargetTransform

◆ UseAttenuation