Improve documentation/comments for game manager interface that menu calls #12
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the documentation and naming of the GameManager interface methods to better reflect their actual usage patterns in the codebase.
Changes Made
Method Renaming and Documentation
reset_game()
tosetup_game()
to better reflect its purposesetup_game()
: Sets up initial game state when starting a new game from the main menurestart_level()
: Restarts the current level from the beginning when restarting from the pause menuCode Updates
scripts/main.gd
fromGameManager.reset_game()
toGameManager.setup_game()
Context
The original method name
reset_game()
was misleading as it's specifically called when starting a new game, not when resetting during gameplay. The new namesetup_game()
more accurately describes its role in the game flow.Usage patterns confirmed in the codebase:
setup_game()
is called in_on_game_menu_start_game()
when starting a new gamerestart_level()
is called in_on_game_menu_restart_game()
when restarting from the pause menuFixes #4.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.