Blam::Events Namespace Reference

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

Functions
BLAM void	FireEvent (BlamEvent *event)
	Fires an event. More...
BLAM void	RegisterListener (BlamEventListener *listener, std::string name)
	Registers a an event listener. More...
BLAM void	UnregisterListener (BlamEventListener *listener)
	Unregisters a an event listener. More...
BLAM void	UnregisterListeners ()
	Unregisters all listeners. More...
BLAM void	ResortListeners (BlamEventListener *requesting_listener)
	Re-sorts the list of registered listeners after a priority modification. More...
BLAM std::vector< BlamEventListener * >	GetListeners ()
	Retrieves a list of currently registered listeners. More...

Detailed Description

Namespace for handling things related to Events.

Function Documentation

FireEvent()

void Blam::Events::FireEvent

(

BlamEvent *

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.

GetListeners()

std::vector< BlamEventListener * > Blam::Events::GetListeners

(

)

Retrieves a list of currently registered listeners.

Returns

A list of currently registered listeners.

RegisterListener()

void Blam::Events::RegisterListener	(	BlamEventListener *	listener,
		std::string	name
	)

Registers a an event listener.

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

Parameters

listener	- Pointer to the listener to register.
name	- A name used to identify the listener. Used for debugging purposes.

ResortListeners()

void Blam::Events::ResortListeners

(

BlamEventListener *

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()

void Blam::Events::UnregisterListener

(

BlamEventListener *

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.

UnregisterListeners()

void Blam::Events::UnregisterListeners

(

)

Unregisters all listeners.