Skip to main content

DeactivateEntityCommand Struct Template

Deferred command that marks an entity as inactive. More...

Declaration

template <typename TMemberHandle> struct helios::ecs::commands::DeactivateEntityCommand<TMemberHandle> { ... }

Public Member Typedefs Index

template <typename TMemberHandle>
usingHandle_type = TMemberHandle

The handle type identifying the target entity. More...

template <typename TMemberHandle>
usingComponent_type = Inactive< TMemberHandle >

Public Member Attributes Index

template <typename TMemberHandle>
Handle_typehandle

Handle of the entity to deactivate. More...

Description

Deferred command that marks an entity as inactive.

Processed by a command consumer to detach the Active component, hiding the entity from views that filter for active entities.

Template Parameters
TMemberHandle

Entity handle type of the target registry.

Definition at line 23 of file DeactivateEntityCommand.ixx.

Public Member Typedefs

Component_type

template <typename TMemberHandle>
using helios::ecs::commands::DeactivateEntityCommand< TMemberHandle >::Component_type = Inactive<TMemberHandle>

Handle_type

template <typename TMemberHandle>
using helios::ecs::commands::DeactivateEntityCommand< TMemberHandle >::Handle_type = TMemberHandle

The handle type identifying the target entity.

Definition at line 26 of file DeactivateEntityCommand.ixx.

26 using Handle_type = TMemberHandle;

Public Member Attributes

handle

template <typename TMemberHandle>
Handle_type helios::ecs::commands::DeactivateEntityCommand< TMemberHandle >::handle

Handle of the entity to deactivate.

Definition at line 31 of file DeactivateEntityCommand.ixx.


The documentation for this struct was generated from the following file:


Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.