helios::ecs::EntityAddedMsg Class Reference

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

#include <builtin_messages.hpp>

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

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

Detailed Description

Message sent when an entity is added.

Definition at line 14 of file builtin_messages.hpp.

Constructor & Destructor Documentation

EntityAddedMsg() [1/3]

helios::ecs::EntityAddedMsg::EntityAddedMsg ( Entity entity )

inlineexplicitconstexprnoexcept

Constructs entity added message.

Warning

Triggers assertion if entity is invalid.

Parameters

entity

Destroyed entity

Definition at line 26 of file builtin_messages.hpp.

EntityAddedMsg() [2/3]

helios::ecs::EntityAddedMsg::EntityAddedMsg ( const EntityAddedMsg & )

constexprdefaultnoexcept

EntityAddedMsg() [3/3]

helios::ecs::EntityAddedMsg::EntityAddedMsg ( EntityAddedMsg && )

constexprdefaultnoexcept

~EntityAddedMsg()

helios::ecs::EntityAddedMsg::~EntityAddedMsg ( )

constexprdefaultnoexcept

Member Function Documentation

GetEntity()

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

inlinenodiscardconstexprnoexcept

Gets the entity that was added.

Returns

Entity that was added

Definition at line 41 of file builtin_messages.hpp.

operator=() [1/2]

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

constexprdefaultnoexcept

operator=() [2/2]

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

constexprdefaultnoexcept

Member Data Documentation

kAsync

bool helios::ecs::EntityAddedMsg::kAsync = false

staticconstexpr

Definition at line 19 of file builtin_messages.hpp.

kClearPolicy

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

staticconstexpr

Definition at line 17 of file builtin_messages.hpp.

kConsumable

bool helios::ecs::EntityAddedMsg::kConsumable = false

staticconstexpr

Definition at line 18 of file builtin_messages.hpp.

kName

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

staticconstexpr

Definition at line 16 of file builtin_messages.hpp.