TopDown Engine  v3.6
MoreMountains.Tools.MMGameEventListener Class Reference

Add this component to an object, and it'll let you easily trigger UnityEvents when the event of the specified name is triggered More...

Inheritance diagram for MoreMountains.Tools.MMGameEventListener:
MoreMountains.Tools.MMEventListener< MMGameEvent >

Public Member Functions

void OnMMEvent (MMGameEvent gameEvent)
 When a MMGameEvent happens, we trigger our UnityEvent if necessary More...
 
- Public Member Functions inherited from MoreMountains.Tools.MMEventListener< MMGameEvent >
void OnMMEvent (T eventType)
 

Public Attributes

string EventName = "Load"
 the name of the event you want to listen for More...
 
UnityEvent OnMMGameEvent
 a UnityEvent hook you can use to call methods when the specified event gets triggered More...
 

Protected Member Functions

virtual void OnEnable ()
 On enable, we start listening for MMGameEvents. You may want to extend that to listen to other types of events. More...
 
virtual void OnDisable ()
 On disable, we stop listening for MMGameEvents. You may want to extend that to stop listening to other types of events. More...
 

Detailed Description

Add this component to an object, and it'll let you easily trigger UnityEvents when the event of the specified name is triggered

Member Function Documentation

◆ OnDisable()

virtual void MoreMountains.Tools.MMGameEventListener.OnDisable ( )
protectedvirtual

On disable, we stop listening for MMGameEvents. You may want to extend that to stop listening to other types of events.

◆ OnEnable()

virtual void MoreMountains.Tools.MMGameEventListener.OnEnable ( )
protectedvirtual

On enable, we start listening for MMGameEvents. You may want to extend that to listen to other types of events.

◆ OnMMEvent()

void MoreMountains.Tools.MMGameEventListener.OnMMEvent ( MMGameEvent  gameEvent)

When a MMGameEvent happens, we trigger our UnityEvent if necessary

Parameters
gameEvent

Member Data Documentation

◆ EventName

string MoreMountains.Tools.MMGameEventListener.EventName = "Load"

the name of the event you want to listen for

◆ OnMMGameEvent

UnityEvent MoreMountains.Tools.MMGameEventListener.OnMMGameEvent

a UnityEvent hook you can use to call methods when the specified event gets triggered


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