refactor: Component rebalancing is now performed via a global queue #2352
Conversation
This file contains 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
spydon
approved these changes
Feb 20, 2023
| } | ||
| } | ||
|
|
||
| /// Usually this is not something that the user would want to call since the | ||
| /// component list isn't re-ordered when it is called. | ||
| /// See FlameGame.changePriority instead. | ||
| @Deprecated('Will be removed in 1.8.0. Use priority setter instead.') |
There was a problem hiding this comment.
🥳
Nice, so much cleaner without this!
luanpotter
reviewed
Feb 26, 2023
| } | ||
| } | ||
| import '../custom_component.dart'; | ||
| // ignore_for_file: deprecated_member_use_from_same_package |
There was a problem hiding this comment.
what does it use that is deprecated?
There was a problem hiding this comment.
I believe it's mostly calls like game.children.changePriority(firstComponent, 11);. Some time later we will refactor the test file to use more straightforward firstComponent.priority = 11;, but for now I wanted to leave everything mostly as-is to ensure that the change is non-breaking.
# for free
to join this conversation on GitHub.
Already have an account?
# 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
This PR ensures that all component rebalancing operations are resolved from a single location, after the
updatestage but before therenderstage (thus, components may get reordered during the update, and these changes will go into effect during the rendering step on the same game tick).This also fixes the problem where the child changing the priorities of its parent would cause a ConcurrentModificationError.
A number of methods that were used to handle rebalancing are now marked as deprecated. From the user's perspective, the only API they should be using is the
.prioritysetter.Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues
Closes #2263