SpawnPlanCommandExecutedEvent.ixx File

Event indicating a spawn plan has been executed. More...

Included Headers

#include <helios.engine.core.data.SpawnRuleId>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	runtime
	Runtime infrastructure for game execution and lifecycle orchestration. More...
namespace	spawn
	Entity spawning infrastructure for the helios engine. More...
namespace	events
	Spawn-related events for cross-frame communication. More...

Classes Index

struct	SpawnPlanCommandExecutedEvent
	Event indicating a spawn plan command has been executed. More...

Description

Event indicating a spawn plan has been executed.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file SpawnPlanCommandExecutedEvent.ixx

3 * @brief Event indicating a spawn plan has been executed.

4 */

5module;

6

7export module helios.engine.runtime.spawn.events.SpawnPlanCommandExecutedEvent;

8

9import helios.engine.core.data.SpawnRuleId;

10

11export namespace helios::engine::runtime::spawn::events {

12

13 /**

14 * @brief Event indicating a spawn plan command has been executed.

15 *

16 * @details SpawnPlanCommandExecutedEvent is pushed to the frame event bus

17 * after a spawn command completes. The GameObjectSpawnSystem reads these

18 * events in the next frame to commit spawn counts to the SpawnScheduler.

19 *

20 * @see SpawnScheduler::commit

21 * @see GameObjectSpawnSystem

22 */

23 struct SpawnPlanCommandExecutedEvent {

24

25 /**

26 * @brief The rule that triggered the spawn.

27 */

28 const helios::engine::core::data::SpawnRuleId spawnRuleId;

29

30 /**

31 * @brief Number of entities actually spawned.

32 */

33 const size_t spawnCount;

34

35 };

36

37}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.