HealthChangeContext.ixx File

Context data describing a health change applied to an entity. More...

Included Headers

#include <helios.engine.common.types.InteractionContext>

Namespaces Index

namespace	helios
namespace	engine
	Main engine module aggregating core infrastructure and game systems. More...
namespace	mechanics
	High-level gameplay systems and components for game logic. More...
namespace	health
	Health management system for game entities. More...
namespace	types
	Type definitions for the health system. More...

Classes Index

struct	HealthChangeContext
	Describes a health modification applied to an entity. More...

Description

Context data describing a health change applied to an entity.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file HealthChangeContext.ixx

3 * @brief Context data describing a health change applied to an entity.

4 */

5

6export module helios.engine.mechanics.health.types.HealthChangeContext;

7

8

9import helios.engine.common.types.InteractionContext;

10

11using namespace helios::engine::common::types;

12

13export namespace helios::engine::mechanics::health::types {

14

15 /**

16 * @brief Describes a health modification applied to an entity.

17 *

18 * Combines the interaction context (target, instigator, causer, contact

19 * point) with a signed delta value. A negative delta represents damage,

20 * a positive delta represents healing.

21 *

22 * @see InteractionContext

23 * @see HealthManager

24 */

25 struct HealthChangeContext {

26

27 /**

28 * @brief The interaction that caused the health change.

29 */

30 InteractionContext interactionContext{};

31

32 /**

33 * @brief Signed health delta (negative = damage, positive = healing).

34 */

35 float delta{};

36

37 };

38

39}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.