helios::ecs::ShutdownEvent Struct Reference

#include <builtin_events.hpp>

Static Public Member Functions
static constexpr std::string_view	GetName () noexcept
	Gets the event name.
static constexpr EventClearPolicy	GetClearPolicy () noexcept
	Gets the clear policy for this event.

Public Attributes
ShutdownExitCode	exit_code = ShutdownExitCode::Success
	Exit code for the shutdown.

Detailed Description

Definition at line 81 of file builtin_events.hpp.

Member Function Documentation

GetClearPolicy()

static constexpr EventClearPolicy helios::ecs::ShutdownEvent::GetClearPolicy ( )

inlinestaticconstexprnoexcept

Gets the clear policy for this event.

Uses manual clear policy since shutdown should persist until processed.

Returns

Event clear policy (manual)

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/events/builtin_events.hpp.

Definition at line 95 of file builtin_events.hpp.

{ return EventClearPolicy::kManual; }

GetName()

static constexpr std::string_view helios::ecs::ShutdownEvent::GetName ( )

inlinestaticconstexprnoexcept

Gets the event name.

Returns

Event name string

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/events/builtin_events.hpp.

Definition at line 88 of file builtin_events.hpp.

{ return "ShutdownEvent"; }

Member Data Documentation

exit_code

ShutdownExitCode helios::ecs::ShutdownEvent::exit_code = ShutdownExitCode::Success

Exit code for the shutdown.

Examples

/home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/ecs/events/builtin_events.hpp.

Definition at line 82 of file builtin_events.hpp.