SpawnConfig.ixx File

Configuration for spawn system integration. More...

Included Headers

#include <helios.engine.mechanics.spawn.components> #include <helios.engine.ecs.GameObject>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	builder
	Fluent builder pattern for constructing GameObjects. More...
namespace	gameObject
	Factory and prototype classes for GameObject construction. More...
namespace	builders
	Domain-specific builders for configuring different aspects of GameObjects. More...
namespace	configs
	Fine-grained configuration classes for component setup. More...

Classes Index

class	SpawnConfig
	Fluent configuration for spawn system integration. More...

Description

Configuration for spawn system integration.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file SpawnConfig.ixx

3 * @brief Configuration for spawn system integration.

4 */

5module;

6

7export module helios.engine.builder.gameObject.builders.configs.SpawnConfig;

8

9import helios.engine.ecs.GameObject;

10

11import helios.engine.mechanics.spawn.components;

12

13export namespace helios::engine::builder::gameObject::builders::configs {

14

15 /**

16 * @brief Fluent configuration for spawn system integration.

17 *

18 * Provides methods for connecting GameObjects to the spawn

19 * system and spawn profiles.

20 */

21 class SpawnConfig {

22

23 /**

24 * @brief Non-owning pointer to the target GameObject.

25 */

26 helios::engine::ecs::GameObject gameObject_;

27

28 public:

29

30 /**

31 * @brief Constructs a SpawnConfig.

32 *

33 * @param gameObject Target GameObject to configure.

34 */

35 explicit SpawnConfig(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {}

36

37 /**

38 * @brief Marks the entity as spawned by a spawn profile.

39 *

40 * Adds SpawnedByProfileComponent which tracks the spawn

41 * profile that created this entity.

42 *

43 * @return Reference to this config for chaining.

44 */

45 SpawnConfig& useSpawnProfile() {

46 gameObject_.add<helios::engine::mechanics::spawn::components::SpawnedByProfileComponent>();

47

48 return *this;

49 }

50

51 /**

52 * @brief Tracks the emitter that created this entity.

53 *

54 * Adds EmittedByComponent which stores the handle of the entity

55 * that emitted/spawned this entity (e.g., player → projectile).

56 *

57 * @return Reference to this config for chaining.

58 */

59 SpawnConfig& trackEmitter() {

60 gameObject_.add<helios::engine::mechanics::spawn::components::EmittedByComponent>();

61

62 return *this;

63 }

64

65

66 };

67

68}

69

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.