helios::ecs::ComponentsClearedMsg Class Reference

Message sent when all components are cleared from an entity. More...

#include <builtin_messages.hpp>

Public Member Functions
constexpr	ComponentsClearedMsg (Entity entity) noexcept
	Constructs components cleared message.
constexpr	ComponentsClearedMsg (const ComponentsClearedMsg &) noexcept=default
constexpr	ComponentsClearedMsg (ComponentsClearedMsg &&) noexcept=default
constexpr	~ComponentsClearedMsg () noexcept=default
constexpr ComponentsClearedMsg &	operator= (const ComponentsClearedMsg &) noexcept=default
constexpr ComponentsClearedMsg &	operator= (ComponentsClearedMsg &&) noexcept=default
constexpr Entity	GetEntity () const noexcept
	Gets the entity that the components were cleared from.

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

Detailed Description

Message sent when all components are cleared from an entity.

Definition at line 161 of file builtin_messages.hpp.

Constructor & Destructor Documentation

ComponentsClearedMsg() [1/3]

helios::ecs::ComponentsClearedMsg::ComponentsClearedMsg ( Entity entity )

inlineexplicitconstexprnoexcept

Constructs components cleared message.

Warning

Triggers assertion if entity is invalid.

Parameters

entity

Entity that components were cleared from

Definition at line 173 of file builtin_messages.hpp.

ComponentsClearedMsg() [2/3]

helios::ecs::ComponentsClearedMsg::ComponentsClearedMsg ( const ComponentsClearedMsg & )

constexprdefaultnoexcept

ComponentsClearedMsg() [3/3]

helios::ecs::ComponentsClearedMsg::ComponentsClearedMsg ( ComponentsClearedMsg && )

constexprdefaultnoexcept

~ComponentsClearedMsg()

helios::ecs::ComponentsClearedMsg::~ComponentsClearedMsg ( )

constexprdefaultnoexcept

Member Function Documentation

GetEntity()

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

inlinenodiscardconstexprnoexcept

Gets the entity that the components were cleared from.

Returns

Entity that the components were cleared from

Definition at line 192 of file builtin_messages.hpp.

operator=() [1/2]

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

constexprdefaultnoexcept

operator=() [2/2]

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

constexprdefaultnoexcept

Member Data Documentation

kAsync

bool helios::ecs::ComponentsClearedMsg::kAsync = false

staticconstexpr

Definition at line 166 of file builtin_messages.hpp.

kClearPolicy

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

staticconstexpr

Definition at line 164 of file builtin_messages.hpp.

kConsumable

bool helios::ecs::ComponentsClearedMsg::kConsumable = false

staticconstexpr

Definition at line 165 of file builtin_messages.hpp.

kName

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

staticconstexpr

Definition at line 163 of file builtin_messages.hpp.