Skip to main content

ScorePoolConfig Class

Fluent configuration for ScorePoolComponent setup. More...

Declaration​

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

Public Constructors Index​

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

Constructs a ScorePoolConfig and adds ScorePoolComponent. More...

Public Member Functions Index​

ScorePoolConfig &poolId (const helios::engine::mechanics::scoring::types::ScorePoolId scorePoolId)

Sets the score pool ID for this entity. More...

Private Member Attributes Index​

helios::engine::ecs::GameObjectgameObject_

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

Description​

Fluent configuration for ScorePoolComponent setup.

Automatically adds ScorePoolComponent and provides methods for setting the associated score pool ID.

Definition at line 24 of file ScorePoolConfig.ixx.

Public Constructors​

ScorePoolConfig()​

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

Constructs a ScorePoolConfig and adds ScorePoolComponent.

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

Target GameObject to configure.

Definition at line 38 of file ScorePoolConfig.ixx.

38 explicit ScorePoolConfig(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {
39 gameObject_.getOrAdd<helios::engine::mechanics::scoring::components::ScorePoolComponent>();
40 }

Referenced by poolId.

Public Member Functions​

poolId()​

ScorePoolConfig & helios::engine::builder::gameObject::builders::configs::ScorePoolConfig::poolId (const helios::engine::mechanics::scoring::types::ScorePoolId scorePoolId)
 inline

Sets the score pool ID for this entity.

Parameters
scorePoolId

The ID of the score pool to associate with.

Returns

Reference to this config for chaining.

Definition at line 49 of file ScorePoolConfig.ixx.

49 ScorePoolConfig& poolId(const helios::engine::mechanics::scoring::types::ScorePoolId scorePoolId) {
50 gameObject_.get<helios::engine::mechanics::scoring::components::ScorePoolComponent>()
51 ->setScorePoolId(scorePoolId);
52 return *this;
53 }

Reference ScorePoolConfig.

Private Member Attributes​

gameObject_​

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

Non-owning pointer to the target GameObject.

Definition at line 29 of file ScorePoolConfig.ixx.

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