HKI Core
Public Member Functions | Private Attributes | List of all members
HKI.Core.GameEvents.GameEvent Class Reference

This is a ScriptableObject game event. It can be listen too and raised via code or within Unity Editor. More...

Inheritance diagram for HKI.Core.GameEvents.GameEvent:

Public Member Functions

void Raise ()
 Calling this function will inform all registered listener that this event is raised. More...
 
void RegisterListener (GameEventListener listener)
 Register a listerner to this event. The listener will be informed that this event is raised. More...
 
void UnregisterListener (GameEventListener listener)
 Remove a listerner from this event. From now on the listener won't be informed that this event is raised. More...
 

Private Attributes

List< GameEventListenerlisteners = new List<GameEventListener>()
 List of listener that are registered to this event. More...
 

Detailed Description

This is a ScriptableObject game event. It can be listen too and raised via code or within Unity Editor.

Create a GameEvent in Unity: HKI/Game Event

Definition at line 12 of file GameEvent.cs.

Member Function Documentation

◆ Raise()

void HKI.Core.GameEvents.GameEvent.Raise ( )
inline

Calling this function will inform all registered listener that this event is raised.

Definition at line 24 of file GameEvent.cs.

◆ RegisterListener()

void HKI.Core.GameEvents.GameEvent.RegisterListener ( GameEventListener  listener)
inline

Register a listerner to this event. The listener will be informed that this event is raised.

Parameters
listener

Definition at line 37 of file GameEvent.cs.

◆ UnregisterListener()

void HKI.Core.GameEvents.GameEvent.UnregisterListener ( GameEventListener  listener)
inline

Remove a listerner from this event. From now on the listener won't be informed that this event is raised.

Parameters
listener

Definition at line 47 of file GameEvent.cs.

Member Data Documentation

◆ listeners

List<GameEventListener> HKI.Core.GameEvents.GameEvent.listeners = new List<GameEventListener>()
private

List of listener that are registered to this event.

Definition at line 18 of file GameEvent.cs.


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