Skip to main content

PlayerDiedEvent Class

Event signalling that the player entity has died. More...

Declaration​

class helios::engine::mechanics::match::events::PlayerDiedEvent { ... }

Public Constructors Index​

PlayerDiedEvent (const EntityHandle source)

Constructs a PlayerDiedEvent. More...

Public Member Functions Index​

EntityHandlesource () const noexcept

Returns the handle of the deceased player entity. More...

Private Member Attributes Index​

EntityHandlesource_

Handle of the player entity that died. More...

Description​

Event signalling that the player entity has died.

Consumed by match-rule systems to trigger life loss, game-over transitions, or respawn logic.

Definition at line 26 of file PlayerDiedEvent.ixx.

Public Constructors​

PlayerDiedEvent()​

helios::engine::mechanics::match::events::PlayerDiedEvent::PlayerDiedEvent (const EntityHandle source)
 inline explicit

Constructs a PlayerDiedEvent.

Parameters
source

Handle of the deceased player entity.

Definition at line 40 of file PlayerDiedEvent.ixx.

40 explicit PlayerDiedEvent(const EntityHandle source) : source_(source) {}

Reference source.

Public Member Functions​

source()​

EntityHandle helios::engine::mechanics::match::events::PlayerDiedEvent::source ()
 inline nodiscard noexcept

Returns the handle of the deceased player entity.

Returns

The source EntityHandle.

Definition at line 47 of file PlayerDiedEvent.ixx.

47 [[nodiscard]] EntityHandle source() const noexcept {
48 return source_;
49 }

Referenced by PlayerDiedEvent.

Private Member Attributes​

source_​

EntityHandle helios::engine::mechanics::match::events::PlayerDiedEvent::source_

Handle of the player entity that died.

Definition at line 31 of file PlayerDiedEvent.ixx.

31 EntityHandle source_;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.