helios::ecs::details::TryDestroyEntityCmd Class Reference

Command to try destroy a single entity. More...

#include <commands.hpp>

Inheritance diagram for helios::ecs::details::TryDestroyEntityCmd:

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

Detailed Description

Command to try destroy a single entity.

Will destroy the entity only if it exists in the world. Invalid entity handle still asserts.

Definition at line 146 of file commands.hpp.

Constructor & Destructor Documentation

TryDestroyEntityCmd() [1/3]

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

explicitconstexprnoexcept

Constructs try destroy entity command.

Warning

Triggers assertion if entity is invalid.

Parameters

entity

Entity to destroy

Definition at line 171 of file commands.hpp.

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

TryDestroyEntityCmd() [2/3]

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

constexprdefaultnoexcept

TryDestroyEntityCmd() [3/3]

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

constexprdefaultnoexcept

~TryDestroyEntityCmd()

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

constexproverridedefaultnoexcept

Member Function Documentation

Execute()

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

inlineoverridevirtual

Executes entity destruction if it exists.

Parameters

world

World to remove entity from

Implements helios::ecs::Command.

Definition at line 165 of file commands.hpp.

{ world.TryDestroyEntity(entity_); }

operator=() [1/2]

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

constexprdefaultnoexcept

operator=() [2/2]

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

constexprdefaultnoexcept