helios::ecs::EntityDestroyedMsg Class Reference

Message sent when an entity is destroyed. More...

#include <builtin_messages.hpp>

Public Member Functions
constexpr	EntityDestroyedMsg (Entity entity) noexcept
	Constructs entity destroyed message.
constexpr	EntityDestroyedMsg (const EntityDestroyedMsg &) noexcept=default
constexpr	EntityDestroyedMsg (EntityDestroyedMsg &&) noexcept=default
constexpr	~EntityDestroyedMsg () noexcept=default
constexpr EntityDestroyedMsg &	operator= (const EntityDestroyedMsg &) noexcept=default
constexpr EntityDestroyedMsg &	operator= (EntityDestroyedMsg &&) noexcept=default
constexpr Entity	GetEntity () const noexcept
	Gets the entity that was destroyed.

Static Public Attributes
static constexpr std::string_view	kName = "EntityDestroyedMsg"
static constexpr auto	kClearPolicy = MessageClearPolicy::kAutomatic
static constexpr bool	kConsumable = false
static constexpr bool	kAsync = false

Detailed Description

Message sent when an entity is destroyed.

Definition at line 48 of file builtin_messages.hpp.

Constructor & Destructor Documentation

EntityDestroyedMsg() [1/3]

helios::ecs::EntityDestroyedMsg::EntityDestroyedMsg ( Entity entity )

inlineexplicitconstexprnoexcept

Constructs entity destroyed message.

Warning

Triggers assertion if entity is invalid.

Parameters

entity

Destroyed entity

Definition at line 60 of file builtin_messages.hpp.

EntityDestroyedMsg() [2/3]

helios::ecs::EntityDestroyedMsg::EntityDestroyedMsg ( const EntityDestroyedMsg & )

constexprdefaultnoexcept

EntityDestroyedMsg() [3/3]

helios::ecs::EntityDestroyedMsg::EntityDestroyedMsg ( EntityDestroyedMsg && )

constexprdefaultnoexcept

~EntityDestroyedMsg()

helios::ecs::EntityDestroyedMsg::~EntityDestroyedMsg ( )

constexprdefaultnoexcept

Member Function Documentation

GetEntity()

Entity helios::ecs::EntityDestroyedMsg::GetEntity ( ) const

inlinenodiscardconstexprnoexcept

Gets the entity that was destroyed.

Returns

Entity that was destroyed

Definition at line 78 of file builtin_messages.hpp.

operator=() [1/2]

EntityDestroyedMsg & helios::ecs::EntityDestroyedMsg::operator= ( const EntityDestroyedMsg & )

constexprdefaultnoexcept

operator=() [2/2]

EntityDestroyedMsg & helios::ecs::EntityDestroyedMsg::operator= ( EntityDestroyedMsg && )

constexprdefaultnoexcept

Member Data Documentation

kAsync

bool helios::ecs::EntityDestroyedMsg::kAsync = false

staticconstexpr

Definition at line 53 of file builtin_messages.hpp.

kClearPolicy

auto helios::ecs::EntityDestroyedMsg::kClearPolicy = MessageClearPolicy::kAutomatic

staticconstexpr

Definition at line 51 of file builtin_messages.hpp.

kConsumable

bool helios::ecs::EntityDestroyedMsg::kConsumable = false

staticconstexpr

Definition at line 52 of file builtin_messages.hpp.

kName

std::string_view helios::ecs::EntityDestroyedMsg::kName = "EntityDestroyedMsg"

staticconstexpr

Definition at line 50 of file builtin_messages.hpp.