EmitterContext.ixx File

Context data from the entity that triggered a spawn. More...

Included Headers

#include <helios.engine.ecs.EntityHandle> #include <helios.util> #include <helios.math>

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...

Classes Index

struct	EmitterContext
	Context data from the entity that triggered a spawn operation. More...

Description

Context data from the entity that triggered a spawn.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file EmitterContext.ixx

3 * @brief Context data from the entity that triggered a spawn.

4 */

5module;

6

7export module helios.engine.runtime.spawn.EmitterContext;

8

9import helios.math;

10import helios.util;

11

12import helios.engine.ecs.EntityHandle;

13

14export namespace helios::engine::runtime::spawn {

15

16 /**

17 * @brief Context data from the entity that triggered a spawn operation.

18 *

19 * @details EmitterContext captures the state of the emitting entity at the

20 * moment a spawn is requested. This allows spawned entities to inherit

21 * properties from their source (e.g., projectiles inheriting velocity).

22 *

23 * Example usage:

24 * ```cpp

25 * EmitterContext ctx{

26 * .position = spaceship->position(),

27 * .velocity = spaceship->velocity()

28 * };

29 * spawnContext.emitterContext = ctx;

30 * ```

31 *

32 * @see SpawnContext

33 * @see SpawnCommand

34 */

35 struct EmitterContext {

36

37 /**

38 * @brief World position of the emitting entity.

39 */

40 const helios::math::vec3f position;

41

42 /**

43 * @brief Velocity of the emitting entity at spawn time.

44 */

45 const helios::math::vec3f velocity;

46

47 /**

48 * @brief Handle of the entity that is responsible for this EmitterContext.

49 */

50 const helios::engine::ecs::EntityHandle source;

51

52 };

53

54

55}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.