UpdateScoreCommand.ixx File

Command for updating scores in a score pool. More...

Included Headers

#include <cassert> #include <memory> #include <helios.engine.mechanics.scoring.types>

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...
namespace	commands
	Score update commands for the command buffer. More...

Classes Index

class	UpdateScoreCommand
	Command that carries score update information. More...

Description

Command for updating scores in a score pool.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file UpdateScoreCommand.ixx

3 * @brief Command for updating scores in a score pool.

4 */

5module;

6

7#include <cassert>

8#include <memory>

9

10export module helios.engine.mechanics.scoring.commands.UpdateScoreCommand;

11

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

13

14

15

16export namespace helios::engine::mechanics::scoring::commands {

17

18 /**

19 * @brief Command that carries score update information.

20 *

21 * Contains a ScoreValueContext with the score type, pool ID, and value.

22 */

23 class UpdateScoreCommand {

24

25 /**

26 * @brief The score context containing type, pool, and value.

27 */

28 helios::engine::mechanics::scoring::types::ScoreValueContext scoreContext_;

29

30 public:

31

32 /**

33 * @brief Constructs an UpdateScoreCommand with the given score context.

34 *

35 * @param scoreContext The context containing score update data.

36 */

37 template<typename... Args>

38 explicit UpdateScoreCommand(

39 helios::engine::mechanics::scoring::types::ScoreValueContext scoreContext

40 ) : scoreContext_(std::move(scoreContext)) { }

41

42 /**

43 * @brief Returns the score context (lvalue reference).

44 *

45 * @return Const reference to the score context.

46 */

47 [[nodiscard]] const helios::engine::mechanics::scoring::types::ScoreValueContext& scoreContext() const & noexcept {

48 return scoreContext_;

49 }

50

51 /**

52 * @brief Returns the score context (rvalue reference).

53 *

54 * @return The score context by move.

55 */

56 [[nodiscard]] helios::engine::mechanics::scoring::types::ScoreValueContext scoreContext() && noexcept {

57 return std::move(scoreContext_);

58 }

59

60

61 };

62

63

64}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.