TopDown Engine  v4.1
MoreMountains.Feedbacks.MMFeedbacksEvents Class Reference

A subclass of MMFeedbacks, contains UnityEvents that can be played, More...

Public Member Functions

virtual void Initialization ()
 On init we store for each event whether or not we have one to invoke More...
 
virtual void TriggerOnPlay (MMFeedbacks source)
 Fires Play events if needed More...
 
virtual void TriggerOnPause (MMFeedbacks source)
 Fires pause events if needed More...
 
virtual void TriggerOnResume (MMFeedbacks source)
 Fires resume events if needed More...
 
virtual void TriggerOnRevert (MMFeedbacks source)
 Fires revert events if needed More...
 
virtual void TriggerOnComplete (MMFeedbacks source)
 Fires complete events if needed More...
 
virtual void TriggerOnSkipToTheEnd (MMFeedbacks source)
 Fires skip events if needed More...
 
virtual void TriggerOnInitializationComplete (MMFeedbacks source)
 
virtual void TriggerOnRestoreInitialValues (MMFeedbacks source)
 Fires revert events if needed More...
 
virtual void TriggerOnEnable (MMF_Player source)
 Fires enable events if needed More...
 
virtual void TriggerOnDisable (MMF_Player source)
 Fires disable events if needed More...
 

Public Attributes

bool TriggerMMFeedbacksEvents = false
 whether or not this MMFeedbacks should fire MMFeedbacksEvents More...
 
bool TriggerUnityEvents = true
 whether or not this MMFeedbacks should fire Unity Events More...
 
UnityEvent OnPlay
 This event will fire every time this MMFeedbacks gets played. More...
 
UnityEvent OnPause
 This event will fire every time this MMFeedbacks starts a holding pause. More...
 
UnityEvent OnResume
 This event will fire every time this MMFeedbacks resumes after a holding pause. More...
 
UnityEvent OnRevert
 This event will fire every time this MMFeedbacks reverts its play direction. More...
 
UnityEvent OnComplete
 This event will fire every time this MMFeedbacks plays its last MMFeedback. More...
 
UnityEvent OnRestoreInitialValues
 This event will fire every time this MMFeedbacks gets restored to its initial values. More...
 
UnityEvent OnSkipToTheEnd
 This event will fire every time this MMFeedbacks gets skipped to the end. More...
 
UnityEvent OnInitializationComplete
 This event will fire after the MMF Player is done initializing. More...
 
UnityEvent OnEnable
 This event will fire every time this MMFeedbacks' game object gets enabled. More...
 
UnityEvent OnDisable
 This event will fire every time this MMFeedbacks' game object gets disabled. More...
 

Properties

virtual bool OnPlayIsNull [get, protected set]
 
virtual bool OnPauseIsNull [get, protected set]
 
virtual bool OnResumeIsNull [get, protected set]
 
virtual bool OnRevertIsNull [get, protected set]
 
virtual bool OnCompleteIsNull [get, protected set]
 
virtual bool OnRestoreInitialValuesIsNull [get, protected set]
 
virtual bool OnSkipToTheEndIsNull [get, protected set]
 
virtual bool OnInitializationCompleteIsNull [get, protected set]
 
virtual bool OnEnableIsNull [get, protected set]
 
virtual bool OnDisableIsNull [get, protected set]
 

Detailed Description

A subclass of MMFeedbacks, contains UnityEvents that can be played,

Member Function Documentation

◆ Initialization()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.Initialization ( )
virtual

On init we store for each event whether or not we have one to invoke

◆ TriggerOnComplete()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnComplete ( MMFeedbacks  source)
virtual

Fires complete events if needed

Parameters
source

◆ TriggerOnDisable()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnDisable ( MMF_Player  source)
virtual

Fires disable events if needed

Parameters
source

◆ TriggerOnEnable()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnEnable ( MMF_Player  source)
virtual

Fires enable events if needed

Parameters
source

◆ TriggerOnInitializationComplete()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnInitializationComplete ( MMFeedbacks  source)
virtual

◆ TriggerOnPause()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnPause ( MMFeedbacks  source)
virtual

Fires pause events if needed

Parameters
source

◆ TriggerOnPlay()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnPlay ( MMFeedbacks  source)
virtual

Fires Play events if needed

Parameters
source

◆ TriggerOnRestoreInitialValues()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnRestoreInitialValues ( MMFeedbacks  source)
virtual

Fires revert events if needed

Parameters
source

◆ TriggerOnResume()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnResume ( MMFeedbacks  source)
virtual

Fires resume events if needed

Parameters
source

◆ TriggerOnRevert()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnRevert ( MMFeedbacks  source)
virtual

Fires revert events if needed

Parameters
source

◆ TriggerOnSkipToTheEnd()

virtual void MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerOnSkipToTheEnd ( MMFeedbacks  source)
virtual

Fires skip events if needed

Parameters
source

Member Data Documentation

◆ OnComplete

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnComplete

This event will fire every time this MMFeedbacks plays its last MMFeedback.

◆ OnDisable

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnDisable

This event will fire every time this MMFeedbacks' game object gets disabled.

◆ OnEnable

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnEnable

This event will fire every time this MMFeedbacks' game object gets enabled.

◆ OnInitializationComplete

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnInitializationComplete

This event will fire after the MMF Player is done initializing.

◆ OnPause

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnPause

This event will fire every time this MMFeedbacks starts a holding pause.

◆ OnPlay

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnPlay

This event will fire every time this MMFeedbacks gets played.

◆ OnRestoreInitialValues

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnRestoreInitialValues

This event will fire every time this MMFeedbacks gets restored to its initial values.

◆ OnResume

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnResume

This event will fire every time this MMFeedbacks resumes after a holding pause.

◆ OnRevert

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnRevert

This event will fire every time this MMFeedbacks reverts its play direction.

◆ OnSkipToTheEnd

UnityEvent MoreMountains.Feedbacks.MMFeedbacksEvents.OnSkipToTheEnd

This event will fire every time this MMFeedbacks gets skipped to the end.

◆ TriggerMMFeedbacksEvents

bool MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerMMFeedbacksEvents = false

whether or not this MMFeedbacks should fire MMFeedbacksEvents

◆ TriggerUnityEvents

bool MoreMountains.Feedbacks.MMFeedbacksEvents.TriggerUnityEvents = true

whether or not this MMFeedbacks should fire Unity Events

Property Documentation

◆ OnCompleteIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnCompleteIsNull
getprotected set

◆ OnDisableIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnDisableIsNull
getprotected set

◆ OnEnableIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnEnableIsNull
getprotected set

◆ OnInitializationCompleteIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnInitializationCompleteIsNull
getprotected set

◆ OnPauseIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnPauseIsNull
getprotected set

◆ OnPlayIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnPlayIsNull
getprotected set

◆ OnRestoreInitialValuesIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnRestoreInitialValuesIsNull
getprotected set

◆ OnResumeIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnResumeIsNull
getprotected set

◆ OnRevertIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnRevertIsNull
getprotected set

◆ OnSkipToTheEndIsNull

virtual bool MoreMountains.Feedbacks.MMFeedbacksEvents.OnSkipToTheEndIsNull
getprotected set

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