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 111 of file DefaultGameStateTransitionRules.ixx.

111 [[nodiscard]] static std::span<const StateTransitionRule<GameState>> rules() {
112 return rules_;
113 }

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>::BootRequest,
42 GameState::Booted
43 ),
44
45 StateTransitionRule<GameState>(
46 GameState::Booted,
47 StateTransitionIdType<GameState>::TitleRequest,
48 GameState::Title
49 ),
50
51 StateTransitionRule<GameState>(
52 GameState::Title,
53 GameStateTransitionId::ReadyMatchRequest,
54 GameState::MatchReady
55 ),
56
57 StateTransitionRule<GameState>(
58 GameState::MatchReady,
59 GameStateTransitionId::StartMatchRequest,
60 GameState::Running
61 ),
62
63 StateTransitionRule<GameState>(
64
65 GameState::Running,
66 GameStateTransitionId::TogglePause,
67 GameState::Paused
68 ),
69
70 StateTransitionRule<GameState>(
71
72 GameState::Paused,
73 GameStateTransitionId::TogglePause,
74 GameState::Running
75 ),
76
77
78 StateTransitionRule<GameState>(
79 GameState::Paused,
80 GameStateTransitionId::TitleRequest,
81 GameState::Title
82 ),
83
84 StateTransitionRule<GameState>(
85 GameState::Paused,
86 GameStateTransitionId::ReadyMatchRequest,
87 GameState::MatchReady
88 ),
89
90 StateTransitionRule<GameState>(
91 GameState::Running,
92 GameStateTransitionId::TitleRequest,
93 GameState::Title
94 ),
95
96 StateTransitionRule<GameState>(
97 GameState::Running,
98 GameStateTransitionId::ReadyMatchRequest,
99 GameState::MatchReady
100 )
101
102 };

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.