helios/engine/runtime/spawn/commands/README.md File

Namespaces Index

namespace	commands
	Commands for spawn and despawn operations. More...

File Listing

The file content with the documentation metadata removed is:

 # helios::engine::runtime::spawn::commands

 

 Commands for spawn and despawn operations.

 

 ## Overview

 

 This module contains command classes that represent spawn and despawn operations. These commands are emitted by systems and submitted directly to the SpawnCommandHandler during the command flush phase.

 

 ## Key Classes

 

 | Command | Purpose |

 |---------|---------|

 | `SpawnCommand` | Requests spawning of GameObjects from a pool with spawn context |

 | `DespawnCommand` | Requests despawning and pool return of a GameObject |

 | `ScheduledSpawnPlanCommand` | Executes a scheduled spawn plan from the SpawnScheduler |

 

 ## Architecture

 

 Commands follow the visitor pattern with dispatchers. Commands are submitted directly to the SpawnCommandHandler (typically SpawnManager):

 

 ```

 ┌─────────────────┐ ┌───────────────┐ ┌────────────────────┐

 │ SpawnSystem │────>│ CommandBuffer │────>│ Dispatcher │

 │ │ │ │ │ │

 │ - SpawnCommand │ │ flush() │ │ dispatchTyped() │

 │ - DespawnCommand│ │ │ │ │

 └─────────────────┘ └───────────────┘ └─────────┬──────────┘

  │

  ▼

  ┌────────────────────┐

  │ SpawnCommandHandler│

  │ (SpawnManager) │

  │ │

  │ submit(Command) │

  └────────────────────┘

 ```

 

 ## Usage

 

 ```cpp

 // Spawn command with context

 SpawnContext ctx;

 ctx.emitterContext = EmitterContext{position, velocity};

 commandBuffer.add<SpawnCommand>(bulletProfileId, ctx, 1);

 

 // Despawn command

 commandBuffer.add<DespawnCommand>(entityGuid, profileId);

 

 // Scheduled spawn plan command (from SpawnScheduler)

 commandBuffer.add<ScheduledSpawnPlanCommand>(std::move(scheduledPlan));

 ```

 

 ---

 

 <details>

 <summary>Doxygen</summary><p>

 @namespace helios::engine::runtime::spawn::commands

 @brief Commands for spawn and despawn operations.

 @details This namespace contains command classes for deferred spawn and despawn operations. Commands are submitted directly to SpawnCommandHandler during the command buffer flush phase via dispatchers.

 </p></details>

 

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.