TimerControlContext.ixx File

Context information for state transitions. More...

Included Headers

#include <helios.engine.mechanics.timing.types.GameTimerId> #include <helios.engine.mechanics.timing.types.TimerState>

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	types
	Core type definitions for the timing module. More...

Classes Index

struct	TimerControlContext
	Context describing a requested timer state transition. More...

Description

Context information for state transitions.

File Listing

The file content with the documentation metadata removed is:

1/**

2 * @file TimerControlContext.ixx

3 * @brief Context information for state transitions.

4 */

5module;

6

7

8export module helios.engine.mechanics.timing.types.TimerControlContext;

9

10import helios.engine.mechanics.timing.types.TimerState;

11import helios.engine.mechanics.timing.types.GameTimerId;

12

13using namespace helios::engine::mechanics::timing::types;

14

15export namespace helios::engine::mechanics::timing::types {

16

17 /**

18 * @brief Context describing a requested timer state transition.

19 *

20 * Carries the target TimerState and the GameTimerId of the timer

21 * to be controlled.

22 *

23 * @see TimerControlCommand

24 * @see TimerManager

25 */

26 struct TimerControlContext {

27

28 /**

29 * @brief The id of the timer to control.

30 */

31 const GameTimerId gameTimerId;

32

33 /**

34 * @brief The target state for the timer.

35 */

36 const TimerState timerState;

37

38 /**

39 * @brief Indicates whether the timer's elapsed seconds should be reset to 0 before applying

40 * the new state.

41 */

42 const bool resetElapsed = false;

43 };

44

45}

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.