Skip to main content

HealthChangedEvent Class

Event carrying details of a health modification. More...

Declaration​

class helios::engine::mechanics::health::events::HealthChangedEvent { ... }

Public Constructors Index​

HealthChangedEvent (const helios::engine::mechanics::health::types::HealthChangeContext &HealthChangeContext)

Constructs a HealthChangedEvent. More...

Public Member Functions Index​

helios::engine::mechanics::health::types::HealthChangeContextHealthChangeContext () const noexcept

Returns the health update context. More...

Private Member Attributes Index​

helios::engine::mechanics::health::types::HealthChangeContexthealthChangeContext_

Context describing the health change. More...

Description​

Event carrying details of a health modification.

Emitted by the health system whenever an entity's health value changes, allowing observers to react (e.g. UI updates, VFX).

Definition at line 26 of file HealthChangedEvent.ixx.

Public Constructors​

HealthChangedEvent()​

helios::engine::mechanics::health::events::HealthChangedEvent::HealthChangedEvent (const helios::engine::mechanics::health::types::HealthChangeContext & HealthChangeContext)
 inline explicit

Constructs a HealthChangedEvent.

Parameters
HealthChangeContext

Context describing the change.

Definition at line 40 of file HealthChangedEvent.ixx.

40 explicit HealthChangedEvent(
41 const helios::engine::mechanics::health::types::HealthChangeContext& HealthChangeContext
42 ) : healthChangeContext_(HealthChangeContext) {}

Reference HealthChangeContext.

Public Member Functions​

HealthChangeContext()​

helios::engine::mechanics::health::types::HealthChangeContext helios::engine::mechanics::health::events::HealthChangedEvent::HealthChangeContext ()
 inline nodiscard noexcept

Returns the health update context.

Returns

The HealthChangeContext for this event.

Definition at line 49 of file HealthChangedEvent.ixx.

49 [[nodiscard]] helios::engine::mechanics::health::types::HealthChangeContext HealthChangeContext() const noexcept {
50 return healthChangeContext_;
51 }

Referenced by HealthChangedEvent.

Private Member Attributes​

healthChangeContext_​

helios::engine::mechanics::health::types::HealthChangeContext helios::engine::mechanics::health::events::HealthChangedEvent::healthChangeContext_

Context describing the health change.

Definition at line 31 of file HealthChangedEvent.ixx.

31 helios::engine::mechanics::health::types::HealthChangeContext healthChangeContext_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.