Skip to main content

SpawnPlanCursor.ixx File

Cursor tracking progress within a spawn batch. More...

Namespaces Index​

namespacehelios
namespaceengine

Main engine module aggregating core infrastructure and game systems. More...

namespaceruntime

Runtime infrastructure for game execution and lifecycle orchestration. More...

namespacespawn

Entity spawning infrastructure for the helios engine. More...

Classes Index​

structSpawnPlanCursor

Tracks the current position within a spawn batch. More...

Description​

Cursor tracking progress within a spawn batch.

File Listing​

The file content with the documentation metadata removed is:

1/**
2 * @file SpawnPlanCursor.ixx
3 * @brief Cursor tracking progress within a spawn batch.
4 */
5module;
6
7export module helios.engine.runtime.spawn.SpawnPlanCursor;
8
9export namespace helios::engine::runtime::spawn {
10
11 /**
12 * @brief Tracks the current position within a spawn batch.
13 *
14 * @details SpawnPlanCursor provides context to SpawnPlacer and SpawnInitializer
15 * about where the current spawn is within its batch. This enables behaviors
16 * like distributing spawns in a formation or applying sequential variations.
17 *
18 * Example:
19 * ```cpp
20 * // Spawning 5 enemies in a row
21 * for (size_t i = 0; i < spawnCount; ++i) {
22 * SpawnPlanCursor cursor{.spawnCount = spawnCount, .position = i};
23 * auto pos = placer->getPosition(guid, bounds, cursor, ctx);
24 * }
25 * ```
26 *
27 * @see SpawnPlacer
28 * @see SpawnInitializer
29 */
30 struct SpawnPlanCursor {
31
32 /**
33 * @brief Total number of entities to spawn in this batch.
34 */
35 const size_t spawnCount;
36
37 /**
38 * @brief Zero-based index of the current spawn within the batch.
39 */
40 const size_t position;
41
42 };
43
44}

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.