helios::ecs::details::DestroyEntityCmd Class Reference

Command to destroy a single entity. More...

#include <commands.hpp>

Inheritance diagram for helios::ecs::details::DestroyEntityCmd:

Public Member Functions
constexpr	DestroyEntityCmd (Entity entity) noexcept
	Constructs destroy entity command.
constexpr	DestroyEntityCmd (const DestroyEntityCmd &) noexcept=default
constexpr	DestroyEntityCmd (DestroyEntityCmd &&) noexcept=default
constexpr	~DestroyEntityCmd () noexcept override=default
constexpr DestroyEntityCmd &	operator= (const DestroyEntityCmd &) noexcept=default
constexpr DestroyEntityCmd &	operator= (DestroyEntityCmd &&) noexcept=default
void	Execute (World &world) override
	Executes entity destruction.
Public Member Functions inherited from helios::ecs::Command
virtual constexpr	~Command () noexcept=default

Detailed Description

Command to destroy a single entity.

Removes entity and all its components from the world during execution. Will assert if the world does not own (entity index/generation mismatch) the entity.

Definition at line 67 of file commands.hpp.

Constructor & Destructor Documentation

DestroyEntityCmd() [1/3]

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

explicitconstexprnoexcept

Constructs destroy entity command.

Warning

Triggers assertion if entity is invalid.

Parameters

entity

Entity to destroy

Definition at line 92 of file commands.hpp.

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

DestroyEntityCmd() [2/3]

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

constexprdefaultnoexcept

DestroyEntityCmd() [3/3]

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

constexprdefaultnoexcept

~DestroyEntityCmd()

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

constexproverridedefaultnoexcept

Member Function Documentation

Execute()

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

inlineoverridevirtual

Executes entity destruction.

Parameters

world

World to remove entity from

Implements helios::ecs::Command.

Definition at line 86 of file commands.hpp.

{ world.DestroyEntity(entity_); }

operator=() [1/2]

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

constexprdefaultnoexcept

operator=() [2/2]

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

constexprdefaultnoexcept