MoreMountains.Feedbacks.MMFeedbacksShaker Class Reference

Inheritance diagram for MoreMountains.Feedbacks.MMFeedbacksShaker:

Public Member Functions
virtual void	OnMMFeedbacksShakeEvent (int channel=0, bool useRange=false, float eventRange=0f, Vector3 eventOriginPosition=default(Vector3))
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 void	StartShaking ()
	Starts shaking the values More...
virtual void	Play ()
	Starts this shaker More...

Protected Member Functions
override void	Initialization ()
	On init we initialize our values More...
override void	ShakeStarts ()
	Describes what happens when a shake starts More...
virtual void	Reset ()
	When that shaker gets added, we initialize its shake duration 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 void	Shake ()
	Override this method to implement shake over time 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 void	ResetTargetValues ()
	Resets the values on the target More...
virtual void	ResetShakerValues ()
	Resets the values on the shaker More...
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 (int channel, bool useRange=false, float range=0f, Vector3 eventOriginPosition=default(Vector3))
	Returns true if this shaker should listen to events, false otherwise More...

Protected Attributes
MMFeedbacks	_mmFeedbacks
Protected Attributes inherited from MoreMountains.Feedbacks.MMShaker
float	_shakeStartedTimestamp
float	_remappedTimeSinceStart
bool	_resetShakerValuesAfterShake
bool	_resetTargetValuesAfterShake

Additional Inherited Members
Public Attributes inherited from MoreMountains.Feedbacks.MMShaker
int	Channel = 0
	the channel to listen to More...
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	Shaking = false
	whether or not this shaker is shaking right now More...
bool	ListeningToEvents => _listeningToEvents

Member Function Documentation

Initialization()

override void MoreMountains.Feedbacks.MMFeedbacksShaker.Initialization ( )

protectedvirtual

On init we initialize our values

Reimplemented from MoreMountains.Feedbacks.MMShaker.

OnMMFeedbacksShakeEvent()

virtual void MoreMountains.Feedbacks.MMFeedbacksShaker.OnMMFeedbacksShakeEvent ( int  channel = 0, bool  useRange = false, float  eventRange = 0f, Vector3  eventOriginPosition = default(Vector3)  )

virtual

Reset()

virtual void MoreMountains.Feedbacks.MMFeedbacksShaker.Reset ( )

protectedvirtual

When that shaker gets added, we initialize its shake duration

ShakeStarts()

override void MoreMountains.Feedbacks.MMFeedbacksShaker.ShakeStarts ( )

protectedvirtual

Describes what happens when a shake starts

Reimplemented from MoreMountains.Feedbacks.MMShaker.

StartListening()

override void MoreMountains.Feedbacks.MMFeedbacksShaker.StartListening ( )

virtual

Starts listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

StopListening()

override void MoreMountains.Feedbacks.MMFeedbacksShaker.StopListening ( )

virtual

Stops listening for events

Reimplemented from MoreMountains.Feedbacks.MMShaker.

Member Data Documentation

_mmFeedbacks

MMFeedbacks MoreMountains.Feedbacks.MMFeedbacksShaker._mmFeedbacks

protected

---

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

• F:/Github/Store/MMFeedbacksStore/Assets/MMFeedbacks/MMFeedbacks/MMFeedbacks/Shakers/MMFeedbacksShaker.cs