scl::event_dispatcher Class Reference

#include <event_dispatcher.h>

Static Public Member Functions
template<typename Tevent >
static void	AddEventListner (base_event_callback &&EventCallback)
template<typename Tevent >
static void	AddEventListner (std::function< bool(Tevent &)> &&EventCallback)
template<typename Tevent >
static void	Invoke (Tevent &Event)

Detailed Description

Static event dispatcher class. Should be created once, then event listners added to it and dispatched on event invoke.

Definition at line 19 of file event_dispatcher.h.

Member Function Documentation

AddEventListner() [1/2]

template<typename Tevent >

static void scl::event_dispatcher::AddEventListner ( base_event_callback &&  EventCallback )

inlinestatic

Static event dispatcher methods.

• Add event listner to specific event function.

Template Parameters

Tevent

- event to set listner to.

Parameters

Event

- callback to be called on event dispatch.

Returns

None.

Definition at line 38 of file event_dispatcher.h.

        {
            auto event_handlers = EventHandlers.find(Tevent::StaticType);
            if (event_handlers == EventHandlers.end())
                EventHandlers.emplace(Tevent::StaticType, std::vector { std::move(EventCallback) });
            else
                event_handlers->second.push_back(std::move(EventCallback));
        }

AddEventListner() [2/2]

template<typename Tevent >

static void scl::event_dispatcher::AddEventListner ( std::function< bool(Tevent &)> &&  EventCallback )

inlinestatic

• Add event listner to specific event function.

Template Parameters

Tevent

- event to set listner to.

Parameters

Event

- callback to be called on event dispatch.

Returns

None.

Definition at line 55 of file event_dispatcher.h.

        {
            AddEventListner<Tevent>([callback = std::move(EventCallback)](event &Event)
            {
                if (Event.GetType() != Tevent::StaticType) return false;
                return callback(static_cast<Tevent &>(Event));
            });
        }

Invoke()

template<typename Tevent >

static void scl::event_dispatcher::Invoke ( Tevent &  Event )

inlinestatic

• Dispatch specific event function. Calls all callbacks, listing to that event.

Parameters

Event

- event to handle.

Returns

None.

Definition at line 72 of file event_dispatcher.h.

        {
            std::map<string_id, callback_list>::iterator event_handlers = EventHandlers.find(Event.GetType());
            if (event_handlers == EventHandlers.end()) return;
 
            for (const auto &callback : event_handlers->second)
            {
                Event.Handled |= callback(Event);
                if (Event.Handled) break;
            }
        }

---

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

• utilities/event/event_dispatcher.h
• utilities/event/event_dispatcher.cpp