Skip to main content

DefaultGameStateTransitionRules Class

Provides the default set of game state transition rules. More...

Declaration​

class helios::engine::mechanics::gamestate::rules::DefaultGameStateTransitionRules { ... }

Public Static Functions Index​

static std::span< const StateTransitionRule< GameState > >rules ()

Returns the default transition rules. More...

Private Static Attributes Index​

static constexpr StateTransitionRule< GameState >rules_[]

Description​

Provides the default set of game state transition rules.

Defines standard transitions such as:

  • Undefined -> Title (on TitleRequested)
  • Title -> Running (on StartRequested)
  • Running <-> Paused (on TogglePause)
  • Paused -> Running (on RestartRequested)
  • Paused -> Title (on QuitGameRequested)

Definition at line 35 of file DefaultGameStateTransitionRules.ixx.

Public Static Functions​

rules()​

std::span< const StateTransitionRule< GameState > > helios::engine::mechanics::gamestate::rules::DefaultGameStateTransitionRules::rules ()
 inline nodiscard static

Returns the default transition rules.

Returns

A span of the predefined transition rules.

Definition at line 108 of file DefaultGameStateTransitionRules.ixx.

108 [[nodiscard]] static std::span<const StateTransitionRule<GameState>> rules() {
109 return rules_;
110 }

Referenced by helios::engine::bootstrap::makeGameWorld.

Private Static Attributes​

rules_​

StateTransitionRule<GameState> helios::engine::mechanics::gamestate::rules::DefaultGameStateTransitionRules::rules_[]
 constexpr static

Definition at line 37 of file DefaultGameStateTransitionRules.ixx.

37 static constexpr StateTransitionRule<GameState> rules_[] = {
38
39 StateTransitionRule<GameState>(
40 GameState::Undefined,
41 StateTransitionIdType<GameState>::StartRequested,
42 GameState::Start
43 ),
44
45 StateTransitionRule<GameState>(
46 GameState::Start,
47 StateTransitionIdType<GameState>::TitleRequested,
48 GameState::Title
49 ),
50 StateTransitionRule<GameState>(
51
52 GameState::Title,
53 GameStateTransitionId::StartRequested,
54 GameState::Running
55 ),
56
57 StateTransitionRule<GameState>(
58
59 GameState::Running,
60 GameStateTransitionId::TogglePause,
61 GameState::Paused
62 ),
63
64 StateTransitionRule<GameState>(
65
66 GameState::Paused,
67 GameStateTransitionId::TogglePause,
68 GameState::Running
69 ),
70
71 StateTransitionRule<GameState>(
72
73 GameState::Paused,
74 GameStateTransitionId::RestartRequested,
75 GameState::Running
76 ),
77
78 StateTransitionRule<GameState>(
79
80 GameState::Running,
81 GameStateTransitionId::RestartRequested,
82 GameState::Running
83 ),
84
85 StateTransitionRule<GameState>(
86
87 GameState::Paused,
88 GameStateTransitionId::RestartRequested,
89 GameState::Running
90 ),
91
92 StateTransitionRule<GameState>(
93
94 GameState::Running,
95 GameStateTransitionId::TitleRequested,
96 GameState::Title
97 )
98
99 };

The documentation for this class was generated from the following file:

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.