helios::ecs::ComponentRemovedMsg< T > Class Template Reference

Message sent when a component is removed. More...

#include <builtin_messages.hpp>

Public Member Functions
constexpr	ComponentRemovedMsg (Entity entity) noexcept
	Constructs component removed message.
constexpr	ComponentRemovedMsg (const ComponentRemovedMsg &) noexcept=default
constexpr	ComponentRemovedMsg (ComponentRemovedMsg &&) noexcept=default
constexpr	~ComponentRemovedMsg () noexcept=default
constexpr ComponentRemovedMsg &	operator= (const ComponentRemovedMsg &) noexcept=default
constexpr ComponentRemovedMsg &	operator= (ComponentRemovedMsg &&) noexcept=default
constexpr Entity	GetEntity () const noexcept
	Gets the entity that the component was removed from.

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

Detailed Description

template<ComponentTrait T>
class helios::ecs::ComponentRemovedMsg< T >

Message sent when a component is removed.

Definition at line 124 of file builtin_messages.hpp.

Constructor & Destructor Documentation

ComponentRemovedMsg() [1/3]

template<ComponentTrait T>

helios::ecs::ComponentRemovedMsg< T >::ComponentRemovedMsg ( Entity entity )

inlineexplicitconstexprnoexcept

Constructs component removed message.

Warning

Triggers assertion if entity is invalid.

Parameters

entity

Entity that component was removed from

Definition at line 136 of file builtin_messages.hpp.

ComponentRemovedMsg() [2/3]

template<ComponentTrait T>

helios::ecs::ComponentRemovedMsg< T >::ComponentRemovedMsg ( const ComponentRemovedMsg< T > & )

constexprdefaultnoexcept

ComponentRemovedMsg() [3/3]

template<ComponentTrait T>

helios::ecs::ComponentRemovedMsg< T >::ComponentRemovedMsg ( ComponentRemovedMsg< T > && )

constexprdefaultnoexcept

~ComponentRemovedMsg()

template<ComponentTrait T>

helios::ecs::ComponentRemovedMsg< T >::~ComponentRemovedMsg ( )

constexprdefaultnoexcept

Member Function Documentation

GetEntity()

template<ComponentTrait T>

Entity helios::ecs::ComponentRemovedMsg< T >::GetEntity ( ) const

inlinenodiscardconstexprnoexcept

Gets the entity that the component was removed from.

Returns

Entity that the component was removed from

Definition at line 154 of file builtin_messages.hpp.

operator=() [1/2]

template<ComponentTrait T>

ComponentRemovedMsg & helios::ecs::ComponentRemovedMsg< T >::operator= ( ComponentRemovedMsg< T > && )

constexprdefaultnoexcept

operator=() [2/2]

template<ComponentTrait T>

ComponentRemovedMsg & helios::ecs::ComponentRemovedMsg< T >::operator= ( const ComponentRemovedMsg< T > & )

constexprdefaultnoexcept

Member Data Documentation

kAsync

template<ComponentTrait T>

bool helios::ecs::ComponentRemovedMsg< T >::kAsync = false

staticconstexpr

Definition at line 129 of file builtin_messages.hpp.

kClearPolicy

template<ComponentTrait T>

auto helios::ecs::ComponentRemovedMsg< T >::kClearPolicy = MessageClearPolicy::kAutomatic

staticconstexpr

Definition at line 127 of file builtin_messages.hpp.

kConsumable

template<ComponentTrait T>

bool helios::ecs::ComponentRemovedMsg< T >::kConsumable = false

staticconstexpr

Definition at line 128 of file builtin_messages.hpp.

kName

template<ComponentTrait T>

std::string_view helios::ecs::ComponentRemovedMsg< T >::kName = "ComponentRemovedMsg"

staticconstexpr

Definition at line 126 of file builtin_messages.hpp.