CyclicSpawnScheduler Class Template

Scheduler that cycles through spawn rules in round-robin order. More...

Declaration

template <std::size_t N> class helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler<N> { ... }

Base class

class	SpawnScheduler
	Abstract base class for spawn schedulers. More...

Public Member Functions Index

template <std::size_t N>
void	evaluate (const GameWorld &gameWorld, const UpdateContext &updateContext, const SpawnContext &spawnContext) noexcept override
	Evaluates the current rule in the cycle. More...
template <std::size_t N>
CyclicSpawnScheduler &	addRule (const helios::engine::runtime::spawn::types::SpawnProfileId spawnProfileId, std::unique_ptr< helios::engine::runtime::spawn::policy::SpawnRule > spawnRule)
	Adds a spawn rule to the cycle. More...
template <std::size_t N>
void	commit (const helios::engine::runtime::spawn::types::SpawnRuleId spawnRuleId, const size_t spawnCount) noexcept override
	Commits a completed spawn to update rule state. More...
template <std::size_t N>
void	reset () noexcept override
	Resets all rule states and the cursor to initial values. More...

Private Member Attributes Index

template <std::size_t N>
std::array< RuleConfig, N >	ringBuffer_ {}
	Fixed-size ring buffer of rule configurations. More...
template <std::size_t N>
size_t	cursor_ = 0
	Current position in the ring buffer. More...
template <std::size_t N>
size_t	count_ = 0
	Number of rules currently registered. More...
template <std::size_t N>
std::unordered_map< helios::engine::runtime::spawn::types::SpawnRuleId, helios::engine::runtime::spawn::policy::SpawnRuleState >	spawnRuleStates_
	Map from spawn rule IDs to their runtime state. More...
template <std::size_t N>
DefaultRuleProcessor	ruleProcessor_
	Processor for evaluating individual rules. More...

Description

Scheduler that cycles through spawn rules in round-robin order.

CyclicSpawnScheduler evaluates one rule per frame in a fixed-size ring buffer, advancing only when a spawn successfully occurs. This creates predictable, sequential spawn patterns ideal for wave-based gameplay.

## Behavior

• Evaluates the current rule each `evaluate()` call
• Advances cursor only when a spawn plan is successfully produced
• Rules that don't trigger are re-evaluated on subsequent frames
• Uses compile-time fixed capacity via template parameter

## Use Cases

• **Wave spawning:** Sequential enemy types, each wave completes before next
• **Boss patterns:** Predictable attack phase cycling
• **Resource spawning:** Alternating pickup types

## Usage

```cpp CyclicSpawnScheduler<3> scheduler; scheduler .addRule(enemyAProfileId, std::make_unique<TimerSpawnRule>(ruleA, 2.0f, 1)) .addRule(enemyBProfileId, std::make_unique<TimerSpawnRule>(ruleB, 2.0f, 1)) .addRule(bossProfileId, std::make_unique<TimerSpawnRule>(ruleC, 5.0f, 1));

// Evaluates ruleA until spawn occurs, then advances to ruleB, etc. // Cycle: A → B → Boss → A → B → Boss → ... ```

Template Parameters

N	Maximum number of rules the scheduler can hold.

See Also

SpawnScheduler

See Also

DefaultSpawnScheduler

See Also

RuleConfig

Definition at line 92 of file CyclicSpawnScheduler.ixx.

Public Member Functions

addRule()

template <std::size_t N>

CyclicSpawnScheduler & helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::addRule (const helios::engine::runtime::spawn::types::SpawnProfileId spawnProfileId, std::unique_ptr< helios::engine::runtime::spawn::policy::SpawnRule > spawnRule)

inline

Adds a spawn rule to the cycle.

Appends the rule to the ring buffer. Rules are evaluated in the order they are added.

Parameters

spawnProfileId	Profile ID for the spawned entities.
spawnRule	The spawn rule. Ownership transferred.

Returns

Reference to this scheduler for chaining.

Precondition

The scheduler has capacity (count_ < N).

Precondition

No duplicate profile IDs or rule IDs.

Definition at line 173 of file CyclicSpawnScheduler.ixx.

173 CyclicSpawnScheduler& addRule(

174 const helios::engine::runtime::spawn::types::SpawnProfileId spawnProfileId,

175 std::unique_ptr<helios::engine::runtime::spawn::policy::SpawnRule> spawnRule

176 ) {

177 assert(count_ < N);

178

179 assert(!spawnRuleStates_.contains(spawnRule->spawnRuleId()) && "Duplicate SpawnRuleId entry");

180

181 for (const auto& item : ringBuffer_) {

182 assert(item.spawnProfileId != spawnProfileId && "Duplicate SpawnProfile entry");

183 }

184

185 spawnRuleStates_.try_emplace(spawnRule->spawnRuleId());

186

187 ringBuffer_[count_++] = {

188 spawnProfileId, std::move(spawnRule)

189 };

190

191 return *this;

192 }

commit()

template <std::size_t N>

void helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::commit (const helios::engine::runtime::spawn::types::SpawnRuleId spawnRuleId, const size_t spawnCount)

inline noexcept virtual

Commits a completed spawn to update rule state.

Called after entities are spawned to update the rule's internal state (e.g., spawn count tracking).

Parameters

spawnRuleId	The rule that triggered the spawn.
spawnCount	Number of entities actually spawned.

Definition at line 203 of file CyclicSpawnScheduler.ixx.

203 void commit(const helios::engine::runtime::spawn::types::SpawnRuleId spawnRuleId, const size_t spawnCount) noexcept override{

204

205 for (auto& ruleConfig : ringBuffer_) {

206

207 if (ruleConfig.spawnRule->spawnRuleId() == spawnRuleId) {

208

209 auto it = spawnRuleStates_.find(spawnRuleId);

210 assert(it != spawnRuleStates_.end() && "Unexpected missing spawnRuleState");

211

212 ruleConfig.spawnRule->commit(it->second, spawnCount);

213 }

214 }

215 }

evaluate()

template <std::size_t N>

void helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::evaluate (const GameWorld & gameWorld, const UpdateContext & updateContext, const SpawnContext & spawnContext)

inline noexcept virtual

Evaluates the current rule in the cycle.

Processes only the rule at the current cursor position. If the rule produces a spawn plan, the cursor advances to the next rule. Otherwise, the same rule is evaluated again next frame.

Parameters

gameWorld	The game world where evaluation takes place.
updateContext	Current frame context.
spawnContext	Context for spawn operations.

Definition at line 135 of file CyclicSpawnScheduler.ixx.

135 void evaluate(

136 const GameWorld& gameWorld,

137 const UpdateContext& updateContext,

138 const SpawnContext& spawnContext ) noexcept override {

139

140 scheduledSpawnPlans_.clear();

141

142 // Process queue

143 auto& [spawnProfileId, spawnRule] = ringBuffer_[cursor_];

144 auto spawnPlan = ruleProcessor_.processRule(

145 gameWorld, updateContext, spawnContext, spawnProfileId, *spawnRule,

146 spawnRuleStates_[spawnRule->spawnRuleId()]);

147

148 if (spawnPlan.amount > 0) {

149 scheduledSpawnPlans_.push_back({

150 spawnProfileId,

151 std::move(spawnPlan),

152 spawnContext

153 });

154 cursor_ = (cursor_ + 1) % (count_);

155 }

156

157 }

Reference helios::engine::runtime::spawn::scheduling::SpawnScheduler::scheduledSpawnPlans_.

reset()

template <std::size_t N>

void helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::reset ()

inline noexcept virtual

Resets all rule states and the cursor to initial values.

Iterates through all rules and resets their state. Also resets the cursor to the first rule in the cycle.

Definition at line 223 of file CyclicSpawnScheduler.ixx.

223 void reset() noexcept override {

224 for (auto& ruleConfig : ringBuffer_) {

225

226 auto it = spawnRuleStates_.find(ruleConfig.spawnRule->spawnRuleId());

227 assert(it != spawnRuleStates_.end() && "Unexpected missing spawnRuleState");

228

229 ruleConfig.spawnRule->reset(it->second);

230

231 }

232 cursor_ = 0;

233 }

Private Member Attributes

count_

template <std::size_t N>

size_t helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::count_ = 0

Number of rules currently registered.

Definition at line 107 of file CyclicSpawnScheduler.ixx.

107 size_t count_ = 0;

cursor_

template <std::size_t N>

size_t helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::cursor_ = 0

Current position in the ring buffer.

Definition at line 102 of file CyclicSpawnScheduler.ixx.

102 size_t cursor_ = 0;

ringBuffer_

template <std::size_t N>

std::array<RuleConfig, N> helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::ringBuffer_ {}

Fixed-size ring buffer of rule configurations.

Definition at line 97 of file CyclicSpawnScheduler.ixx.

97 std::array<RuleConfig, N> ringBuffer_{};

ruleProcessor_

template <std::size_t N>

DefaultRuleProcessor helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::ruleProcessor_

Processor for evaluating individual rules.

Definition at line 120 of file CyclicSpawnScheduler.ixx.

120 DefaultRuleProcessor ruleProcessor_;

spawnRuleStates_

template <std::size_t N>

std::unordered_map< helios::engine::runtime::spawn::types::SpawnRuleId, helios::engine::runtime::spawn::policy::SpawnRuleState > helios::engine::runtime::spawn::scheduling::CyclicSpawnScheduler< N >::spawnRuleStates_

Map from spawn rule IDs to their runtime state.

Definition at line 115 of file CyclicSpawnScheduler.ixx.

115 > spawnRuleStates_;

---

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

• CyclicSpawnScheduler.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.