spark::events::Event Class Reference

A base class for all events in SPARK. More...

#include <Event.h>

Inheritance diagram for spark::events::Event:

Public Member Functions
	Event (const Event &other)=default
	Event (Event &&other) noexcept=default
Event &	operator= (const Event &other)=default
Event &	operator= (Event &&other) noexcept=default
virtual EventType	eventType () const =0
	Gets the type of the event.
virtual int	eventCategoryFlags () const =0
	Gets the category flags of the event.
bool	isInCategory (const EventCategory &category) const
	Checks if the event is in the specified category.
Public Member Functions inherited from spark::rtti::HasRtti
	HasRtti (const HasRtti &other)=default
	HasRtti (HasRtti &&other) noexcept=default
HasRtti &	operator= (const HasRtti &other)=default
HasRtti &	operator= (HasRtti &&other) noexcept=default
virtual RttiBase &	rttiInstance () const =0

Public Attributes
bool	handled = false

Detailed Description

A base class for all events in SPARK.

Member Function Documentation

eventCategoryFlags()

virtual int spark::events::Event::eventCategoryFlags ( ) const

nodiscardpure virtual

Gets the category flags of the event.

Returns

An int combining the enum values of the corresponding categories of the event.

eventType()

virtual EventType spark::events::Event::eventType ( ) const

nodiscardpure virtual

Gets the type of the event.

Returns

An EventType enum value corresponding to the type of the event.

isInCategory()

bool spark::events::Event::isInCategory ( const EventCategory & category ) const

nodiscard

Checks if the event is in the specified category.

Parameters

category

The category to check.

Returns

A boolean value indicating whether the event is in the specified category.