feat!: Rename Game.paused to Game.isPaused - #3992
Open
spydon wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Renames the
pausedgetter and setter onGametoisPaused, so that it follows the sameis-prefix convention as the other boolean properties in Flame (isMounted,isLoaded,isAttached,Effect.isPaused, etc.).The behavior is completely unchanged, only the name is different. The private backing field was
renamed from
_pausedto_isPausedaccordingly, and the dartdocs on the getter/setter werecleaned up (the getter doc previously read "Returns is the engine if currently paused or running").
All usages were updated across
flame(GameRenderBox,GameWidget,FlameGame, the devtoolsgame loop connector),
flame_console(pause/resume commands), the examples and the docs. Thepausedkey used by the devtools service extension protocol is left as-is since it is a wireformat, not a public Dart API.
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Migration instructions
Replace every usage of
game.pausedwithgame.isPaused:Related Issues
Closes #3991