Class representing a generic event. More...

#include <BlamEvent.h>

Inheritance diagram for BlamEvent:

Public Member Functions
	BlamEvent (BlamEventType type)
	Constructs a new event with the specified type. More...

BlamEventType	GetEventType ()
	Retrieves the type of the event. More...

void	SetCancelled (bool cancel)
	Sets whether or not the event should be cancelled. More...

bool	IsCancelled ()
	Determines whether or not the event has been cancelled. More...

Detailed Description

Class representing a generic event.

Events can be used for virtually anything. They are used as a way to avoid lots of hard-coding when certain actions are triggered.

Constructor & Destructor Documentation

BlamEvent::BlamEvent ( BlamEventType type )

Constructs a new event with the specified type.

Parameters

type	- The type of the new event.

BlamEventType BlamEvent::GetEventType ( )

Retrieves the type of the event.

Here is the caller graph for this function:

bool BlamEvent::IsCancelled ( )

Determines whether or not the event has been cancelled.

Here is the caller graph for this function:

void BlamEvent::SetCancelled ( bool cancel )

Sets whether or not the event should be cancelled.

If an event is cancelled, none of the remaining listeners will recieve a notification about the event.

Parameters

cancel - Whether or not to cancel the event.

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