test: Test case for extended SpriteButtonComponent (#3318)

Added an extra test case for testing `SpriteButtonComponent` class. which includes a `CustomSpriteButtonComponet` class to test the working with `onLoad` instead of directly using Constructor. --------- Co-authored-by: Lukas Klingsbo <[email protected]> Co-authored-by: Lukas Klingsbo <[email protected]>
flame-engine · Oct 4, 2024 · e179cc7 · e179cc7
1 parent f36533e
commit e179cc7
Showing 1 changed file with 236 additions and 0 deletions.
diff --git a/packages/flame/test/components/input/sprite_button_component_test.dart b/packages/flame/test/components/input/sprite_button_component_test.dart
@@ -39,6 +39,7 @@ Future<void> main() async {
           _ButtonState.down: buttonSheet.getSpriteById(1),
         },
       );
+
       component.current = _ButtonState.down;
 
       await game.ensureAdd(
@@ -193,6 +194,181 @@ Future<void> main() async {
         expect(game.paused, false);
       },
     );
+
+    testWithFlameGame('correctly registers taps (custom button)', (game) async {
+      final initialGameSize = Vector2.all(100);
+      final componentSize = Vector2.all(10);
+      final buttonPosition = Vector2.all(100);
+      late final _CustomSpriteButtonComponent button;
+      game.onGameResize(initialGameSize);
+
+      final buttonSheet = SpriteSheet.fromColumnsAndRows(
+        image: image,
+        columns: 1,
+        rows: 2,
+      );
+
+      final component = SpriteGroupComponent<_ButtonState>(
+        sprites: {
+          _ButtonState.up: buttonSheet.getSpriteById(0),
+          _ButtonState.down: buttonSheet.getSpriteById(1),
+        },
+      );
+      component.current = _ButtonState.down;
+
+      await game.ensureAdd(
+        button = _CustomSpriteButtonComponent(
+          customButton: buttonSheet.getSpriteById(0),
+          customButtonDown: buttonSheet.getSpriteById(1),
+          customOnPressed: () => component.current = _ButtonState.up,
+          customPosition: buttonPosition,
+          customSize: componentSize,
+        ),
+      );
+
+      final tapDispatcher = game.firstChild<MultiTapDispatcher>()!;
+
+      tapDispatcher.handleTapDown(1, TapDownDetails());
+      expect(component.current, _ButtonState.down);
+
+      tapDispatcher.handleTapDown(
+        1,
+        TapDownDetails(
+          globalPosition: buttonPosition.toOffset(),
+        ),
+      );
+      expect(component.current, _ButtonState.down);
+
+      tapDispatcher.handleTapUp(
+        1,
+        TapUpDetails(
+          kind: PointerDeviceKind.touch,
+          globalPosition: button.positionOfAnchor(Anchor.center).toOffset(),
+        ),
+      );
+      expect(component.current, _ButtonState.up);
+    });
+
+    testWithFlameGame('correctly registers taps onGameResize (custom button)',
+        (game) async {
+      final initialGameSize = Vector2.all(100);
+      final componentSize = Vector2.all(10);
+      final buttonPosition = Vector2.all(100);
+      late final _CustomSpriteButtonComponent button;
+      game.onGameResize(initialGameSize);
+
+      final buttonSheet = SpriteSheet.fromColumnsAndRows(
+        image: image,
+        columns: 1,
+        rows: 2,
+      );
+
+      final component = SpriteGroupComponent<_ButtonState>(
+        sprites: {
+          _ButtonState.up: buttonSheet.getSpriteById(0),
+          _ButtonState.down: buttonSheet.getSpriteById(1),
+        },
+      );
+      component.current = _ButtonState.down;
+
+      await game.ensureAdd(
+        button = _CustomSpriteButtonComponent(
+          customButton: buttonSheet.getSpriteById(0),
+          customButtonDown: buttonSheet.getSpriteById(1),
+          customOnPressed: () => component.current = _ButtonState.up,
+          customPosition: buttonPosition,
+          customSize: componentSize,
+        ),
+      );
+
+      final previousPosition =
+          button.positionOfAnchor(Anchor.center).toOffset();
+      game.onGameResize(initialGameSize * 2);
+      final tapDispatcher = game.firstChild<MultiTapDispatcher>()!;
+
+      tapDispatcher.handleTapDown(
+        1,
+        TapDownDetails(
+          globalPosition: previousPosition,
+        ),
+      );
+      expect(component.current, _ButtonState.down);
+
+      tapDispatcher.handleTapUp(
+        1,
+        TapUpDetails(
+          kind: PointerDeviceKind.touch,
+          globalPosition: button.positionOfAnchor(Anchor.center).toOffset(),
+        ),
+      );
+      expect(component.current, _ButtonState.up);
+    });
+
+    testWidgets(
+      'Button can be pressed while the engine is paused (custom button)',
+      (tester) async {
+        final game = FlameGame();
+
+        final buttonSheet = SpriteSheet.fromColumnsAndRows(
+          image: image,
+          columns: 1,
+          rows: 2,
+        );
+
+        final component = SpriteGroupComponent<_ButtonState>(
+          sprites: {
+            _ButtonState.up: buttonSheet.getSpriteById(0),
+            _ButtonState.down: buttonSheet.getSpriteById(1),
+          },
+        );
+        component.current = _ButtonState.down;
+
+        game.add(
+          _CustomSpriteButtonComponent(
+            customButton: buttonSheet.getSpriteById(0),
+            customButtonDown: buttonSheet.getSpriteById(1),
+            customOnPressed: () {
+              game.pauseEngine();
+              game.overlays.add('pause-menu');
+            },
+            customPosition: Vector2(400, 300),
+            customSize: Vector2.all(10),
+          ),
+        );
+        await tester.pumpWidget(
+          GameWidget(
+            game: game,
+            overlayBuilderMap: {
+              'pause-menu': (context, _) {
+                return _SimpleStatelessWidget(
+                  build: (context) {
+                    return Center(
+                      child: OutlinedButton(
+                        onPressed: () {
+                          game.overlays.remove('pause-menu');
+                          game.resumeEngine();
+                        },
+                        child: const Text('Resume'),
+                      ),
+                    );
+                  },
+                );
+              },
+            },
+          ),
+        );
+        await tester.pump();
+        await tester.pump();
+
+        await tester.tapAt(const Offset(400, 300));
+        await tester.pump(const Duration(seconds: 1));
+        expect(game.paused, true);
+
+        await tester.tapAt(const Offset(400, 300));
+        await tester.pump(const Duration(seconds: 1));
+        expect(game.paused, false);
+      },
+    );
   });
 
   testWithFlameGame('can change button sprites', (game) async {
@@ -228,6 +404,66 @@ Future<void> main() async {
       },
     );
   });
+
+  testWithFlameGame('can change button sprites (custom button)', (game) async {
+    final buttonSheet = SpriteSheet.fromColumnsAndRows(
+      image: image,
+      columns: 1,
+      rows: 2,
+    );
+
+    final button = _CustomSpriteButtonComponent(
+      customButton: buttonSheet.getSpriteById(0),
+      customButtonDown: buttonSheet.getSpriteById(1),
+    );
+
+    await game.ensureAdd(button);
+
+    expect(
+      button.sprites,
+      {
+        ButtonState.up: buttonSheet.getSpriteById(0),
+        ButtonState.down: buttonSheet.getSpriteById(1),
+      },
+    );
+
+    button.button = buttonSheet.getSpriteById(1);
+    button.buttonDown = buttonSheet.getSpriteById(0);
+
+    expect(
+      button.sprites,
+      {
+        ButtonState.up: buttonSheet.getSpriteById(1),
+        ButtonState.down: buttonSheet.getSpriteById(0),
+      },
+    );
+  });
+}
+
+/// This is used to test [SpriteButtonComponent] without using the constructor
+/// and setting properties in [onLoad] of an extending class instead.
+class _CustomSpriteButtonComponent extends SpriteButtonComponent {
+  final Sprite customButton;
+  final Sprite customButtonDown;
+  final void Function()? customOnPressed;
+  final Vector2? customPosition;
+  final Vector2? customSize;
+
+  _CustomSpriteButtonComponent({
+    required this.customButton,
+    required this.customButtonDown,
+    this.customOnPressed,
+    this.customPosition,
+    this.customSize,
+  });
+
+  @override
+  Future<void> onLoad() async {
+    position = customPosition ?? Vector2(0.0, 0.0);
+    button = customButton;
+    buttonDown = customButtonDown;
+    onPressed = customOnPressed;
+  }
 }
 
 class _SimpleStatelessWidget extends StatelessWidget {