Skip to main content

SpawnPlanCommandExecutedEvent Struct

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

Declaration​

struct helios::engine::runtime::spawn::events::SpawnPlanCommandExecutedEvent { ... }

Public Member Attributes Index​

const helios::engine::core::data::SpawnRuleIdspawnRuleId

The rule that triggered the spawn. More...

const size_tspawnCount

Number of entities actually spawned. More...

Description​

Event indicating a spawn plan command has been executed.

SpawnPlanCommandExecutedEvent is pushed to the frame event bus after a spawn command completes. The GameObjectSpawnSystem reads these events in the next frame to commit spawn counts to the SpawnScheduler.

See Also

SpawnScheduler::commit

See Also

GameObjectSpawnSystem

Definition at line 23 of file SpawnPlanCommandExecutedEvent.ixx.

Public Member Attributes​

spawnCount​

const size_t helios::engine::runtime::spawn::events::SpawnPlanCommandExecutedEvent::spawnCount

Number of entities actually spawned.

Definition at line 33 of file SpawnPlanCommandExecutedEvent.ixx.

33 const size_t spawnCount;

spawnRuleId​

const helios::engine::core::data::SpawnRuleId helios::engine::runtime::spawn::events::SpawnPlanCommandExecutedEvent::spawnRuleId

The rule that triggered the spawn.

Definition at line 28 of file SpawnPlanCommandExecutedEvent.ixx.

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

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.