helios::ecs::details::AddComponentCmd< T > Class Template Reference

Command to add a component to an entity. More...

#include <commands.hpp>

Inheritance diagram for helios::ecs::details::AddComponentCmd< T >:

Public Member Functions
constexpr	AddComponentCmd (Entity entity, const T &component) noexcept(std::is_nothrow_copy_constructible_v< T >)
	Constructs add component command with copy.
constexpr	AddComponentCmd (Entity entity, T &&component) noexcept(std::is_nothrow_move_constructible_v< T >)
	Constructs add component command with move.
constexpr	AddComponentCmd (const AddComponentCmd &) noexcept(std::is_nothrow_copy_constructible_v< T >)=default
constexpr	AddComponentCmd (AddComponentCmd &&) noexcept(std::is_nothrow_move_constructible_v< T >)=default
constexpr	~AddComponentCmd () noexcept(std::is_nothrow_destructible_v< T >) override=default
constexpr AddComponentCmd &	operator= (const AddComponentCmd &) noexcept(std::is_nothrow_copy_assignable_v< T >)=default
constexpr AddComponentCmd &	operator= (AddComponentCmd &&) noexcept(std::is_nothrow_move_assignable_v< T >)=default
void	Execute (World &world) override
	Executes component addition.
Public Member Functions inherited from helios::ecs::Command
virtual constexpr	~Command () noexcept=default

Detailed Description

template<ComponentTrait T>
class helios::ecs::details::AddComponentCmd< T >

Command to add a component to an entity.

Adds component of type T to the specified entity during execution. If entity already has the component, it will be replaced.

Template Parameters

T	Component type to add

Definition at line 225 of file commands.hpp.

Constructor & Destructor Documentation

AddComponentCmd() [1/4]

template<ComponentTrait T>

constexpr helios::ecs::details::AddComponentCmd< T >::AddComponentCmd ( Entity  entity, const T &  component  )

constexprnoexcept

Constructs add component command with copy.

Warning

Triggers assertion if entity is invalid.

Parameters

entity	Entity to add component to
component	Component to copy

Definition at line 261 of file commands.hpp.

    : entity_(entity), component_(component) {
  HELIOS_ASSERT(entity.Valid(), "Failed to construct add component command: Entity with index '{}' is invalid!",
                entity.Index());
}

AddComponentCmd() [2/4]

template<ComponentTrait T>

constexpr helios::ecs::details::AddComponentCmd< T >::AddComponentCmd ( Entity  entity, T &&  component  )

constexprnoexcept

Constructs add component command with move.

Warning

Triggers assertion if entity is invalid.

Parameters

entity	Entity to add component to
component	Component to move

Definition at line 269 of file commands.hpp.

    : entity_(entity), component_(std::move(component)) {
  HELIOS_ASSERT(entity.Valid(), "Failed to construct add component command: Entity with index '{}' is invalid!",
                entity.Index());
}

AddComponentCmd() [3/4]

template<ComponentTrait T>

constexpr helios::ecs::details::AddComponentCmd< T >::AddComponentCmd ( const AddComponentCmd< T > &  ) const

constexprdefaultnoexcept

AddComponentCmd() [4/4]

template<ComponentTrait T>

constexpr helios::ecs::details::AddComponentCmd< T >::AddComponentCmd ( AddComponentCmd< T > &&  ) const

constexprdefaultnoexcept

~AddComponentCmd()

template<ComponentTrait T>

constexpr helios::ecs::details::AddComponentCmd< T >::~AddComponentCmd ( )

constexproverridedefaultnoexcept

Member Function Documentation

Execute()

template<ComponentTrait T>

void helios::ecs::details::AddComponentCmd< T >::Execute ( World &  world )

inlineoverridevirtual

Executes component addition.

Parameters

world

World to add component in

Implements helios::ecs::Command.

Definition at line 253 of file commands.hpp.

{ world.AddComponent(entity_, std::move(component_)); }

operator=() [1/2]

template<ComponentTrait T>

constexpr AddComponentCmd & helios::ecs::details::AddComponentCmd< T >::operator= ( AddComponentCmd< T > &&  )

constexprdefaultnoexcept

operator=() [2/2]

template<ComponentTrait T>

constexpr AddComponentCmd & helios::ecs::details::AddComponentCmd< T >::operator= ( const AddComponentCmd< T > &  )

constexprdefaultnoexcept