TimerControlCommand.ixx File

Command for controlling game timer state transitions. More...

Included Headers

#include <cassert> #include <memory> #include <helios.engine.mechanics.timing.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	timing
	Game timer management system. More...
namespace	commands
	Timer control commands for the command buffer. More...

Classes Index

class	TimerControlCommand
	Command that carries a TimerControlContext to the timer subsystem. More...

Description

Command for controlling game timer state transitions.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file TimerControlCommand.ixx

3 * @brief Command for controlling game timer state transitions.

4 */

5module;

6

7#include <cassert>

8#include <memory>

9

10export module helios.engine.mechanics.timing.commands.TimerControlCommand;

11

12

13import helios.engine.mechanics.timing.types;

14

15

16

17export namespace helios::engine::mechanics::timing::commands {

18

19 /**

20 * @brief Command that carries a TimerControlContext to the timer subsystem.

21 *

22 * TimerControlCommand is dispatched through the command buffer to request

23 * timer state transitions (start, pause, stop).

24 *

25 * @see helios::engine::mechanics::timing::types::TimerControlContext

26 * @see helios::engine::mechanics::timing::TimerCommandDispatcher

27 */

28 class TimerControlCommand {

29

30 /**

31 * @brief The timer control context describing the requested state transition.

32 */

33 helios::engine::mechanics::timing::types::TimerControlContext timerContext_;

34

35 public:

36

37 /**

38 * @brief Constructs a TimerControlCommand with the given context.

39 *

40 * @param timerContext The context describing which timer to control and the target state.

41 */

42 explicit TimerControlCommand(

43 helios::engine::mechanics::timing::types::TimerControlContext timerContext

44 ) : timerContext_(std::move(timerContext)) { }

45

46

47 /**

48 * @brief Returns the timer control context.

49 *

50 * @return The TimerControlContext describing the requested state transition.

51 */

52 [[nodiscard]] helios::engine::mechanics::timing::types::TimerControlContext timerControlContext() const noexcept {

53 return timerContext_;

54 }

55

56

57 };

58

59

60}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.