Blam::Events Namespace Reference

Namespace for handling things related to Events. More...

Classes
class	CharacterInputEvent
	Class representing a character being pressed. More...
class	Event
	Class representing a generic event. More...
class	EventListener
	Class representing an Event Listener. More...
class	KeyPressEvent
	Class representing a virtual key press. More...
class	TickEvent
	Class representing an engine tick event. More...

Functions
BLAM void	ResortListeners (EventListener *requesting_listener)
	Re-sorts the list of registered listeners after a priority modification. More...
BLAM void	UnregisterListener (EventListener *listener)
	Unregisters a an event listener. More...
BLAM void	FireEvent (Event *event)
	Fires an event. More...
BLAM void	RegisterListener (EventListener *listener)
	Registers a an event listener. More...

Detailed Description

Namespace for handling things related to Events.

Function Documentation

FireEvent()

void Blam::Events::FireEvent

(

Event *

event

)

Fires an event.

Calling this will notify all registered listeners configured to listen for the event's type about the new event.

Parameters

event

- Pointer to the event to fire.

RegisterListener()

void Blam::Events::RegisterListener

(

EventListener *

listener

)

Registers a an event listener.

All EventListeners must be registered in order to receive event notifications.

Parameters

listener

- Pointer to the listener to register.

ResortListeners()

BLAM void Blam::Events::ResortListeners

(

EventListener *

requesting_listener

)

Re-sorts the list of registered listeners after a priority modification.

This is automatically called after a listner's priority is set.

Parameters

requesting_listener

- The listener that had its priority modified in order to require a resort.

UnregisterListener()

BLAM void Blam::Events::UnregisterListener

(

EventListener *

listener

)

Unregisters a an event listener.

Once a listener is unregistered, it will no longer recieve notifications.

Parameters

listener

- Pointer to the listener to unregister.