DelayedComponentEnabler Class Template

Component that manages delayed activation of other components. More...

Declaration

template <typename THandle> class helios::engine::runtime::lifecycle::components::DelayedComponentEnabler<THandle> { ... }

Public Constructors Index

template <typename THandle>
DelayedComponentEnabler ()=default
	Default constructor. More...
template <typename THandle>
DelayedComponentEnabler (const DelayedComponentEnabler &other)
	Copy constructor for cloning during spawn. More...
template <typename THandle>
DelayedComponentEnabler (DelayedComponentEnabler &&) noexcept=default

Public Operators Index

template <typename THandle>
DelayedComponentEnabler &	operator= (const DelayedComponentEnabler &)=default
template <typename THandle>
DelayedComponentEnabler &	operator= (DelayedComponentEnabler &&) noexcept=default

Public Member Functions Index

template <typename THandle>
auto	deferredComponents () noexcept -> std::span< DeferredComponent >
	Returns a view of all currently deferred components. More...
template <typename THandle>
void	sync (std::span< helios::ecs::types::ComponentTypeId< THandle > > removeList)
	Removes activated components from the deferred list. More...
template <typename TEntity>
void	defer (TEntity entity, helios::ecs::types::ComponentTypeId< THandle > componentTypeId, const float delta)
	Schedules a component for delayed activation. More...

Private Member Attributes Index

template <typename THandle>
std::vector< DeferredComponent >	deferredComponents_
	List of components pending delayed activation. More...

Description

Component that manages delayed activation of other components.

DelayedComponentEnabler maintains a list of components that should be activated after a specified delay. This is useful for runtime patterns where newly spawned entities need temporary immunity or staggered activation:

• Collision immunity: Projectiles ignore collisions briefly after spawn
• AI warmup: Behavior components activate after positioning completes
• Visual fade-in: Rendering components enable after spawn effects
• Staggered waves: Sequential entities activate progressively

The component works in conjunction with DelayedComponentEnablerSystem, which decrements timers each frame and enables components when their delay expires.

info

Components are disabled immediately when deferred and re-enabled automatically by the system when the delay reaches zero.

See Also

DelayedComponentEnablerSystem

See Also

DelayedComponentEnablerInitializer

Definition at line 42 of file DelayedComponentEnabler.ixx.

Public Constructors

DelayedComponentEnabler()

template <typename THandle>

helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::DelayedComponentEnabler ()

default

Default constructor.

Definition at line 69 of file DelayedComponentEnabler.ixx.

DelayedComponentEnabler()

template <typename THandle>

helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::DelayedComponentEnabler (const DelayedComponentEnabler & other)

inline

Copy constructor for cloning during spawn.

Parameters

other

The source component to copy from.

Definition at line 76 of file DelayedComponentEnabler.ixx.

76 DelayedComponentEnabler(const DelayedComponentEnabler& other)

77 : deferredComponents_(other.deferredComponents_) {}

DelayedComponentEnabler()

template <typename THandle>

helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::DelayedComponentEnabler (DelayedComponentEnabler &&)

noexcept default

Definition at line 80 of file DelayedComponentEnabler.ixx.

Public Operators

operator=()

template <typename THandle>

DelayedComponentEnabler & helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::operator= (const DelayedComponentEnabler &)

default

Definition at line 79 of file DelayedComponentEnabler.ixx.

operator=()

template <typename THandle>

DelayedComponentEnabler & helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::operator= (DelayedComponentEnabler &&)

noexcept default

Definition at line 81 of file DelayedComponentEnabler.ixx.

Public Member Functions

defer()

template <typename TEntity>

void helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::defer (TEntity entity, helios::ecs::types::ComponentTypeId< THandle > componentTypeId, const float delta)

inline

Schedules a component for delayed activation.

The specified component is immediately disabled and added to the deferred list. If the component is already deferred, its delay is updated to the new value.

Parameters

componentTypeId	Type identifier of the component to defer.
delta	Delay in seconds before activation.

info

Asserts if delta <= 0 or if the component does not exist on the entity.

Definition at line 119 of file DelayedComponentEnabler.ixx.

119 void defer(

120 TEntity entity,

121 helios::ecs::types::ComponentTypeId<THandle> componentTypeId, const float delta) {

122 assert(delta > 0 && "delta must be greater than 0");

123

124 const bool hasCmp = entity.has(componentTypeId);

125 assert(hasCmp && "ComponentTypeId not part of Entity");

126

127 const auto it = std::ranges::find_if(deferredComponents_,

128 [componentTypeId](const auto& item) {

129 return item.componentTypeId == componentTypeId;

130 });

131

132 entity.disableComponent(componentTypeId);

133

134 if (it == deferredComponents_.end()) {

135 deferredComponents_.push_back({delta, componentTypeId});

136 } else {

137 it->delta = delta;

138 }

139 }

Reference helios::engine::runtime::lifecycle::registerComponents.

deferredComponents()

template <typename THandle>

std::span< DeferredComponent > helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::deferredComponents ()

inline noexcept

Returns a view of all currently deferred components.

Returns

Span of DeferredComponent entries with remaining delays.

Definition at line 88 of file DelayedComponentEnabler.ixx.

88 std::span<DeferredComponent> deferredComponents() noexcept {

89 return deferredComponents_;

90 }

sync()

template <typename THandle>

void helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::sync (std::span< helios::ecs::types::ComponentTypeId< THandle > > removeList)

inline

Removes activated components from the deferred list.

Called by the system after enabling components to clean up entries that have completed their delay period.

Parameters

removeList

Component type IDs to remove from tracking.

Definition at line 100 of file DelayedComponentEnabler.ixx.

100 void sync(std::span<helios::ecs::types::ComponentTypeId<THandle>> removeList) {

101 std::erase_if(deferredComponents_, [&](const DeferredComponent& dc) {

102 return std::ranges::find(removeList, dc.componentTypeId) != removeList.end();

103 });

104 }

Reference helios::engine::runtime::lifecycle::registerComponents.

Private Member Attributes

deferredComponents_

template <typename THandle>

std::vector<DeferredComponent> helios::engine::runtime::lifecycle::components::DelayedComponentEnabler< THandle >::deferredComponents_

List of components pending delayed activation.

Definition at line 62 of file DelayedComponentEnabler.ixx.

62 std::vector<DeferredComponent> deferredComponents_;

---

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

• DelayedComponentEnabler.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.