Skip to content

Latest commit

 

History

History
15 lines (13 loc) · 1.9 KB

HowPartsWork.md

File metadata and controls

15 lines (13 loc) · 1.9 KB

How Parts Work

This page features snippets of extra documentation on key pieces of the plugin. It was previously included in the README.

  • app_config.tscn is set as the first autoload. It calls app_settings.gd to load all the configuration settings from the config file (if it exists) through config.gd.
  • scene_loader.tscn is set as the second autoload. It can load scenes in the background or with a loading screen (loading_screen.tscn by default).
  • opening.tscn is a simple scene for fading in/out a few images at the start of the game. It then loads the next scene (main_menu.tscn).
  • main_menu.tscn is where a player can start the game, change settings, watch credits, or quit. It can link to the path of a game scene to play, and the packed scene of an options menu to use.
  • option_control.tscn and its inherited scenes are used for most configurable options in the menus. They work with config.gd to keep settings persistent between runs.
  • credits.tscn reads from ATTRIBUTION.md to automatically generate the content for it's scrolling text label.
  • The UISoundController node automatically attaches sounds to buttons, tab bars, sliders, and line edits in the scene. project_ui_sound_controller.tscn is an autload used to apply UI sounds project-wide.
  • project_music_controller.tscn is an autoload that keeps music playing between scenes. It detects music stream players as they are added to the scene tree, reparents them to itself, and blends the tracks.
  • The PauseMenuController node loads the pause_menu.tscn when triggering ui-cancel.
  • pause_menu.tscn is a type of OverlaidMenu with the pauses_game flag set to true. It will store the previously focused UI element, and return focus to it when closed.
  • capture_focus.gd is attached to container nodes throughout the UI. It focuses onto UI elements when they are shown, allowing for easier navigation without a mouse.