Blam::Events::Event Class Reference

Class representing a generic event. More...

#include <Event.hpp>

Inheritance diagram for Blam::Events::Event:

Public Member Functions
EventType	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...

Public Attributes
EventType	event_type
	The type of the event. 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.

Member Function Documentation

GetEventType()

EventType Blam::Events::Event::GetEventType ( )

inline

Retrieves the type of the event.

Returns

The event type.

isCancelled()

bool Blam::Events::Event::isCancelled ( )

inline

Determines whether or not the event has been cancelled.

Returns

Whether or not the event is cancelled.

setCancelled()

void Blam::Events::Event::setCancelled ( bool  cancel )

inline

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.

Member Data Documentation

event_type

EventType Blam::Events::Event::event_type

The type of the event.

---

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

• blam/components/core/events/events/Event.hpp