Module game_library::state

source ·
Expand description

The states used in the game.

These are a collection of states that the game can be in. They are used to control the flow of the game, and to determine what systems are active at any given time.

State Flow

  1. AppState::Startup - The game is starting up. The splash screen is shown and data is loaded from game_data and assets like fonts, sprites and tilesets are loaded.
  2. AppState::MainMenu - The main menu is shown. a. Click “Start” to begin playing -> AppState::InGame and [GameState::Loading] are activated. b. Click “Settings” to open the settings menu -> [AppState::SettingsMenu] and [MenuState::Main] c. Click “Quit” to exit the game -> AppState::CleanUp (which will do any necessary saving and then exit)
  3. more stuff

Enums

  • AppState
    The state of the game (broadly)
  • Game
    States of the game itself.
  • Overlay
    A UI overlay state. This allows settings to be shown, or other overlays.
  • Save
    The state of the save system.
  • Settings
    The menu states.