Skip to main content

HealthBuilder Class

Builder for configuring health-related components. More...

Declaration​

class helios::engine::builder::gameObject::builders::HealthBuilder { ... }

Public Constructors Index​

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

Constructs a HealthBuilder for the given GameObject. More...

Public Member Functions Index​

helios::engine::builder::gameObject::builders::configs::HealthConfighealth () const

Returns a config object for HealthComponent. More...

Private Member Attributes Index​

helios::engine::ecs::GameObjectgameObject_

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

Description​

Builder for configuring health-related components.

Provides methods to create config objects for health components such as HealthComponent.

Definition at line 20 of file HealthBuilder.ixx.

Public Constructors​

HealthBuilder()​

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

Constructs a HealthBuilder for the given GameObject.

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

The target GameObject to configure.

Definition at line 34 of file HealthBuilder.ixx.

34 explicit HealthBuilder(helios::engine::ecs::GameObject gameObject) : gameObject_(gameObject) {}

Public Member Functions​

health()​

helios::engine::builder::gameObject::builders::configs::HealthConfig helios::engine::builder::gameObject::builders::HealthBuilder::health ()
 inline nodiscard

Returns a config object for HealthComponent.

Returns

HealthConfig for fluent configuration.

Definition at line 41 of file HealthBuilder.ixx.

41 [[nodiscard]] helios::engine::builder::gameObject::builders::configs::HealthConfig health() const {
42 return helios::engine::builder::gameObject::builders::configs::HealthConfig{gameObject_};
43 }

Private Member Attributes​

gameObject_​

helios::engine::ecs::GameObject helios::engine::builder::gameObject::builders::HealthBuilder::gameObject_

Non-owning pointer to the target GameObject.

Definition at line 25 of file HealthBuilder.ixx.

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