helios::ecs::details::ClearComponentsCmd Class Reference

Command to clear all components from an entity. More...

#include <commands.hpp>

Inheritance diagram for helios::ecs::details::ClearComponentsCmd:

Public Member Functions
constexpr	ClearComponentsCmd (Entity entity) noexcept
	Constructs clear components command.
constexpr	ClearComponentsCmd (const ClearComponentsCmd &) noexcept=default
constexpr	ClearComponentsCmd (ClearComponentsCmd &&) noexcept=default
constexpr	~ClearComponentsCmd () noexcept override=default
constexpr ClearComponentsCmd &	operator= (const ClearComponentsCmd &) noexcept=default
constexpr ClearComponentsCmd &	operator= (ClearComponentsCmd &&) noexcept=default
void	Execute (World &world) override
	Executes component clearing.
Public Member Functions inherited from helios::ecs::Command
virtual constexpr	~Command () noexcept=default

Detailed Description

Command to clear all components from an entity.

Removes all components from the specified entity during execution.

Definition at line 591 of file commands.hpp.

Constructor & Destructor Documentation

ClearComponentsCmd() [1/3]

constexpr helios::ecs::details::ClearComponentsCmd::ClearComponentsCmd ( Entity  entity )

explicitconstexprnoexcept

Constructs clear components command.

Warning

Triggers assertion if entity is invalid.

Parameters

entity

Entity to clear components from

Definition at line 616 of file commands.hpp.

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

ClearComponentsCmd() [2/3]

constexpr helios::ecs::details::ClearComponentsCmd::ClearComponentsCmd ( const ClearComponentsCmd &  )

constexprdefaultnoexcept

ClearComponentsCmd() [3/3]

constexpr helios::ecs::details::ClearComponentsCmd::ClearComponentsCmd ( ClearComponentsCmd &&  )

constexprdefaultnoexcept

~ClearComponentsCmd()

constexpr helios::ecs::details::ClearComponentsCmd::~ClearComponentsCmd ( )

constexproverridedefaultnoexcept

Member Function Documentation

Execute()

void helios::ecs::details::ClearComponentsCmd::Execute ( World &  world )

inlineoverridevirtual

Executes component clearing.

Parameters

world

World to clear components in

Implements helios::ecs::Command.

Definition at line 610 of file commands.hpp.

{ world.ClearComponents(entity_); }

operator=() [1/2]

constexpr ClearComponentsCmd & helios::ecs::details::ClearComponentsCmd::operator= ( ClearComponentsCmd &&  )

constexprdefaultnoexcept

operator=() [2/2]

constexpr ClearComponentsCmd & helios::ecs::details::ClearComponentsCmd::operator= ( const ClearComponentsCmd &  )

constexprdefaultnoexcept