shiva::event

On this page you will find information about the different events that can be sent and received in shiva

Purpose

The purpose of this module is to give users the opportunity to interact through events in their program, whether in C++ or in a scripting language.

Events

Event Name	Description
add_base_system	trigger an event that add a system in the system manager
after_load_systems_plugins	triggers an event after the complete loading of plugged systems
after_load_resources	triggers an event after the complete loading resource of a scene or program
fatal_error_occured	triggers an event that indicates that an uncorrectable error has occurred
quit_game	triggers an event that indicates the end of the program
start_game	triggers an event that indicates the beginning of the program
key_pressed	triggers an event if the user presses a key on his keyboard
key_released	triggers an event if the user release a key on his keyboard
change_scene	triggers an event that indicates the change from one scene to another

All events are default constructible.

add_base_system

Constructor

add_base_system(std::unique_ptr<shiva::ecs::base_system> system_ptr_ = nullptr) noexcept

Example

#include <memory>
#include <shiva/event/add_base_system.hpp>
#include "conrete_system.hpp"

shiva::entt::dispatcher dispatcher;

dispatcher.trigger<shiva::event::add_base_system>(
std::make_unique<concrete_system>(...));

after_load_systems_plugins

Constructor

This event has no constructor

Example

#include <memory>
#include <shiva/event/after_load_systems_plugins.hpp>

shiva::entt::dispatcher dispatcher;

dispatcher.trigger<shiva::event::after_load_systems_plugins>();

This event is already triggered by the system_manager in the function load_plugins().

We recommend that you do not trigger this event unless you use your own system manager.

after_load_resources

Constructor

This event has no constructor

Example

#include <memory>
#include <shiva/event/after_load_resources.hpp>

shiva::entt::dispatcher dispatcher;
dispatcher.trigger<shiva::event::after_load_resources>();

You can find a more concrete example in the source code here

fatal_error_occured

Constructor

fatal_error_occured(std::error_code ec) noexcept;

Example

#include <memory>
#include <system_error>
#include <shiva/event/fatal_error_occured.hpp>

shiva::entt::dispatcher dispatcher;
dispatcher.trigger<shiva::event::fatal_error_occured>(std::make_error_code(std::errc::result_out_of_range));

You can find a more concrete example in the source code here

quit_game

Constructor

quit_game(int return_value) noexcept;

Example

#include <memory>
#include <system_error>
#include <shiva/event/quit_game.hpp>

shiva::entt::dispatcher dispatcher;
dispatcher.trigger<shiva::event::quit_game>(0);

You can find a more concrete example in the source code here

start_game

Constructor

This event has no constructor

Example

#include <memory>
#include <system_error>
#include <shiva/event/start_game.hpp>

shiva::entt::dispatcher dispatcher;
dispatcher.trigger<shiva::event::start_game>();

You can find a more concrete example in the source code here

key_pressed

Constructor

key_pressed(shiva::input::keyboard::TKey key) noexcept;

Example

#include <memory>
#include <system_error>
#include <shiva/event/key_pressed.hpp>

shiva::entt::dispatcher dispatcher;
dispatcher.trigger<shiva::event::key_pressed>(shiva::input::keyboard::TKey::A);

You can find more information about input here

You can find a more concrete example in the source code here

key_released

Constructor

key_released(shiva::input::keyboard::TKey key) noexcept;

Example

#include <memory>
#include <system_error>
#include <shiva/event/key_released.hpp>

shiva::entt::dispatcher dispatcher;
dispatcher.trigger<shiva::event::key_released>(shiva::input::keyboard::TKey::A);

change_scene

Constructor

change_scene(const char* scene_name_ = nullptr) noexcept;

Example

#include <memory>
#include <system_error>
#include <shiva/event/change_scene.hpp>

shiva::entt::dispatcher dispatcher;
dispatcher.trigger<shiva::event::change_scene>("game_scene");