TopDown Engine  v4.1
Public Types | Public Member Functions | Static Public Member Functions | List of all members
MoreMountains.Feedbacks.MMFeedbacksEvent Struct Reference

Events triggered by a MMFeedbacks when playing a series of feedbacks More...

Public Types

enum  EventTypes {
  EventTypes.Play, EventTypes.Pause, EventTypes.Resume, EventTypes.Revert,
  EventTypes.Complete, EventTypes.SkipToTheEnd, EventTypes.RestoreInitialValues, EventTypes.Loop,
  EventTypes.Enable, EventTypes.Disable, EventTypes.InitializationComplete
}
 

Public Member Functions

delegate void Delegate (MMFeedbacks source, EventTypes type)
 

Static Public Member Functions

static void Register (Delegate callback)
 
static void Unregister (Delegate callback)
 
static void Trigger (MMFeedbacks source, EventTypes type)
 

Detailed Description

Events triggered by a MMFeedbacks when playing a series of feedbacks

  • play : when a MMFeedbacks starts playing
  • pause : when a holding pause is met
  • resume : after a holding pause resumes
  • revert : when a MMFeedbacks reverts its play direction
  • complete : when a MMFeedbacks has played its last feedback

to listen to these events :

public virtual void OnMMFeedbacksEvent(MMFeedbacks source, EventTypes type) { // do something }

protected virtual void OnEnable() { MMFeedbacksEvent.Register(OnMMFeedbacksEvent); }

protected virtual void OnDisable() { MMFeedbacksEvent.Unregister(OnMMFeedbacksEvent); }

Member Enumeration Documentation

◆ EventTypes

enum MoreMountains.Feedbacks.MMFeedbacksEvent.EventTypes
strong
Enumerator
Play 
Pause 
Resume 
Revert 
Complete 
SkipToTheEnd 
RestoreInitialValues 
Loop 
Enable 
Disable 
InitializationComplete 

Member Function Documentation

◆ Delegate()

delegate void MoreMountains.Feedbacks.MMFeedbacksEvent.Delegate ( MMFeedbacks  source,
EventTypes  type 
)

◆ Register()

static void MoreMountains.Feedbacks.MMFeedbacksEvent.Register ( Delegate  callback)
static

◆ Trigger()

static void MoreMountains.Feedbacks.MMFeedbacksEvent.Trigger ( MMFeedbacks  source,
EventTypes  type 
)
static

◆ Unregister()

static void MoreMountains.Feedbacks.MMFeedbacksEvent.Unregister ( Delegate  callback)
static
The documentation for this struct was generated from the following file: