docs: Updated docs for gesture detector lifecycle #2650
Closed
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
munsterlander
changed the title
spydon
reviewed
Aug 14, 2023
| when the first draggable component is added to the game, `FlameGame` must | ||
| temporarily remove itself and run the `GestureDetectorBuilder` which will add a | ||
| gesture detector as the first child to `FlameGame`, and then re-add itelf. As | ||
| such, `FlameGame`'s `onRemove` event will be triggered. A simple boolean flag |
There was a problem hiding this comment.
I think these probably should be two notes, or it's own section, now the next is in the middle of the previous note and reads a bit strange.
There was a problem hiding this comment.
I thought about that, but thought two notes at the top looked weird. I was wanting to ride on the note about the new API, but I can put it down below.
6 tasks
spydon
pushed a commit
that referenced
this pull request
Aug 20, 2023
…etector addition (#2653) This fixes: #2647 Reverts: #2602 OBE: #2650 To be clear, the memory leak issue is not addressed because it is not a Flame issue. Flame properly calls the `onRemove` event and if it is needed to pass that on to children, users should do as documented: https://docs.flame-engine.org/latest/flame/game.html#lifecycle. So if you are using `GameWidget.controlled`, add a tappable component and then remove the game, the lifecycle looks like: ``` flutter: onLoad flutter: mount flutter: onMount flutter: attach flutter: add has_tappable_components flutter: refreshWidget // Remove Game flutter: detach flutter: removeGameStateListener flutter: onRemove flutter: remove ``` If you do not use `GameWidget.controlled`, add a tappable component and then remove the game, the lifecycle looks like: ``` flutter: onLoad flutter: mount flutter: onMount flutter: attach flutter: add has_tappable_components flutter: refreshWidget // Remove Game flutter: detach flutter: removeGameStateListener flutter: onRemove flutter: remove ``` If you do not use `GameWidget.controlled`, do not add a tappable component and then remove the game, the lifecycle looks like: ``` flutter: onLoadFuture flutter: mount flutter: onMount flutter: attach // Remove Game flutter: detach flutter: removeGameStateListener flutter: onRemove flutter: remove ``` Previously, the lifecycle would look like: ``` flutter: onLoad flutter: mount flutter: onMount flutter: attach flutter: add has_tappable_components flutter: refreshWidget flutter: detach // These unnecessary calls have been eliminated flutter: removeGameStateListener // These unnecessary calls have been eliminated flutter: onRemove // These unnecessary calls have been eliminated flutter: attach // Remove Game flutter: detach flutter: removeGameStateListener flutter: onRemove flutter: remove ``` I have updated the below diagram for those who may need it in the future: 
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
As discussed in #2647, this PR just updates the docs to clarify that
onRemovewill get called when you first add a gesture based component.Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues