feat: Add ComponentTreeRoot.lifecycleEventsProcessed future #3308
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
erickzanardo
approved these changes
Sep 19, 2024
…e queue is processed
The big difference is that So, you could use the new future in tests, but you'd also have to kick off the process somehow. |
The |
spydon
reviewed
Sep 19, 2024
spydon
approved these changes
Sep 20, 2024
luanpotter
pushed a commit
that referenced
this pull request
Oct 15, 2024
Adds a future that will complete once all lifecycle events have been processed. If there are no lifecycle events to be processed (`hasLifecycleEvents` is `false`), then this future returns immediately. This is useful when you modify the component tree (by adding, moving or removing a component) and you want to make sure you react to the changed state, not the current one. Remember, methods like `Component.add` don't act immediately and instead enqueue their action. This action also cannot be awaited with something like `await world.add(something)` since that future completes _before_ the lifecycle events are processed. Example usage: ```dart player.inventory.addAll(enemy.inventory.children); await game.lifecycleEventsProcessed; updateUi(player.inventory); ```
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
Adds a future that will complete once all lifecycle events have been processed.
If there are no lifecycle events to be processed (
hasLifecycleEventsisfalse), then this future returns immediately.This is useful when you modify the component tree (by adding, moving or removing a component) and you want to make sure you react to the changed state, not the current one.
Remember, methods like
Component.adddon't act immediately and instead enqueue their action. This action also cannot be awaited with something likeawait world.add(something)since that future completes before the lifecycle events are processed.Example usage:
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues
Discussed here: https://discord.com/channels/509714518008528896/1285583996842934348