ScorePoolSnapshot.ixx File

Immutable snapshot of a score pool's state. More...

Included Headers

#include <helios.engine.mechanics.scoring.types> #include <helios.core>

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	scoring
	Score management and tracking system for game mechanics. More...

Classes Index

struct	ScorePoolSnapshot
	Immutable snapshot of a ScorePool's state. More...

Description

Immutable snapshot of a score pool's state.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file ScorePoolSnapshot.ixx

3 * @brief Immutable snapshot of a score pool's state.

4 */

5module;

6

7export module helios.engine.mechanics.scoring.ScorePoolSnapshot;

8

9import helios.core;

10import helios.engine.mechanics.scoring.types;

11

12

13

14export namespace helios::engine::mechanics::scoring {

15

16

17 /**

18 * @brief Immutable snapshot of a ScorePool's state.

19 *

20 * @details Captures the pool ID, total score, and revision at a specific

21 * point in time. Useful for passing score data to UI or other systems

22 * without exposing the mutable ScorePool.

23 *

24 * The revision field allows observers to detect changes by comparing

25 * snapshots without needing to track individual score values.

26 */

27 struct ScorePoolSnapshot {

28

29 /**

30 * @brief Unique identifier of the score pool.

31 */

32 helios::engine::mechanics::scoring::types::ScorePoolId scorePoolId{helios::core::types::no_init};

33

34 /**

35 * @brief The total score value at the time of the snapshot.

36 */

37 double totalScore;

38

39 /**

40 * @brief The revision number for change detection.

41 *

42 * @details Incremented whenever a score in the pool changes.

43 * Compare revisions to detect updates without polling values.

44 */

45 helios::engine::mechanics::scoring::types::ScorePoolRevision revision;

46 };

47

48}

49

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.