fix(NA): black frame when activating overlays (#1093)

* fix(NA): black flame when activating overlays * more fixes * Update packages/flame/lib/src/game/game_widget/game_widget.dart Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com> * Update packages/flame/lib/src/game/game_widget/game_widget.dart Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com> * Rename stuff * call onremove on removing game from the widget tree * update test Co-authored-by: Lukas Klingsbo <lukas.klingsbo@gmail.com>
flame-engine · Nov 17, 2021 · 85caf46 · 85caf46
1 parent 394b39f
commit 85caf46
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 8 deletions.
diff --git a/packages/flame/CHANGELOG.md b/packages/flame/CHANGELOG.md
@@ -25,6 +25,7 @@
  - `TextPaint` to use `TextStyle` (material) instead of `TextPaintConfig`
  - Underlying `Shape`s in `ShapeComponent` transform with components position, size and angle
  - `HitboxShape` takes parents ancestors transformations into consideration (not scaling)
+ - Fixed black frame when updating game widget (ex: adding overlays)
  - Added possibility to extend `JoystickComponent`
  - Renamed `FlameTester` to `GameTester`
  - Modified `FlameTester` to be specific for `T extends FlameGame`

diff --git a/packages/flame/lib/src/game/game_widget/game_widget.dart b/packages/flame/lib/src/game/game_widget/game_widget.dart
@@ -138,11 +138,13 @@ class _GameWidgetState<T extends Game> extends State<GameWidget<T>> {
 
   MouseCursor? _mouseCursor;
 
-  Future<void> get _loaderFuture {
-    final onLoad = widget.game.onLoadCache;
-    final onMount = widget.game.onMount;
-    return (onLoad ?? Future<void>.value()).then((_) => onMount());
-  }
+  Future<void> get loaderFuture => _loaderFuture ??= (() {
+        final onLoad = widget.game.onLoadCache;
+        final onMount = widget.game.onMount;
+        return (onLoad ?? Future<void>.value()).then((_) => onMount());
+      })();
+
+  Future<void>? _loaderFuture;
 
   late FocusNode _focusNode;
 
@@ -194,6 +196,10 @@ class _GameWidgetState<T extends Game> extends State<GameWidget<T>> {
       // Reset mouse cursor
       _initMouseCursor();
       addMouseCursorListener();
+
+      // Reset the loaderFuture so that onMount will run again (onLoad is still cached).
+      oldWidget.game.onRemove();
+      _loaderFuture = null;
     }
   }
 
@@ -311,7 +317,7 @@ class _GameWidgetState<T extends Game> extends State<GameWidget<T>> {
               builder: (_, BoxConstraints constraints) {
                 widget.game.onGameResize(constraints.biggest.toVector2());
                 return FutureBuilder(
-                  future: _loaderFuture,
+                  future: loaderFuture,
                   builder: (_, snapshot) {
                     if (snapshot.hasError) {
                       final errorBuilder = widget.errorBuilder;

diff --git a/packages/flame/lib/src/game/mixins/loadable.dart b/packages/flame/lib/src/game/mixins/loadable.dart
@@ -39,6 +39,7 @@ mixin Loadable {
   /// implementing class, it is cached so that it can be reused when the parent
   /// component/game/widget changes.
   @internal
+  @nonVirtual
   late Future<void>? onLoadCache = onLoad();
 
   /// Called after the component has successfully run [onLoad] and before the

diff --git a/packages/flame/test/game/game_widget/game_widget_lifecycle_test.dart b/packages/flame/test/game/game_widget/game_widget_lifecycle_test.dart
@@ -123,6 +123,8 @@ class _MyContainer extends StatefulWidget {
 class _MyContainerState extends State<_MyContainer> {
   double size = 300;
 
+  late final game = _MyGame(widget.events);
+
   void causeResize() {
     setState(() => size = 400);
   }
@@ -132,7 +134,7 @@ class _MyContainerState extends State<_MyContainer> {
     return Container(
       width: size,
       height: size,
-      child: GameWidget(game: _MyGame(widget.events)),
+      child: GameWidget(game: game),
     );
   }
 }
@@ -194,7 +196,7 @@ void main() {
       state.causeResize();
 
       await tester.pump();
-      expect(events, ['onGameResize', 'onLoad', 'onMount']); // no onRemove
+      expect(events, ['onGameResize']); // no onRemove
       final game =
           tester.allWidgets.whereType<GameWidget<_MyGame>>().first.game;
       expect(game.children, everyElement((Component c) => c.parent == game));