helios::ecs::details::DestroyEntitiesCmd Class Reference

Command to destroy multiple entities. More...

#include <commands.hpp>

Inheritance diagram for helios::ecs::details::DestroyEntitiesCmd:

Public Member Functions
template<std::ranges::range R> requires std::same_as<std::ranges::range_value_t<R>, Entity>
constexpr	DestroyEntitiesCmd (const R &entities)
	Constructs destroy entities command from range.
constexpr	DestroyEntitiesCmd (const DestroyEntitiesCmd &) noexcept=default
constexpr	DestroyEntitiesCmd (DestroyEntitiesCmd &&) noexcept=default
constexpr	~DestroyEntitiesCmd () noexcept override=default
constexpr DestroyEntitiesCmd &	operator= (const DestroyEntitiesCmd &) noexcept=default
constexpr DestroyEntitiesCmd &	operator= (DestroyEntitiesCmd &&) noexcept=default
void	Execute (World &world) override
	Executes entities destruction.
Public Member Functions inherited from helios::ecs::Command
virtual constexpr	~Command () noexcept=default

Detailed Description

Command to destroy multiple entities.

Efficiently destroys multiple entities in a single operation. Will assert if any of the entities do not exist in the world (when world implementation updated).

Definition at line 103 of file commands.hpp.

Constructor & Destructor Documentation

DestroyEntitiesCmd() [1/3]

template<std::ranges::range R>
requires std::same_as<std::ranges::range_value_t<R>, Entity>

constexpr helios::ecs::details::DestroyEntitiesCmd::DestroyEntitiesCmd ( const R &  entities )

explicitconstexpr

Constructs destroy entities command from range.

Warning

Triggers assertion if any entity is invalid.

Template Parameters

R	Range type containing Entity elements

Parameters

entities

Range of entities to destroy

Definition at line 133 of file commands.hpp.

    : entities_(std::ranges::begin(entities), std::ranges::end(entities)) {
  for (const Entity& entity : entities_) {
    HELIOS_ASSERT(entity.Valid(), "Failed to construct destroy entities command: Entity with index '{}' is invalid!",
                  entity.Index());
  }
}

DestroyEntitiesCmd() [2/3]

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

constexprdefaultnoexcept

DestroyEntitiesCmd() [3/3]

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

constexprdefaultnoexcept

~DestroyEntitiesCmd()

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

constexproverridedefaultnoexcept

Member Function Documentation

Execute()

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

inlineoverridevirtual

Executes entities destruction.

Parameters

world

World to remove entities from

Implements helios::ecs::Command.

Definition at line 125 of file commands.hpp.

{ world.DestroyEntities(entities_); }

operator=() [1/2]

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

constexprdefaultnoexcept

operator=() [2/2]

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

constexprdefaultnoexcept