Skip to main content

SpawnConfig Class

Fluent configuration for spawn system integration. More...

Declaration​

class helios::engine::builder::gameObject::builders::configs::SpawnConfig { ... }

Public Constructors Index​

SpawnConfig (helios::engine::ecs::GameObject gameObject)

Constructs a SpawnConfig. More...

Public Member Functions Index​

SpawnConfig &useSpawnProfile ()

Marks the entity as spawned by a spawn profile. More...

SpawnConfig &trackEmitter ()

Tracks the emitter that created this entity. More...

Private Member Attributes Index​

helios::engine::ecs::GameObjectgameObject_

Non-owning pointer to the target GameObject. More...

Description​

Fluent configuration for spawn system integration.

Provides methods for connecting GameObjects to the spawn system and spawn profiles.

Definition at line 21 of file SpawnConfig.ixx.

Public Constructors​

SpawnConfig()​

helios::engine::builder::gameObject::builders::configs::SpawnConfig::SpawnConfig (helios::engine::ecs::GameObject gameObject)
 inline explicit

Constructs a SpawnConfig.

Parameters
<a href="/docs/helios/namespaces/helios/engine/builder/gameobject">gameObject</a>

Target GameObject to configure.

Definition at line 35 of file SpawnConfig.ixx.

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

Referenced by trackEmitter and useSpawnProfile.

Public Member Functions​

trackEmitter()​

SpawnConfig & helios::engine::builder::gameObject::builders::configs::SpawnConfig::trackEmitter ()
 inline

Tracks the emitter that created this entity.

Adds EmittedByComponent which stores the handle of the entity that emitted/spawned this entity (e.g., player → projectile).

Returns

Reference to this config for chaining.

Definition at line 59 of file SpawnConfig.ixx.

59 SpawnConfig& trackEmitter() {
60 gameObject_.add<helios::engine::mechanics::spawn::components::EmittedByComponent>();
61
62 return *this;
63 }

Reference SpawnConfig.

useSpawnProfile()​

SpawnConfig & helios::engine::builder::gameObject::builders::configs::SpawnConfig::useSpawnProfile ()
 inline

Marks the entity as spawned by a spawn profile.

Adds SpawnedByProfileComponent which tracks the spawn profile that created this entity.

Returns

Reference to this config for chaining.

Definition at line 45 of file SpawnConfig.ixx.

45 SpawnConfig& useSpawnProfile() {
46 gameObject_.add<helios::engine::mechanics::spawn::components::SpawnedByProfileComponent>();
47
48 return *this;
49 }

Reference SpawnConfig.

Private Member Attributes​

gameObject_​

helios::engine::ecs::GameObject helios::engine::builder::gameObject::builders::configs::SpawnConfig::gameObject_

Non-owning pointer to the target GameObject.

Definition at line 26 of file SpawnConfig.ixx.

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

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.