CeresEngine::EntityEventListener< Event > Class Template Reference

A event listener that listens for events. More...

#include <CeresEngine/Entity/EventListener.hpp>

Public Member Functions
void	subscribe (EntityEventManager &eventManager)
	Subscribe the listener to the event in the given eventManager.
void	unsubscribe ()
	Unsubscribes the listener.

Protected Member Functions
virtual	~EntityEventListener ()=default

Private Member Functions
virtual void	when (Entity &entity, const Event &event)=0
	A callback called whenever the event Event gets emitted by a entity.

Private Attributes
EventConnection	mConnection
	A vector of all active signal connections.

Detailed Description

template<CEntityEvent Event>
class CeresEngine::EntityEventListener< Event >

A event listener that listens for events.

Template Parameters

Event

the event to listen for

Constructor & Destructor Documentation

~EntityEventListener()

template<CEntityEvent Event>

virtual CeresEngine::EntityEventListener< Event >::~EntityEventListener ( )

protectedvirtualdefault

Member Function Documentation

subscribe()

template<CEntityEvent Event>

void CeresEngine::EntityEventListener< Event >::subscribe

(

EntityEventManager &

eventManager

)

Subscribe the listener to the event in the given eventManager.

Parameters

eventManager

The event manager to subscribe on

unsubscribe()

template<CEntityEvent Event>

void CeresEngine::EntityEventListener< Event >::unsubscribe

(

)

Unsubscribes the listener.

when()

template<CEntityEvent Event>

virtual void CeresEngine::EntityEventListener< Event >::when ( Entity &  entity, const Event &  event  )

privatepure virtual

A callback called whenever the event Event gets emitted by a entity.

Parameters

entity	The entity that emitted the event
event	The emitted event object

Member Data Documentation

mConnection

template<CEntityEvent Event>

EventConnection CeresEngine::EntityEventListener< Event >::mConnection

private

A vector of all active signal connections.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Entity/Event.hpp
• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Entity/EventListener.hpp