2.2 KiB
2.2 KiB
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.tscnis set as the first autoload. It callsapp_settings.gdto load all the configuration settings from the config file (if it exists) throughconfig.gd.scene_loader.tscnis set as the second autoload. It can load scenes in the background or with a loading screen (loading_screen.tscnby default).opening.tscnis 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.tscnis 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.tscnand its inherited scenes are used for most configurable options in the menus. They work withconfig.gdto keep settings persistent between runs.credits.tscnreads fromATTRIBUTION.mdto automatically generate the content for it's scrolling text label.- The
UISoundControllernode automatically attaches sounds to buttons, tab bars, sliders, and line edits in the scene.project_ui_sound_controller.tscnis an autload used to apply UI sounds project-wide. project_music_controller.tscnis 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
PauseMenuControllercan be set to loadpause_menu.tscnwhen triggeringui-cancel. pause_menu.tscnis a type ofOverlaidMenuwith thepauses_gameflag set to true. It will store the previously focused UI element, and return focus to it when closed.capture_focus.gdis attached to container nodes throughout the UI. It focuses onto UI elements when they are shown, allowing for easier navigation without a mouse.game_ui.tscnis a demo game scene that displays recognized action inputs, and features thePauseMenuControllernode, theLevelListLoadernode to load levels from a directory, andLevelListManagerto manage level progress and show menus in case of a win or loss.