From 2673c419b5e58f16a10bff50643dca3d74132ec2 Mon Sep 17 00:00:00 2001 From: Alejandro Santiago Date: Wed, 27 Apr 2022 21:53:32 +0100 Subject: [PATCH] feat: migration to new `ContactCallbacks` (#234) * feat: migrated to new ContactCallbacks * refactor: moved renderBody to super call * feat: defined AlienBumper behaviours * feat: included ParentIsA mixin * refactor: modified ContactCallbacksGroup * feat: resolved missing ContactCallbacks with Behaviors * refactor: removed unused ParentIsA * refactor: moved tests * fix: invalid export * refactor: renamed behaviours * test: tested pinball_components * refactor: removed "Behaviour" typo * docs: included TODO comment for generics * docs: included flame_bloc TODO comments * refactor: renamed ContacCallbacksGroup variable * docs: included doc comments where possible * docs: rephrased ContactBehaviour doc comment * test: included ContactBehavior tests * feat: implemented FlutterForestBonusBehavior * refactor: fixed analyser warnings * test: tested DashNestBumper * refactor: moved children to last arguement * test: included closing test * refactor: used barrel files as imports * docs: included flutter_bloc TODO * test: correctly tested GoogleWordBonusBehavior * refactor: moved flutter_forest_test.dart * test: fixed AlienZone typo * feat: removed FlutterForestCubit * test: closed streams * refactor: removed optional bloc parameter * refactor: added flame_bloc TODO comment * docs: included .test constructor docs * feat: included GoogleLetter.test * test: made blink test pass * fix: renamed theme to CharacterTheme * refactor: moved timer.stop(); * refactor: renamed hasBonus to achievedBonus * refactor: ignore public_member_api_docs for cubits * test: removed beginContact group * refactor: typos correction * docs: used correct AlienBumper reference * docs: removed TODO comment from ContactBehavior subclasses * docs: includes ScoringBehavior doc * feat: adjusted FlutterForest priorities Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com> --- lib/game/components/alien_zone.dart | 65 ++----- lib/game/components/components.dart | 6 +- lib/game/components/controlled_ball.dart | 6 +- lib/game/components/flutter_forest.dart | 102 ---------- .../flutter_forest/behaviors/behaviors.dart | 1 + .../flutter_forest_bonus_behavior.dart | 41 ++++ .../flutter_forest/flutter_forest.dart | 49 +++++ lib/game/components/google_word.dart | 83 -------- .../google_word/behaviors/behaviors.dart | 1 + .../behaviors/google_word_bonus_behavior.dart | 34 ++++ .../components/google_word/google_word.dart | 30 +++ lib/game/components/score_points.dart | 47 ----- lib/game/components/scoring_behavior.dart | 34 ++++ lib/game/components/sparky_fire_zone.dart | 85 +++------ lib/game/components/wall.dart | 16 +- lib/game/pinball_game.dart | 20 +- .../{ => alien_bumper}/alien_bumper.dart | 88 +++++---- .../alien_bumper_ball_contact_behavior.dart | 14 ++ .../alien_bumper_blinking_behavior.dart | 39 ++++ .../alien_bumper/behaviors/behaviors.dart | 2 + .../cubit/alien_bumper_cubit.dart | 17 ++ .../cubit/alien_bumper_state.dart | 10 + .../lib/src/components/ball.dart | 2 +- .../lib/src/components/baseboard.dart | 5 +- .../lib/src/components/boundaries.dart | 14 +- .../lib/src/components/components.dart | 8 +- .../lib/src/components/dash_animatronic.dart | 1 - .../dash_nest_bumper/behaviors/behaviors.dart | 1 + .../dash_nest_bumper_contact_behavior.dart | 15 ++ .../cubit/dash_nest_bumper_cubit.dart | 19 ++ .../cubit/dash_nest_bumper_state.dart | 10 + .../dash_nest_bumper.dart | 92 +++++---- .../lib/src/components/dino_walls.dart | 10 +- .../lib/src/components/flipper.dart | 5 +- .../google_letter/behaviors/behaviors.dart | 1 + .../google_letter_ball_contact_behavior.dart | 14 ++ .../cubit/google_letter_cubit.dart | 17 ++ .../cubit/google_letter_state.dart | 10 + .../{ => google_letter}/google_letter.dart | 77 ++++---- .../lib/src/components/kicker.dart | 5 +- .../lib/src/components/launch_ramp.dart | 18 +- .../lib/src/components/layer_sensor.dart | 45 ++--- .../lib/src/components/plunger.dart | 6 +- .../lib/src/components/render_priority.dart | 6 +- .../lib/src/components/signpost.dart | 16 +- .../lib/src/components/slingshot.dart | 5 +- .../lib/src/components/spaceship.dart | 27 +-- .../lib/src/components/spaceship_rail.dart | 15 +- .../lib/src/components/spaceship_ramp.dart | 19 +- .../sparky_bumper/behaviors/behaviors.dart | 2 + .../sparky_bumper_ball_contact_behavior.dart | 14 ++ .../sparky_bumper_blinking_behavior.dart | 39 ++++ .../cubit/sparky_bumper_cubit.dart | 17 ++ .../cubit/sparky_bumper_state.dart | 10 + .../{ => sparky_bumper}/sparky_bumper.dart | 100 ++++++---- .../lib/src/components/sparky_computer.dart | 5 +- packages/pinball_components/pubspec.yaml | 9 +- .../google_word/google_letter_game.dart | 10 - .../pinball_components/sandbox/pubspec.lock | 20 +- .../pinball_components/sandbox/pubspec.yaml | 6 +- .../test/helpers/mocks.dart | 11 +- .../alien_bumper/alien_bumper_test.dart | 78 ++++++++ ...ien_bumper_ball_contact_behavior_test.dart | 48 +++++ .../alien_bumper_blinking_behavior_test.dart | 45 +++++ .../cubit/alien_bumper_cubit_test.dart | 24 +++ .../src/components/alien_bumper_test.dart | 61 ------ ...est_bumper_ball_contact_behavior_test.dart | 48 +++++ .../cubit/dash_nest_bumper_cubit_test.dart | 24 +++ .../dash_nest_bumper_test.dart | 88 +++++++++ .../src/components/dash_nest_bumper_test.dart | 77 -------- ...gle_letter_ball_contact_behavior_test.dart | 48 +++++ .../cubit/google_letter_cubit_test.dart | 24 +++ .../google_letter_test.dart | 69 +++---- .../src/components/layer_sensor_test.dart | 17 +- .../test/src/components/signpost_test.dart | 9 + ...rky_bumper_ball_contact_behavior_test.dart | 48 +++++ .../sparky_bumper_blinking_behavior_test.dart | 45 +++++ .../cubit/sparky_bumper_cubit_test.dart | 24 +++ .../sparky_bumper/sparky_bumper_test.dart | 86 +++++++++ .../src/components/sparky_bumper_test.dart | 69 ------- packages/pinball_flame/lib/pinball_flame.dart | 2 + .../lib/src/contact_behavior.dart | 95 ++++++++++ .../pinball_flame/lib/src/parent_is_a.dart | 15 ++ packages/pinball_flame/pubspec.yaml | 6 +- .../pinball_flame/test/helpers/mocks.dart | 3 - .../test/src/contact_behavior_test.dart | 153 +++++++++++++++ pubspec.lock | 35 ++-- pubspec.yaml | 6 +- test/game/components/alien_zone_test.dart | 74 +------- test/game/components/board_test.dart | 4 +- .../components/controlled_flipper_test.dart | 4 +- .../flutter_forest_bonus_behavior_test.dart | 84 +++++++++ .../flutter_forest/flutter_forest_test.dart | 80 ++++++++ test/game/components/flutter_forest_test.dart | 177 ------------------ .../google_word_bonus_behavior_test.dart | 61 ++++++ .../google_word/google_word_test.dart | 26 +++ test/game/components/google_word_test.dart | 73 -------- test/game/components/score_points_test.dart | 105 ----------- .../components/scoring_behavior_test.dart | 111 +++++++++++ .../components/sparky_fire_zone_test.dart | 91 ++------- test/game/components/wall_test.dart | 3 - test/game/pinball_game_test.dart | 21 +-- test/helpers/mocks.dart | 3 - test/helpers/test_games.dart | 33 +++- 104 files changed, 2203 insertions(+), 1490 deletions(-) delete mode 100644 lib/game/components/flutter_forest.dart create mode 100644 lib/game/components/flutter_forest/behaviors/behaviors.dart create mode 100644 lib/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior.dart create mode 100644 lib/game/components/flutter_forest/flutter_forest.dart delete mode 100644 lib/game/components/google_word.dart create mode 100644 lib/game/components/google_word/behaviors/behaviors.dart create mode 100644 lib/game/components/google_word/behaviors/google_word_bonus_behavior.dart create mode 100644 lib/game/components/google_word/google_word.dart delete mode 100644 lib/game/components/score_points.dart create mode 100644 lib/game/components/scoring_behavior.dart rename packages/pinball_components/lib/src/components/{ => alien_bumper}/alien_bumper.dart (58%) create mode 100644 packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior.dart create mode 100644 packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior.dart create mode 100644 packages/pinball_components/lib/src/components/alien_bumper/behaviors/behaviors.dart create mode 100644 packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart create mode 100644 packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_state.dart create mode 100644 packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/behaviors.dart create mode 100644 packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart create mode 100644 packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart create mode 100644 packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_state.dart rename packages/pinball_components/lib/src/components/{ => dash_nest_bumper}/dash_nest_bumper.dart (63%) create mode 100644 packages/pinball_components/lib/src/components/google_letter/behaviors/behaviors.dart create mode 100644 packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart create mode 100644 packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart create mode 100644 packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart rename packages/pinball_components/lib/src/components/{ => google_letter}/google_letter.dart (52%) create mode 100644 packages/pinball_components/lib/src/components/sparky_bumper/behaviors/behaviors.dart create mode 100644 packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart create mode 100644 packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior.dart create mode 100644 packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart create mode 100644 packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart rename packages/pinball_components/lib/src/components/{ => sparky_bumper}/sparky_bumper.dart (57%) create mode 100644 packages/pinball_components/test/src/components/alien_bumper/alien_bumper_test.dart create mode 100644 packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior_test.dart create mode 100644 packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior_test.dart create mode 100644 packages/pinball_components/test/src/components/alien_bumper/cubit/alien_bumper_cubit_test.dart delete mode 100644 packages/pinball_components/test/src/components/alien_bumper_test.dart create mode 100644 packages/pinball_components/test/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_ball_contact_behavior_test.dart create mode 100644 packages/pinball_components/test/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit_test.dart create mode 100644 packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart delete mode 100644 packages/pinball_components/test/src/components/dash_nest_bumper_test.dart create mode 100644 packages/pinball_components/test/src/components/google_letter/behaviors/google_letter_ball_contact_behavior_test.dart create mode 100644 packages/pinball_components/test/src/components/google_letter/cubit/google_letter_cubit_test.dart rename packages/pinball_components/test/src/components/{ => google_letter}/google_letter_test.dart (62%) create mode 100644 packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior_test.dart create mode 100644 packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior_test.dart create mode 100644 packages/pinball_components/test/src/components/sparky_bumper/cubit/sparky_bumper_cubit_test.dart create mode 100644 packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart delete mode 100644 packages/pinball_components/test/src/components/sparky_bumper_test.dart create mode 100644 packages/pinball_flame/lib/src/contact_behavior.dart create mode 100644 packages/pinball_flame/lib/src/parent_is_a.dart create mode 100644 packages/pinball_flame/test/src/contact_behavior_test.dart create mode 100644 test/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior_test.dart create mode 100644 test/game/components/flutter_forest/flutter_forest_test.dart delete mode 100644 test/game/components/flutter_forest_test.dart create mode 100644 test/game/components/google_word/behaviors/google_word_bonus_behavior_test.dart create mode 100644 test/game/components/google_word/google_word_test.dart delete mode 100644 test/game/components/google_word_test.dart delete mode 100644 test/game/components/score_points_test.dart create mode 100644 test/game/components/scoring_behavior_test.dart diff --git a/lib/game/components/alien_zone.dart b/lib/game/components/alien_zone.dart index 720c1180..dadc5ba4 100644 --- a/lib/game/components/alien_zone.dart +++ b/lib/game/components/alien_zone.dart @@ -1,60 +1,29 @@ // ignore_for_file: avoid_renaming_method_parameters -import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:flutter/material.dart'; import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; /// {@template alien_zone} /// Area positioned below [Spaceship] where the [Ball] /// can bounce off [AlienBumper]s. -/// -/// When a [Ball] hits an [AlienBumper], the bumper animates. /// {@endtemplate} -class AlienZone extends Component with HasGameRef { +class AlienZone extends Blueprint { /// {@macro alien_zone} - AlienZone(); - - @override - Future onLoad() async { - await super.onLoad(); - - gameRef.addContactCallback(AlienBumperBallContactCallback()); - - final lowerBumper = _AlienBumper.a() - ..initialPosition = Vector2(-32.52, -9.1); - final upperBumper = _AlienBumper.b() - ..initialPosition = Vector2(-22.89, -17.35); - - await addAll([ - lowerBumper, - upperBumper, - ]); - } -} - -// TODO(alestiago): Revisit ScorePoints logic once the FlameForge2D -// ContactCallback process is enhanced. -class _AlienBumper extends AlienBumper with ScorePoints { - _AlienBumper.a() : super.a(); - - _AlienBumper.b() : super.b(); - - @override - int get points => 20; -} - -/// Listens when a [Ball] bounces against an [AlienBumper]. -@visibleForTesting -class AlienBumperBallContactCallback - extends ContactCallback { - @override - void begin( - AlienBumper alienBumper, - Ball _, - Contact __, - ) { - alienBumper.animate(); - } + AlienZone() + : super( + components: [ + AlienBumper.a( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(-32.52, -9.1), + AlienBumper.b( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(-22.89, -17.35), + ], + ); } diff --git a/lib/game/components/components.dart b/lib/game/components/components.dart index 7d4b23f7..321be988 100644 --- a/lib/game/components/components.dart +++ b/lib/game/components/components.dart @@ -4,10 +4,10 @@ export 'camera_controller.dart'; export 'controlled_ball.dart'; export 'controlled_flipper.dart'; export 'controlled_plunger.dart'; -export 'flutter_forest.dart'; +export 'flutter_forest/flutter_forest.dart'; export 'game_flow_controller.dart'; -export 'google_word.dart'; +export 'google_word/google_word.dart'; export 'launcher.dart'; -export 'score_points.dart'; +export 'scoring_behavior.dart'; export 'sparky_fire_zone.dart'; export 'wall.dart'; diff --git a/lib/game/components/controlled_ball.dart b/lib/game/components/controlled_ball.dart index 6468c821..f36cfef2 100644 --- a/lib/game/components/controlled_ball.dart +++ b/lib/game/components/controlled_ball.dart @@ -49,10 +49,8 @@ class BallController extends ComponentController /// {@macro ball_controller} BallController(Ball ball) : super(ball); - /// Removes the [Ball] from a [PinballGame]. - /// - /// Triggered by [BottomWallBallContactCallback] when the [Ball] falls into - /// a [BottomWall]. + /// Event triggered when the ball is lost. + // TODO(alestiago): Refactor using behaviors. void lost() { component.shouldRemove = true; } diff --git a/lib/game/components/flutter_forest.dart b/lib/game/components/flutter_forest.dart deleted file mode 100644 index 971cd700..00000000 --- a/lib/game/components/flutter_forest.dart +++ /dev/null @@ -1,102 +0,0 @@ -// ignore_for_file: avoid_renaming_method_parameters - -import 'package:flame/components.dart'; -import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball_components/pinball_components.dart'; -import 'package:pinball_flame/pinball_flame.dart'; - -/// {@template flutter_forest} -/// Area positioned at the top right of the [Board] where the [Ball] -/// can bounce off [DashNestBumper]s. -/// -/// When all [DashNestBumper]s are hit at least once, the [GameBonus.dashNest] -/// is awarded, and the [DashNestBumper.main] releases a new [Ball]. -/// {@endtemplate} -class FlutterForest extends Component - with Controls<_FlutterForestController>, HasGameRef { - /// {@macro flutter_forest} - FlutterForest() { - controller = _FlutterForestController(this); - } - - @override - Future onLoad() async { - await super.onLoad(); - gameRef.addContactCallback(_DashNestBumperBallContactCallback()); - - final signpost = Signpost()..initialPosition = Vector2(8.35, -58.3); - - final bigNest = _DashNestBumper.main() - ..initialPosition = Vector2(18.55, -59.35); - final smallLeftNest = _DashNestBumper.a() - ..initialPosition = Vector2(8.95, -51.95); - final smallRightNest = _DashNestBumper.b() - ..initialPosition = Vector2(23.3, -46.75); - final dashAnimatronic = DashAnimatronic()..position = Vector2(20, -66); - - await addAll([ - signpost, - smallLeftNest, - smallRightNest, - bigNest, - dashAnimatronic, - ]); - } -} - -class _FlutterForestController extends ComponentController - with HasGameRef { - _FlutterForestController(FlutterForest flutterForest) : super(flutterForest); - - final _activatedBumpers = {}; - - void activateBumper(DashNestBumper dashNestBumper) { - if (!_activatedBumpers.add(dashNestBumper)) return; - - dashNestBumper.activate(); - - final activatedBonus = _activatedBumpers.length == 3; - if (activatedBonus) { - _addBonusBall(); - - gameRef.read().add(const BonusActivated(GameBonus.dashNest)); - _activatedBumpers - ..forEach((bumper) => bumper.deactivate()) - ..clear(); - - component.firstChild()?.playing = true; - } - } - - Future _addBonusBall() async { - await gameRef.add( - ControlledBall.bonus(characterTheme: gameRef.characterTheme) - ..initialPosition = Vector2(17.2, -52.7), - ); - } -} - -// TODO(alestiago): Revisit ScorePoints logic once the FlameForge2D -// ContactCallback process is enhanced. -class _DashNestBumper extends DashNestBumper with ScorePoints { - _DashNestBumper.main() : super.main(); - - _DashNestBumper.a() : super.a(); - - _DashNestBumper.b() : super.b(); - - @override - int get points => 20; -} - -class _DashNestBumperBallContactCallback - extends ContactCallback { - @override - void begin(DashNestBumper dashNestBumper, _, __) { - final parent = dashNestBumper.parent; - if (parent is FlutterForest) { - parent.controller.activateBumper(dashNestBumper); - } - } -} diff --git a/lib/game/components/flutter_forest/behaviors/behaviors.dart b/lib/game/components/flutter_forest/behaviors/behaviors.dart new file mode 100644 index 00000000..c0f39810 --- /dev/null +++ b/lib/game/components/flutter_forest/behaviors/behaviors.dart @@ -0,0 +1 @@ +export 'flutter_forest_bonus_behavior.dart'; diff --git a/lib/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior.dart b/lib/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior.dart new file mode 100644 index 00000000..949fead1 --- /dev/null +++ b/lib/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior.dart @@ -0,0 +1,41 @@ +import 'package:flame/components.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// When all [DashNestBumper]s are hit at least once, the [GameBonus.dashNest] +/// is awarded, and the [DashNestBumper.main] releases a new [Ball]. +class FlutterForestBonusBehavior extends Component + with ParentIsA, HasGameRef { + @override + void onMount() { + super.onMount(); + + final bumpers = parent.children.whereType(); + for (final bumper in bumpers) { + // TODO(alestiago): Refactor subscription management once the following is + // merged: + // https://github.com/flame-engine/flame/pull/1538 + bumper.bloc.stream.listen((state) { + final achievedBonus = bumpers.every( + (bumper) => bumper.bloc.state == DashNestBumperState.active, + ); + + if (achievedBonus) { + gameRef + .read() + .add(const BonusActivated(GameBonus.dashNest)); + gameRef.add( + ControlledBall.bonus(characterTheme: gameRef.characterTheme) + ..initialPosition = Vector2(17.2, -52.7), + ); + parent.firstChild()?.playing = true; + + for (final bumper in bumpers) { + bumper.bloc.onReset(); + } + } + }); + } + } +} diff --git a/lib/game/components/flutter_forest/flutter_forest.dart b/lib/game/components/flutter_forest/flutter_forest.dart new file mode 100644 index 00000000..02483159 --- /dev/null +++ b/lib/game/components/flutter_forest/flutter_forest.dart @@ -0,0 +1,49 @@ +// ignore_for_file: avoid_renaming_method_parameters + +import 'package:flame/components.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball/game/components/flutter_forest/behaviors/behaviors.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +/// {@template flutter_forest} +/// Area positioned at the top right of the [Board] where the [Ball] can bounce +/// off [DashNestBumper]s. +/// {@endtemplate} +class FlutterForest extends Component { + /// {@macro flutter_forest} + FlutterForest() + : super( + priority: RenderPriority.flutterForest, + children: [ + Signpost( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(8.35, -58.3), + DashNestBumper.main( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(18.55, -59.35), + DashNestBumper.a( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(8.95, -51.95), + DashNestBumper.b( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(23.3, -46.75), + DashAnimatronic()..position = Vector2(20, -66), + FlutterForestBonusBehavior(), + ], + ); + + /// Creates a [FlutterForest] without any children. + /// + /// This can be used for testing [FlutterForest]'s behaviors in isolation. + @visibleForTesting + FlutterForest.test(); +} diff --git a/lib/game/components/google_word.dart b/lib/game/components/google_word.dart deleted file mode 100644 index 34609c64..00000000 --- a/lib/game/components/google_word.dart +++ /dev/null @@ -1,83 +0,0 @@ -// ignore_for_file: avoid_renaming_method_parameters - -import 'dart:async'; - -import 'package:flame/components.dart'; -import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball_components/pinball_components.dart'; -import 'package:pinball_flame/pinball_flame.dart'; - -/// {@template google_word} -/// Loads all [GoogleLetter]s to compose a [GoogleWord]. -/// {@endtemplate} -class GoogleWord extends Component - with HasGameRef, Controls<_GoogleWordController> { - /// {@macro google_word} - GoogleWord({ - required Vector2 position, - }) : _position = position { - controller = _GoogleWordController(this); - } - - final Vector2 _position; - - @override - Future onLoad() async { - await super.onLoad(); - gameRef.addContactCallback(_GoogleLetterBallContactCallback()); - - final offsets = [ - Vector2(-12.92, 1.82), - Vector2(-8.33, -0.65), - Vector2(-2.88, -1.75), - Vector2(2.88, -1.75), - Vector2(8.33, -0.65), - Vector2(12.92, 1.82), - ]; - - final letters = []; - for (var index = 0; index < offsets.length; index++) { - letters.add( - GoogleLetter(index)..initialPosition = _position + offsets[index], - ); - } - - await addAll(letters); - } -} - -class _GoogleWordController extends ComponentController - with HasGameRef { - _GoogleWordController(GoogleWord googleWord) : super(googleWord); - - final _activatedLetters = {}; - - void activate(GoogleLetter googleLetter) { - if (!_activatedLetters.add(googleLetter)) return; - - googleLetter.activate(); - - final activatedBonus = _activatedLetters.length == 6; - if (activatedBonus) { - gameRef.audio.googleBonus(); - gameRef.read().add(const BonusActivated(GameBonus.googleWord)); - component.children.whereType().forEach( - (letter) => letter.deactivate(), - ); - _activatedLetters.clear(); - } - } -} - -/// Activates a [GoogleLetter] when it contacts with a [Ball]. -class _GoogleLetterBallContactCallback - extends ContactCallback { - @override - void begin(GoogleLetter googleLetter, _, __) { - final parent = googleLetter.parent; - if (parent is GoogleWord) { - parent.controller.activate(googleLetter); - } - } -} diff --git a/lib/game/components/google_word/behaviors/behaviors.dart b/lib/game/components/google_word/behaviors/behaviors.dart new file mode 100644 index 00000000..4ebf817c --- /dev/null +++ b/lib/game/components/google_word/behaviors/behaviors.dart @@ -0,0 +1 @@ +export 'google_word_bonus_behavior.dart'; diff --git a/lib/game/components/google_word/behaviors/google_word_bonus_behavior.dart b/lib/game/components/google_word/behaviors/google_word_bonus_behavior.dart new file mode 100644 index 00000000..92664531 --- /dev/null +++ b/lib/game/components/google_word/behaviors/google_word_bonus_behavior.dart @@ -0,0 +1,34 @@ +import 'package:flame/components.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// Adds a [GameBonus.googleWord] when all [GoogleLetter]s are activated. +class GoogleWordBonusBehavior extends Component + with HasGameRef, ParentIsA { + @override + void onMount() { + super.onMount(); + + final googleLetters = parent.children.whereType(); + for (final letter in googleLetters) { + // TODO(alestiago): Refactor subscription management once the following is + // merged: + // https://github.com/flame-engine/flame/pull/1538 + letter.bloc.stream.listen((_) { + final achievedBonus = googleLetters + .every((letter) => letter.bloc.state == GoogleLetterState.active); + + if (achievedBonus) { + gameRef.audio.googleBonus(); + gameRef + .read() + .add(const BonusActivated(GameBonus.googleWord)); + for (final letter in googleLetters) { + letter.bloc.onReset(); + } + } + }); + } + } +} diff --git a/lib/game/components/google_word/google_word.dart b/lib/game/components/google_word/google_word.dart new file mode 100644 index 00000000..9a9faa9a --- /dev/null +++ b/lib/game/components/google_word/google_word.dart @@ -0,0 +1,30 @@ +import 'package:flame/components.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball/game/components/google_word/behaviors/behaviors.dart'; +import 'package:pinball_components/pinball_components.dart'; + +/// {@template google_word} +/// Loads all [GoogleLetter]s to compose a [GoogleWord]. +/// {@endtemplate} +class GoogleWord extends Component { + /// {@macro google_word} + GoogleWord({ + required Vector2 position, + }) : super( + children: [ + GoogleLetter(0)..initialPosition = position + Vector2(-12.92, 1.82), + GoogleLetter(1)..initialPosition = position + Vector2(-8.33, -0.65), + GoogleLetter(2)..initialPosition = position + Vector2(-2.88, -1.75), + GoogleLetter(3)..initialPosition = position + Vector2(2.88, -1.75), + GoogleLetter(4)..initialPosition = position + Vector2(8.33, -0.65), + GoogleLetter(5)..initialPosition = position + Vector2(12.92, 1.82), + GoogleWordBonusBehavior(), + ], + ); + + /// Creates a [GoogleWord] without any children. + /// + /// This can be used for testing [GoogleWord]'s behaviors in isolation. + @visibleForTesting + GoogleWord.test(); +} diff --git a/lib/game/components/score_points.dart b/lib/game/components/score_points.dart deleted file mode 100644 index 8a76680d..00000000 --- a/lib/game/components/score_points.dart +++ /dev/null @@ -1,47 +0,0 @@ -// ignore_for_file: avoid_renaming_method_parameters - -import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball_components/pinball_components.dart'; - -/// {@template score_points} -/// Specifies the amount of points received on [Ball] collision. -/// {@endtemplate} -mixin ScorePoints on BodyComponent { - /// {@macro score_points} - int get points; - - @override - Future onLoad() async { - await super.onLoad(); - body.userData = this; - } -} - -/// {@template ball_score_points_callbacks} -/// Adds points to the score when a [Ball] collides with a [BodyComponent] that -/// implements [ScorePoints]. -/// {@endtemplate} -class BallScorePointsCallback extends ContactCallback { - /// {@macro ball_score_points_callbacks} - BallScorePointsCallback(PinballGame game) : _gameRef = game; - - final PinballGame _gameRef; - - @override - void begin( - Ball ball, - ScorePoints scorePoints, - Contact _, - ) { - _gameRef.read().add(Scored(points: scorePoints.points)); - _gameRef.audio.score(); - - _gameRef.add( - ScoreText( - text: scorePoints.points.toString(), - position: ball.body.position, - ), - ); - } -} diff --git a/lib/game/components/scoring_behavior.dart b/lib/game/components/scoring_behavior.dart new file mode 100644 index 00000000..3ef82bb5 --- /dev/null +++ b/lib/game/components/scoring_behavior.dart @@ -0,0 +1,34 @@ +// ignore_for_file: avoid_renaming_method_parameters + +import 'package:flame/components.dart'; +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// {@template scoring_behavior} +/// Adds points to the score when the ball contacts the [parent]. +/// {@endtemplate} +class ScoringBehavior extends ContactBehavior with HasGameRef { + /// {@macro scoring_behavior} + ScoringBehavior({ + required int points, + }) : _points = points; + + final int _points; + + @override + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! Ball) return; + + gameRef.read().add(Scored(points: _points)); + gameRef.audio.score(); + gameRef.add( + ScoreText( + text: _points.toString(), + position: other.body.position, + ), + ); + } +} diff --git a/lib/game/components/sparky_fire_zone.dart b/lib/game/components/sparky_fire_zone.dart index a5450761..a23a4fbc 100644 --- a/lib/game/components/sparky_fire_zone.dart +++ b/lib/game/components/sparky_fire_zone.dart @@ -1,7 +1,6 @@ // ignore_for_file: avoid_renaming_method_parameters import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:flutter/material.dart'; import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; @@ -17,9 +16,21 @@ class SparkyFireZone extends Blueprint { SparkyFireZone() : super( components: [ - _SparkyBumper.a()..initialPosition = Vector2(-22.9, -41.65), - _SparkyBumper.b()..initialPosition = Vector2(-21.25, -57.9), - _SparkyBumper.c()..initialPosition = Vector2(-3.3, -52.55), + SparkyBumper.a( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(-22.9, -41.65), + SparkyBumper.b( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(-21.25, -57.9), + SparkyBumper.c( + children: [ + ScoringBehavior(points: 20), + ], + )..initialPosition = Vector2(-3.3, -52.55), SparkyComputerSensor()..initialPosition = Vector2(-13, -49.8), SparkyAnimatronic()..position = Vector2(-13.8, -58.2), ], @@ -29,52 +40,14 @@ class SparkyFireZone extends Blueprint { ); } -// TODO(alestiago): Revisit ScorePoints logic once the FlameForge2D -// ContactCallback process is enhanced. -class _SparkyBumper extends SparkyBumper with ScorePoints { - _SparkyBumper.a() : super.a(); - - _SparkyBumper.b() : super.b(); - - _SparkyBumper.c() : super.c(); - - @override - int get points => 20; - - @override - Future onLoad() async { - await super.onLoad(); - // TODO(alestiago): Revisit once this has been merged: - // https://github.com/flame-engine/flame/pull/1547 - gameRef.addContactCallback(SparkyBumperBallContactCallback()); - } -} - -/// Listens when a [Ball] bounces bounces against a [SparkyBumper]. -@visibleForTesting -class SparkyBumperBallContactCallback - extends ContactCallback { - @override - void begin( - SparkyBumper sparkyBumper, - Ball _, - Contact __, - ) { - sparkyBumper.animate(); - } -} - /// {@template sparky_computer_sensor} /// Small sensor body used to detect when a ball has entered the /// [SparkyComputer]. /// {@endtemplate} -// TODO(alestiago): Revisit once this has been merged: -// https://github.com/flame-engine/flame/pull/1547 -class SparkyComputerSensor extends BodyComponent with InitialPosition { +class SparkyComputerSensor extends BodyComponent + with InitialPosition, ContactCallbacks { /// {@macro sparky_computer_sensor} - SparkyComputerSensor() { - renderBody = false; - } + SparkyComputerSensor() : super(renderBody: false); @override Body createBody() { @@ -88,23 +61,11 @@ class SparkyComputerSensor extends BodyComponent with InitialPosition { } @override - Future onLoad() async { - await super.onLoad(); - // TODO(alestiago): Revisit once this has been merged: - // https://github.com/flame-engine/flame/pull/1547 - gameRef.addContactCallback(SparkyComputerSensorBallContactCallback()); - } -} + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! ControlledBall) return; -@visibleForTesting -// TODO(alestiago): Revisit once this has been merged: -// https://github.com/flame-engine/flame/pull/1547 -// ignore: public_member_api_docs -class SparkyComputerSensorBallContactCallback - extends ContactCallback { - @override - void begin(_, ControlledBall controlledBall, __) { - controlledBall.controller.turboCharge(); - controlledBall.gameRef.firstChild()?.playing = true; + other.controller.turboCharge(); + gameRef.firstChild()?.playing = true; } } diff --git a/lib/game/components/wall.dart b/lib/game/components/wall.dart index aaae1d23..2f180d61 100644 --- a/lib/game/components/wall.dart +++ b/lib/game/components/wall.dart @@ -42,25 +42,19 @@ class Wall extends BodyComponent { /// {@template bottom_wall} /// [Wall] located at the bottom of the board. /// -/// Collisions with [BottomWall] are listened by -/// [BottomWallBallContactCallback]. /// {@endtemplate} -class BottomWall extends Wall { +class BottomWall extends Wall with ContactCallbacks { /// {@macro bottom_wall} BottomWall() : super( start: BoardDimensions.bounds.bottomLeft.toVector2(), end: BoardDimensions.bounds.bottomRight.toVector2(), ); -} -/// {@template bottom_wall_ball_contact_callback} -/// Listens when a [ControlledBall] falls into a [BottomWall]. -/// {@endtemplate} -class BottomWallBallContactCallback - extends ContactCallback { @override - void begin(ControlledBall ball, BottomWall wall, Contact contact) { - ball.controller.lost(); + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! ControlledBall) return; + other.controller.lost(); } } diff --git a/lib/game/pinball_game.dart b/lib/game/pinball_game.dart index 374a55a1..1d483fe2 100644 --- a/lib/game/pinball_game.dart +++ b/lib/game/pinball_game.dart @@ -41,8 +41,6 @@ class PinballGame extends Forge2DGame @override Future onLoad() async { - _addContactCallbacks(); - unawaited(add(gameFlowController = GameFlowController(this))); unawaited(add(CameraController(this))); unawaited(add(Backboard.waiting(position: Vector2(0, -88)))); @@ -55,11 +53,11 @@ class PinballGame extends Forge2DGame final launcher = Launcher(); unawaited(addFromBlueprint(launcher)); unawaited(add(Board())); - unawaited(add(AlienZone())); + await addFromBlueprint(AlienZone()); + await addFromBlueprint(SparkyFireZone()); unawaited(addFromBlueprint(Slingshots())); unawaited(addFromBlueprint(DinoWalls())); - unawaited(_addBonusWord()); unawaited(addFromBlueprint(SpaceshipRamp())); unawaited( addFromBlueprint( @@ -69,17 +67,6 @@ class PinballGame extends Forge2DGame ), ); unawaited(addFromBlueprint(SpaceshipRail())); - - controller.attachTo(launcher.components.whereType().first); - await super.onLoad(); - } - - void _addContactCallbacks() { - addContactCallback(BallScorePointsCallback(this)); - addContactCallback(BottomWallBallContactCallback()); - } - - Future _addBonusWord() async { await add( GoogleWord( position: Vector2( @@ -88,6 +75,9 @@ class PinballGame extends Forge2DGame ), ), ); + + controller.attachTo(launcher.components.whereType().first); + await super.onLoad(); } } diff --git a/packages/pinball_components/lib/src/components/alien_bumper.dart b/packages/pinball_components/lib/src/components/alien_bumper/alien_bumper.dart similarity index 58% rename from packages/pinball_components/lib/src/components/alien_bumper.dart rename to packages/pinball_components/lib/src/components/alien_bumper/alien_bumper.dart index 1f96d214..abe39ae5 100644 --- a/packages/pinball_components/lib/src/components/alien_bumper.dart +++ b/packages/pinball_components/lib/src/components/alien_bumper/alien_bumper.dart @@ -4,6 +4,10 @@ import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flutter/material.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/alien_bumper/behaviors/behaviors.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +export 'cubit/alien_bumper_cubit.dart'; /// {@template alien_bumper} /// Bumper for area under the [Spaceship]. @@ -15,41 +19,75 @@ class AlienBumper extends BodyComponent with InitialPosition { required double minorRadius, required String onAssetPath, required String offAssetPath, + Iterable? children, + required this.bloc, }) : _majorRadius = majorRadius, _minorRadius = minorRadius, super( priority: RenderPriority.alienBumper, + renderBody: false, children: [ + AlienBumperBallContactBehavior(), + AlienBumperBlinkingBehavior(), _AlienBumperSpriteGroupComponent( - onAssetPath: onAssetPath, offAssetPath: offAssetPath, + onAssetPath: onAssetPath, + state: bloc.state, ), + ...?children, ], - ) { - renderBody = false; - } + ); /// {@macro alien_bumper} - AlienBumper.a() - : this._( + AlienBumper.a({ + Iterable? children, + }) : this._( majorRadius: 3.52, minorRadius: 2.97, onAssetPath: Assets.images.alienBumper.a.active.keyName, offAssetPath: Assets.images.alienBumper.a.inactive.keyName, + bloc: AlienBumperCubit(), + children: children, ); /// {@macro alien_bumper} - AlienBumper.b() - : this._( + AlienBumper.b({ + Iterable? children, + }) : this._( majorRadius: 3.19, minorRadius: 2.79, onAssetPath: Assets.images.alienBumper.b.active.keyName, offAssetPath: Assets.images.alienBumper.b.inactive.keyName, + bloc: AlienBumperCubit(), + children: children, ); + /// Creates an [AlienBumper] without any children. + /// + /// This can be used for testing [AlienBumper]'s behaviors in isolation. + // TODO(alestiago): Refactor injecting bloc once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + @visibleForTesting + AlienBumper.test({ + required this.bloc, + }) : _majorRadius = 3.52, + _minorRadius = 2.97; + final double _majorRadius; + final double _minorRadius; + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + final AlienBumperCubit bloc; + + @override + void onRemove() { + bloc.close(); + super.onRemove(); + } + @override Body createBody() { final shape = EllipseShape( @@ -63,41 +101,25 @@ class AlienBumper extends BodyComponent with InitialPosition { ); final bodyDef = BodyDef( position: initialPosition, - userData: this, ); return world.createBody(bodyDef)..createFixture(fixtureDef); } - - /// Animates the [AlienBumper]. - Future animate() async { - final spriteGroupComponent = firstChild<_AlienBumperSpriteGroupComponent>() - ?..current = AlienBumperSpriteState.inactive; - await Future.delayed(const Duration(milliseconds: 50)); - spriteGroupComponent?.current = AlienBumperSpriteState.active; - } -} - -/// Indicates the [AlienBumper]'s current sprite state. -@visibleForTesting -enum AlienBumperSpriteState { - /// A lit up bumper. - active, - - /// A dimmed bumper. - inactive, } class _AlienBumperSpriteGroupComponent - extends SpriteGroupComponent with HasGameRef { + extends SpriteGroupComponent + with HasGameRef, ParentIsA { _AlienBumperSpriteGroupComponent({ required String onAssetPath, required String offAssetPath, + required AlienBumperState state, }) : _onAssetPath = onAssetPath, _offAssetPath = offAssetPath, super( anchor: Anchor.center, position: Vector2(0, -0.1), + current: state, ); final String _onAssetPath; @@ -106,16 +128,16 @@ class _AlienBumperSpriteGroupComponent @override Future onLoad() async { await super.onLoad(); + parent.bloc.stream.listen((state) => current = state); final sprites = { - AlienBumperSpriteState.active: - Sprite(gameRef.images.fromCache(_onAssetPath)), - AlienBumperSpriteState.inactive: + AlienBumperState.active: Sprite( + gameRef.images.fromCache(_onAssetPath), + ), + AlienBumperState.inactive: Sprite(gameRef.images.fromCache(_offAssetPath)), }; this.sprites = sprites; - - current = AlienBumperSpriteState.active; size = sprites[current]!.originalSize / 10; } } diff --git a/packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior.dart new file mode 100644 index 00000000..effa3221 --- /dev/null +++ b/packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior.dart @@ -0,0 +1,14 @@ +// ignore_for_file: public_member_api_docs + +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +class AlienBumperBallContactBehavior extends ContactBehavior { + @override + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! Ball) return; + parent.bloc.onBallContacted(); + } +} diff --git a/packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior.dart b/packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior.dart new file mode 100644 index 00000000..f606ec70 --- /dev/null +++ b/packages/pinball_components/lib/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior.dart @@ -0,0 +1,39 @@ +import 'package:flame/components.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// {@template alien_bumper_blinking_behavior} +/// Makes a [AlienBumper] blink back to [AlienBumperState.active] when +/// [AlienBumperState.inactive]. +/// {@endtemplate} +class AlienBumperBlinkingBehavior extends TimerComponent + with ParentIsA { + /// {@macro alien_bumper_blinking_behavior} + AlienBumperBlinkingBehavior() : super(period: 0.05); + + void _onNewState(AlienBumperState state) { + switch (state) { + case AlienBumperState.active: + break; + case AlienBumperState.inactive: + timer + ..reset() + ..start(); + break; + } + } + + @override + Future onLoad() async { + await super.onLoad(); + timer.stop(); + parent.bloc.stream.listen(_onNewState); + } + + @override + void onTick() { + super.onTick(); + timer.stop(); + parent.bloc.onBlinked(); + } +} diff --git a/packages/pinball_components/lib/src/components/alien_bumper/behaviors/behaviors.dart b/packages/pinball_components/lib/src/components/alien_bumper/behaviors/behaviors.dart new file mode 100644 index 00000000..14762ea2 --- /dev/null +++ b/packages/pinball_components/lib/src/components/alien_bumper/behaviors/behaviors.dart @@ -0,0 +1,2 @@ +export 'alien_bumper_ball_contact_behavior.dart'; +export 'alien_bumper_blinking_behavior.dart'; diff --git a/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart b/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart new file mode 100644 index 00000000..d4319a3b --- /dev/null +++ b/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_cubit.dart @@ -0,0 +1,17 @@ +// ignore_for_file: public_member_api_docs + +import 'package:bloc/bloc.dart'; + +part 'alien_bumper_state.dart'; + +class AlienBumperCubit extends Cubit { + AlienBumperCubit() : super(AlienBumperState.active); + + void onBallContacted() { + emit(AlienBumperState.inactive); + } + + void onBlinked() { + emit(AlienBumperState.active); + } +} diff --git a/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_state.dart b/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_state.dart new file mode 100644 index 00000000..cbec959e --- /dev/null +++ b/packages/pinball_components/lib/src/components/alien_bumper/cubit/alien_bumper_state.dart @@ -0,0 +1,10 @@ +part of 'alien_bumper_cubit.dart'; + +/// Indicates the [AlienBumperCubit]'s current state. +enum AlienBumperState { + /// A lit up bumper. + active, + + /// A dimmed bumper. + inactive, +} diff --git a/packages/pinball_components/lib/src/components/ball.dart b/packages/pinball_components/lib/src/components/ball.dart index b1e2703b..1c9c1270 100644 --- a/packages/pinball_components/lib/src/components/ball.dart +++ b/packages/pinball_components/lib/src/components/ball.dart @@ -16,6 +16,7 @@ class Ball extends BodyComponent Ball({ required this.baseColor, }) : super( + renderBody: false, children: [ _BallSpriteComponent()..tint(baseColor.withOpacity(0.5)), ], @@ -26,7 +27,6 @@ class Ball extends BodyComponent // We need to see what happens if Ball appears from other place like nest // bumper, it will need to explicit change layer to Layer.board then. layer = Layer.board; - renderBody = false; } /// The size of the [Ball]. diff --git a/packages/pinball_components/lib/src/components/baseboard.dart b/packages/pinball_components/lib/src/components/baseboard.dart index 07f39070..47ba4666 100644 --- a/packages/pinball_components/lib/src/components/baseboard.dart +++ b/packages/pinball_components/lib/src/components/baseboard.dart @@ -13,10 +13,9 @@ class Baseboard extends BodyComponent with InitialPosition { required BoardSide side, }) : _side = side, super( + renderBody: false, children: [_BaseboardSpriteComponent(side: side)], - ) { - renderBody = false; - } + ); /// Whether the [Baseboard] is on the left or right side of the board. final BoardSide _side; diff --git a/packages/pinball_components/lib/src/components/boundaries.dart b/packages/pinball_components/lib/src/components/boundaries.dart index 86e1844e..2ba5ab3f 100644 --- a/packages/pinball_components/lib/src/components/boundaries.dart +++ b/packages/pinball_components/lib/src/components/boundaries.dart @@ -26,11 +26,10 @@ class _BottomBoundary extends BodyComponent with InitialPosition { /// {@macro bottom_boundary} _BottomBoundary() : super( + renderBody: false, priority: RenderPriority.bottomBoundary, children: [_BottomBoundarySpriteComponent()], - ) { - renderBody = false; - } + ); List _createFixtureDefs() { final bottomLeftCurve = BezierCurveShape( @@ -92,13 +91,10 @@ class _OuterBoundary extends BodyComponent with InitialPosition { /// {@macro outer_boundary} _OuterBoundary() : super( + renderBody: false, priority: RenderPriority.outerBoundary, - children: [ - _OuterBoundarySpriteComponent(), - ], - ) { - renderBody = false; - } + children: [_OuterBoundarySpriteComponent()], + ); List _createFixtureDefs() { final topWall = EdgeShape() diff --git a/packages/pinball_components/lib/src/components/components.dart b/packages/pinball_components/lib/src/components/components.dart index 57e93abb..5d6f5744 100644 --- a/packages/pinball_components/lib/src/components/components.dart +++ b/packages/pinball_components/lib/src/components/components.dart @@ -1,4 +1,4 @@ -export 'alien_bumper.dart'; +export 'alien_bumper/alien_bumper.dart'; export 'backboard/backboard.dart'; export 'ball.dart'; export 'baseboard.dart'; @@ -8,11 +8,11 @@ export 'boundaries.dart'; export 'camera_zoom.dart'; export 'chrome_dino.dart'; export 'dash_animatronic.dart'; -export 'dash_nest_bumper.dart'; +export 'dash_nest_bumper/dash_nest_bumper.dart'; export 'dino_walls.dart'; export 'fire_effect.dart'; export 'flipper.dart'; -export 'google_letter.dart'; +export 'google_letter/google_letter.dart'; export 'initial_position.dart'; export 'joint_anchor.dart'; export 'kicker.dart'; @@ -30,5 +30,5 @@ export 'spaceship.dart'; export 'spaceship_rail.dart'; export 'spaceship_ramp.dart'; export 'sparky_animatronic.dart'; -export 'sparky_bumper.dart'; +export 'sparky_bumper/sparky_bumper.dart'; export 'sparky_computer.dart'; diff --git a/packages/pinball_components/lib/src/components/dash_animatronic.dart b/packages/pinball_components/lib/src/components/dash_animatronic.dart index 47e1e08f..faa604e9 100644 --- a/packages/pinball_components/lib/src/components/dash_animatronic.dart +++ b/packages/pinball_components/lib/src/components/dash_animatronic.dart @@ -10,7 +10,6 @@ class DashAnimatronic extends SpriteAnimationComponent with HasGameRef { : super( anchor: Anchor.center, playing: false, - priority: RenderPriority.dashAnimatronic, ); @override diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/behaviors.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/behaviors.dart new file mode 100644 index 00000000..839cbd67 --- /dev/null +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/behaviors.dart @@ -0,0 +1 @@ +export 'dash_nest_bumper_contact_behavior.dart'; diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart new file mode 100644 index 00000000..829229e4 --- /dev/null +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart @@ -0,0 +1,15 @@ +// ignore_for_file: public_member_api_docs + +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +class DashNestBumperBallContactBehavior + extends ContactBehavior { + @override + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! Ball) return; + parent.bloc.onBallContacted(); + } +} diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart new file mode 100644 index 00000000..8fc6b157 --- /dev/null +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart @@ -0,0 +1,19 @@ +// ignore_for_file: public_member_api_docs + +import 'package:bloc/bloc.dart'; + +part 'dash_nest_bumper_state.dart'; + +class DashNestBumperCubit extends Cubit { + DashNestBumperCubit() : super(DashNestBumperState.inactive); + + /// Event added when the bumper contacts with a ball. + void onBallContacted() { + emit(DashNestBumperState.active); + } + + /// Event added when the bumper should return to its initial configuration. + void onReset() { + emit(DashNestBumperState.inactive); + } +} diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_state.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_state.dart new file mode 100644 index 00000000..c169069f --- /dev/null +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_state.dart @@ -0,0 +1,10 @@ +part of 'dash_nest_bumper_cubit.dart'; + +/// Indicates the [DashNestBumperCubit]'s current state. +enum DashNestBumperState { + /// A lit up bumper. + active, + + /// A dimmed bumper. + inactive, +} diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper.dart b/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart similarity index 63% rename from packages/pinball_components/lib/src/components/dash_nest_bumper.dart rename to packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart index 46f96b37..82ec0036 100644 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper.dart +++ b/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart @@ -4,6 +4,10 @@ import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flutter/material.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/dash_nest_bumper/behaviors/behaviors.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +export 'cubit/dash_nest_bumper_cubit.dart'; /// {@template dash_nest_bumper} /// Bumper with a nest appearance. @@ -16,54 +20,87 @@ class DashNestBumper extends BodyComponent with InitialPosition { required String activeAssetPath, required String inactiveAssetPath, required Vector2 spritePosition, + Iterable? children, + required this.bloc, }) : _majorRadius = majorRadius, _minorRadius = minorRadius, super( - priority: RenderPriority.dashBumper, + renderBody: false, children: [ _DashNestBumperSpriteGroupComponent( activeAssetPath: activeAssetPath, inactiveAssetPath: inactiveAssetPath, position: spritePosition, + current: bloc.state, ), + DashNestBumperBallContactBehavior(), + ...?children, ], - ) { - renderBody = false; - } + ); /// {@macro dash_nest_bumper} - DashNestBumper.main() - : this._( + DashNestBumper.main({ + Iterable? children, + }) : this._( majorRadius: 5.1, minorRadius: 3.75, activeAssetPath: Assets.images.dash.bumper.main.active.keyName, inactiveAssetPath: Assets.images.dash.bumper.main.inactive.keyName, spritePosition: Vector2(0, -0.3), + children: children, + bloc: DashNestBumperCubit(), ); /// {@macro dash_nest_bumper} - DashNestBumper.a() - : this._( + DashNestBumper.a({ + Iterable? children, + }) : this._( majorRadius: 3, minorRadius: 2.5, activeAssetPath: Assets.images.dash.bumper.a.active.keyName, inactiveAssetPath: Assets.images.dash.bumper.a.inactive.keyName, spritePosition: Vector2(0.35, -1.2), + children: children, + bloc: DashNestBumperCubit(), ); /// {@macro dash_nest_bumper} - DashNestBumper.b() - : this._( + DashNestBumper.b({ + Iterable? children, + }) : this._( majorRadius: 3, minorRadius: 2.5, activeAssetPath: Assets.images.dash.bumper.b.active.keyName, inactiveAssetPath: Assets.images.dash.bumper.b.inactive.keyName, spritePosition: Vector2(0.35, -1.2), + children: children, + bloc: DashNestBumperCubit(), ); + /// Creates an [DashNestBumper] without any children. + /// + /// This can be used for testing [DashNestBumper]'s behaviors in isolation. + // TODO(alestiago): Refactor injecting bloc once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + @visibleForTesting + DashNestBumper.test({required this.bloc}) + : _majorRadius = 3, + _minorRadius = 2.5; + final double _majorRadius; final double _minorRadius; + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + final DashNestBumperCubit bloc; + + @override + void onRemove() { + bloc.close(); + super.onRemove(); + } + @override Body createBody() { final shape = EllipseShape( @@ -79,41 +116,22 @@ class DashNestBumper extends BodyComponent with InitialPosition { return world.createBody(bodyDef)..createFixture(fixtureDef); } - - /// Activates the [DashNestBumper]. - void activate() { - firstChild<_DashNestBumperSpriteGroupComponent>()?.current = - DashNestBumperSpriteState.active; - } - - /// Deactivates the [DashNestBumper]. - void deactivate() { - firstChild<_DashNestBumperSpriteGroupComponent>()?.current = - DashNestBumperSpriteState.inactive; - } -} - -/// Indicates the [DashNestBumper]'s current sprite state. -@visibleForTesting -enum DashNestBumperSpriteState { - /// A lit up bumper. - active, - - /// A dimmed bumper. - inactive, } class _DashNestBumperSpriteGroupComponent - extends SpriteGroupComponent with HasGameRef { + extends SpriteGroupComponent + with HasGameRef, ParentIsA { _DashNestBumperSpriteGroupComponent({ required String activeAssetPath, required String inactiveAssetPath, required Vector2 position, + required DashNestBumperState current, }) : _activeAssetPath = activeAssetPath, _inactiveAssetPath = inactiveAssetPath, super( anchor: Anchor.center, position: position, + current: current, ); final String _activeAssetPath; @@ -122,15 +140,15 @@ class _DashNestBumperSpriteGroupComponent @override Future onLoad() async { await super.onLoad(); + parent.bloc.stream.listen((state) => current = state); + final sprites = { - DashNestBumperSpriteState.active: + DashNestBumperState.active: Sprite(gameRef.images.fromCache(_activeAssetPath)), - DashNestBumperSpriteState.inactive: + DashNestBumperState.inactive: Sprite(gameRef.images.fromCache(_inactiveAssetPath)), }; this.sprites = sprites; - - current = DashNestBumperSpriteState.inactive; size = sprites[current]!.originalSize / 10; } } diff --git a/packages/pinball_components/lib/src/components/dino_walls.dart b/packages/pinball_components/lib/src/components/dino_walls.dart index 0654d038..0e0e2efa 100644 --- a/packages/pinball_components/lib/src/components/dino_walls.dart +++ b/packages/pinball_components/lib/src/components/dino_walls.dart @@ -29,9 +29,8 @@ class _DinoTopWall extends BodyComponent with InitialPosition { : super( priority: RenderPriority.dinoTopWall, children: [_DinoTopWallSpriteComponent()], - ) { - renderBody = false; - } + renderBody: false, + ); List _createFixtureDefs() { final topStraightShape = EdgeShape() @@ -128,9 +127,8 @@ class _DinoBottomWall extends BodyComponent with InitialPosition { : super( priority: RenderPriority.dinoBottomWall, children: [_DinoBottomWallSpriteComponent()], - ) { - renderBody = false; - } + renderBody: false, + ); List _createFixtureDefs() { const restitution = 1.0; diff --git a/packages/pinball_components/lib/src/components/flipper.dart b/packages/pinball_components/lib/src/components/flipper.dart index bd826668..dccd7ce7 100644 --- a/packages/pinball_components/lib/src/components/flipper.dart +++ b/packages/pinball_components/lib/src/components/flipper.dart @@ -14,10 +14,9 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition { Flipper({ required this.side, }) : super( + renderBody: false, children: [_FlipperSpriteComponent(side: side)], - ) { - renderBody = false; - } + ); /// The size of the [Flipper]. static final size = Vector2(13.5, 4.3); diff --git a/packages/pinball_components/lib/src/components/google_letter/behaviors/behaviors.dart b/packages/pinball_components/lib/src/components/google_letter/behaviors/behaviors.dart new file mode 100644 index 00000000..df54c1f4 --- /dev/null +++ b/packages/pinball_components/lib/src/components/google_letter/behaviors/behaviors.dart @@ -0,0 +1 @@ +export 'google_letter_ball_contact_behavior.dart'; diff --git a/packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart new file mode 100644 index 00000000..c3f0423e --- /dev/null +++ b/packages/pinball_components/lib/src/components/google_letter/behaviors/google_letter_ball_contact_behavior.dart @@ -0,0 +1,14 @@ +// ignore_for_file: public_member_api_docs + +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +class GoogleLetterBallContactBehavior extends ContactBehavior { + @override + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! Ball) return; + parent.bloc.onBallContacted(); + } +} diff --git a/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart new file mode 100644 index 00000000..a352e98d --- /dev/null +++ b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_cubit.dart @@ -0,0 +1,17 @@ +// ignore_for_file: public_member_api_docs + +import 'package:bloc/bloc.dart'; + +part 'google_letter_state.dart'; + +class GoogleLetterCubit extends Cubit { + GoogleLetterCubit() : super(GoogleLetterState.inactive); + + void onBallContacted() { + emit(GoogleLetterState.active); + } + + void onReset() { + emit(GoogleLetterState.inactive); + } +} diff --git a/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart new file mode 100644 index 00000000..e1339320 --- /dev/null +++ b/packages/pinball_components/lib/src/components/google_letter/cubit/google_letter_state.dart @@ -0,0 +1,10 @@ +part of 'google_letter_cubit.dart'; + +/// Indicates the [GoogleLetterCubit]'s current state. +enum GoogleLetterState { + /// A lit up letter. + active, + + /// A dimmed letter. + inactive, +} diff --git a/packages/pinball_components/lib/src/components/google_letter.dart b/packages/pinball_components/lib/src/components/google_letter/google_letter.dart similarity index 52% rename from packages/pinball_components/lib/src/components/google_letter.dart rename to packages/pinball_components/lib/src/components/google_letter/google_letter.dart index 43a4c113..63207e01 100644 --- a/packages/pinball_components/lib/src/components/google_letter.dart +++ b/packages/pinball_components/lib/src/components/google_letter/google_letter.dart @@ -1,33 +1,46 @@ import 'package:flame/components.dart'; -import 'package:flame/effects.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flutter/material.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/google_letter/behaviors/behaviors.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +export 'cubit/google_letter_cubit.dart'; /// {@template google_letter} /// Circular sensor that represents a letter in "GOOGLE" for a given index. /// {@endtemplate} class GoogleLetter extends BodyComponent with InitialPosition { /// {@macro google_letter} - GoogleLetter(int index) - : _sprite = _GoogleLetterSprite( - _GoogleLetterSprite.spritePaths[index], + GoogleLetter( + int index, + ) : bloc = GoogleLetterCubit(), + super( + children: [ + GoogleLetterBallContactBehavior(), + _GoogleLetterSprite(_GoogleLetterSprite.spritePaths[index]) + ], ); - final _GoogleLetterSprite _sprite; - - /// Activates this [GoogleLetter]. - // TODO(alestiago): Improve doc comment once activate and deactivate - // are implemented with the actual assets. - Future activate() => _sprite.activate(); + /// Creates a [GoogleLetter] without any children. + /// + /// This can be used for testing [GoogleLetter]'s behaviors in isolation. + // TODO(alestiago): Refactor injecting bloc once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + @visibleForTesting + GoogleLetter.test({ + required this.bloc, + }); - /// Deactivates this [GoogleLetter]. - Future deactivate() => _sprite.deactivate(); + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + final GoogleLetterCubit bloc; @override - Future onLoad() async { - await super.onLoad(); - await add(_sprite); + void onRemove() { + bloc.close(); + super.onRemove(); } @override @@ -46,8 +59,11 @@ class GoogleLetter extends BodyComponent with InitialPosition { } } -class _GoogleLetterSprite extends SpriteComponent with HasGameRef { - _GoogleLetterSprite(String path) : _path = path; +class _GoogleLetterSprite extends SpriteComponent + with HasGameRef, ParentIsA { + _GoogleLetterSprite(String path) + : _path = path, + super(anchor: Anchor.center); static final spritePaths = [ Assets.images.googleWord.letter1.keyName, @@ -60,39 +76,16 @@ class _GoogleLetterSprite extends SpriteComponent with HasGameRef { final String _path; - // TODO(alestiago): Correctly implement activate and deactivate once the - // assets are provided. - Future activate() async { - await add( - _GoogleLetterColorEffect(color: Colors.green), - ); - } - - Future deactivate() async { - await add( - _GoogleLetterColorEffect(color: Colors.red), - ); - } - @override Future onLoad() async { await super.onLoad(); + // TODO(alisonryan2002): Make SpriteGroupComponent. + // parent.bloc.stream.listen(); // TODO(alestiago): Used cached assets. final sprite = await gameRef.loadSprite(_path); this.sprite = sprite; // TODO(alestiago): Size correctly once the assets are provided. size = sprite.originalSize / 5; - anchor = Anchor.center; } } - -class _GoogleLetterColorEffect extends ColorEffect { - _GoogleLetterColorEffect({ - required Color color, - }) : super( - color, - const Offset(0, 1), - EffectController(duration: 0.25), - ); -} diff --git a/packages/pinball_components/lib/src/components/kicker.dart b/packages/pinball_components/lib/src/components/kicker.dart index f6963d7c..12cd638d 100644 --- a/packages/pinball_components/lib/src/components/kicker.dart +++ b/packages/pinball_components/lib/src/components/kicker.dart @@ -19,9 +19,8 @@ class Kicker extends BodyComponent with InitialPosition { }) : _side = side, super( children: [_KickerSpriteComponent(side: side)], - ) { - renderBody = false; - } + renderBody: false, + ); /// The size of the [Kicker] body. static final Vector2 size = Vector2(4.4, 15); diff --git a/packages/pinball_components/lib/src/components/launch_ramp.dart b/packages/pinball_components/lib/src/components/launch_ramp.dart index baa54744..13f063b6 100644 --- a/packages/pinball_components/lib/src/components/launch_ramp.dart +++ b/packages/pinball_components/lib/src/components/launch_ramp.dart @@ -32,13 +32,13 @@ class _LaunchRampBase extends BodyComponent with Layered { _LaunchRampBase() : super( priority: RenderPriority.launchRamp, + renderBody: false, children: [ _LaunchRampBackgroundRailingSpriteComponent(), _LaunchRampBaseSpriteComponent(), ], ) { layer = Layer.launcher; - renderBody = false; } // TODO(ruimiguel): final asset differs slightly from the current shape. We @@ -107,13 +107,6 @@ class _LaunchRampBase extends BodyComponent with Layered { return body; } - - @override - Future onLoad() async { - await super.onLoad(); - gameRef - .addContactCallback(LayerSensorBallContactCallback<_LaunchRampExit>()); - } } class _LaunchRampBaseSpriteComponent extends SpriteComponent with HasGameRef { @@ -157,9 +150,8 @@ class _LaunchRampForegroundRailing extends BodyComponent { : super( priority: RenderPriority.launchRampForegroundRailing, children: [_LaunchRampForegroundRailingSpriteComponent()], - ) { - renderBody = false; - } + renderBody: false, + ); List _createFixtureDefs() { final fixturesDef = []; @@ -218,9 +210,8 @@ class _LaunchRampForegroundRailingSpriteComponent extends SpriteComponent } class _LaunchRampCloseWall extends BodyComponent with InitialPosition, Layered { - _LaunchRampCloseWall() { + _LaunchRampCloseWall() : super(renderBody: false) { layer = Layer.board; - renderBody = false; } @override @@ -252,7 +243,6 @@ class _LaunchRampExit extends LayerSensor { outsidePriority: RenderPriority.ballOnBoard, ) { layer = Layer.launcher; - renderBody = false; } static final Vector2 _size = Vector2(1.6, 0.1); diff --git a/packages/pinball_components/lib/src/components/layer_sensor.dart b/packages/pinball_components/lib/src/components/layer_sensor.dart index 85cc8506..7a749357 100644 --- a/packages/pinball_components/lib/src/components/layer_sensor.dart +++ b/packages/pinball_components/lib/src/components/layer_sensor.dart @@ -17,13 +17,11 @@ enum LayerEntranceOrientation { /// {@template layer_sensor} /// [BodyComponent] located at the entrance and exit of a [Layer]. /// -/// [LayerSensorBallContactCallback] detects when a [Ball] passes -/// through this sensor. -/// /// By default the base [layer] is set to [Layer.board] and the /// [outsidePriority] is set to the lowest possible [Layer]. /// {@endtemplate} -abstract class LayerSensor extends BodyComponent with InitialPosition, Layered { +abstract class LayerSensor extends BodyComponent + with InitialPosition, Layered, ContactCallbacks { /// {@macro layer_sensor} LayerSensor({ required Layer insideLayer, @@ -34,7 +32,8 @@ abstract class LayerSensor extends BodyComponent with InitialPosition, Layered { }) : _insideLayer = insideLayer, _outsideLayer = outsideLayer ?? Layer.board, _insidePriority = insidePriority, - _outsidePriority = outsidePriority ?? RenderPriority.ballOnBoard { + _outsidePriority = outsidePriority ?? RenderPriority.ballOnBoard, + super(renderBody: false) { layer = Layer.opening; } final Layer _insideLayer; @@ -75,35 +74,29 @@ abstract class LayerSensor extends BodyComponent with InitialPosition, Layered { return world.createBody(bodyDef)..createFixture(fixtureDef); } -} -/// {@template layer_sensor_ball_contact_callback} -/// Detects when a [Ball] enters or exits a [Layer] through a [LayerSensor]. -/// -/// Modifies [Ball]'s [Layer] and render priority depending on whether the -/// [Ball] is on or outside of a [Layer]. -/// {@endtemplate} -class LayerSensorBallContactCallback - extends ContactCallback { @override - void begin(Ball ball, LayerEntrance layerEntrance, Contact _) { - if (ball.layer != layerEntrance.insideLayer) { + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! Ball) return; + + if (other.layer != insideLayer) { final isBallEnteringOpening = - (layerEntrance.orientation == LayerEntranceOrientation.down && - ball.body.linearVelocity.y < 0) || - (layerEntrance.orientation == LayerEntranceOrientation.up && - ball.body.linearVelocity.y > 0); + (orientation == LayerEntranceOrientation.down && + other.body.linearVelocity.y < 0) || + (orientation == LayerEntranceOrientation.up && + other.body.linearVelocity.y > 0); if (isBallEnteringOpening) { - ball - ..layer = layerEntrance.insideLayer - ..priority = layerEntrance.insidePriority + other + ..layer = insideLayer + ..priority = insidePriority ..reorderChildren(); } } else { - ball - ..layer = layerEntrance.outsideLayer - ..priority = layerEntrance.outsidePriority + other + ..layer = outsideLayer + ..priority = outsidePriority ..reorderChildren(); } } diff --git a/packages/pinball_components/lib/src/components/plunger.dart b/packages/pinball_components/lib/src/components/plunger.dart index 295c799d..735a5490 100644 --- a/packages/pinball_components/lib/src/components/plunger.dart +++ b/packages/pinball_components/lib/src/components/plunger.dart @@ -14,9 +14,11 @@ class Plunger extends BodyComponent with InitialPosition, Layered { required this.compressionDistance, // TODO(ruimiguel): set to priority +1 over LaunchRamp once all priorities // are fixed. - }) : super(priority: RenderPriority.plunger) { + }) : super( + priority: RenderPriority.plunger, + renderBody: false, + ) { layer = Layer.launcher; - renderBody = false; } /// Distance the plunger can lower. diff --git a/packages/pinball_components/lib/src/components/render_priority.dart b/packages/pinball_components/lib/src/components/render_priority.dart index d2438db9..cf523029 100644 --- a/packages/pinball_components/lib/src/components/render_priority.dart +++ b/packages/pinball_components/lib/src/components/render_priority.dart @@ -69,11 +69,7 @@ abstract class RenderPriority { // Flutter Forest - static const int signpost = _above + launchRampForegroundRailing; - - static const int dashBumper = _above + ballOnBoard; - - static const int dashAnimatronic = 2 * _above + launchRamp; + static const int flutterForest = _above + launchRampForegroundRailing; // Sparky Fire Zone diff --git a/packages/pinball_components/lib/src/components/signpost.dart b/packages/pinball_components/lib/src/components/signpost.dart index 175c3382..13425342 100644 --- a/packages/pinball_components/lib/src/components/signpost.dart +++ b/packages/pinball_components/lib/src/components/signpost.dart @@ -46,13 +46,15 @@ extension on SignpostSpriteState { /// {@endtemplate} class Signpost extends BodyComponent with InitialPosition { /// {@macro signpost} - Signpost() - : super( - priority: RenderPriority.signpost, - children: [_SignpostSpriteComponent()], - ) { - renderBody = false; - } + Signpost({ + Iterable? children, + }) : super( + renderBody: false, + children: [ + _SignpostSpriteComponent(), + ...?children, + ], + ); /// Forwards the sprite to the next [SignpostSpriteState]. /// diff --git a/packages/pinball_components/lib/src/components/slingshot.dart b/packages/pinball_components/lib/src/components/slingshot.dart index 35346584..b48bf2f9 100644 --- a/packages/pinball_components/lib/src/components/slingshot.dart +++ b/packages/pinball_components/lib/src/components/slingshot.dart @@ -40,9 +40,8 @@ class Slingshot extends BodyComponent with InitialPosition { super( priority: RenderPriority.slingshot, children: [_SlinghsotSpriteComponent(spritePath, angle: angle)], - ) { - renderBody = false; - } + renderBody: false, + ); final double _length; diff --git a/packages/pinball_components/lib/src/components/spaceship.dart b/packages/pinball_components/lib/src/components/spaceship.dart index 4ea4e05a..a52df81d 100644 --- a/packages/pinball_components/lib/src/components/spaceship.dart +++ b/packages/pinball_components/lib/src/components/spaceship.dart @@ -42,25 +42,12 @@ class SpaceshipSaucer extends BodyComponent with InitialPosition, Layered { SpaceshipSaucer() : super( priority: RenderPriority.spaceshipSaucer, + renderBody: false, children: [ _SpaceshipSaucerSpriteComponent(), ], ) { layer = Layer.spaceship; - renderBody = false; - } - - @override - Future onLoad() async { - await super.onLoad(); - - gameRef - ..addContactCallback( - LayerSensorBallContactCallback<_SpaceshipEntrance>(), - ) - ..addContactCallback( - LayerSensorBallContactCallback<_SpaceshipHole>(), - ); } @override @@ -108,8 +95,8 @@ class AndroidHead extends BodyComponent with InitialPosition, Layered { : super( priority: RenderPriority.androidHead, children: [_AndroidHeadSpriteAnimation()], + renderBody: false, ) { - renderBody = false; layer = Layer.spaceship; } @@ -164,7 +151,6 @@ class _SpaceshipEntrance extends LayerSensor { @override Shape get shape { - renderBody = false; final radius = Spaceship.size.y / 2; return PolygonShape() ..setAsEdge( @@ -189,7 +175,6 @@ class _SpaceshipHole extends LayerSensor { insidePriority: RenderPriority.ballOnSpaceship, outsidePriority: outsidePriority, ) { - renderBody = false; layer = Layer.spaceship; } @@ -237,14 +222,16 @@ class _SpaceshipWallShape extends ChainShape { /// {@endtemplate} class SpaceshipWall extends BodyComponent with InitialPosition, Layered { /// {@macro spaceship_wall} - SpaceshipWall() : super(priority: RenderPriority.spaceshipSaucerWall) { + SpaceshipWall() + : super( + priority: RenderPriority.spaceshipSaucerWall, + renderBody: false, + ) { layer = Layer.spaceship; } @override Body createBody() { - renderBody = false; - final shape = _SpaceshipWallShape(); final fixtureDef = FixtureDef(shape); diff --git a/packages/pinball_components/lib/src/components/spaceship_rail.dart b/packages/pinball_components/lib/src/components/spaceship_rail.dart index 1175384b..3dfd2c1c 100644 --- a/packages/pinball_components/lib/src/components/spaceship_rail.dart +++ b/packages/pinball_components/lib/src/components/spaceship_rail.dart @@ -29,10 +29,10 @@ class _SpaceshipRailRamp extends BodyComponent with Layered { _SpaceshipRailRamp() : super( priority: RenderPriority.spaceshipRail, + renderBody: false, children: [_SpaceshipRailRampSpriteComponent()], ) { layer = Layer.spaceshipExitRail; - renderBody = false; } List _createFixtureDefs() { @@ -114,14 +114,6 @@ class _SpaceshipRailRamp extends BodyComponent with Layered { _createFixtureDefs().forEach(body.createFixture); return body; } - - @override - Future onLoad() async { - await super.onLoad(); - gameRef.addContactCallback( - LayerSensorBallContactCallback<_SpaceshipRailExit>(), - ); - } } class _SpaceshipRailRampSpriteComponent extends SpriteComponent @@ -160,9 +152,7 @@ class _SpaceshipRailForeground extends SpriteComponent with HasGameRef { /// Represents the ground bases of the [_SpaceshipRailRamp]. class _SpaceshipRailBase extends BodyComponent with InitialPosition { - _SpaceshipRailBase({required this.radius}) { - renderBody = false; - } + _SpaceshipRailBase({required this.radius}) : super(renderBody: false); final double radius; @@ -185,7 +175,6 @@ class _SpaceshipRailExit extends LayerSensor { insideLayer: Layer.spaceshipExitRail, insidePriority: RenderPriority.ballOnSpaceshipRail, ) { - renderBody = false; layer = Layer.spaceshipExitRail; } diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp.dart b/packages/pinball_components/lib/src/components/spaceship_ramp.dart index 30211251..c9a1d574 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp.dart @@ -98,12 +98,12 @@ class _SpaceshipRampBackground extends BodyComponent _SpaceshipRampBackground() : super( priority: RenderPriority.spaceshipRamp, + renderBody: false, children: [ _SpaceshipRampBackgroundRampSpriteComponent(), ], ) { layer = Layer.spaceshipEntranceRamp; - renderBody = false; } /// Width between walls of the ramp. @@ -145,14 +145,6 @@ class _SpaceshipRampBackground extends BodyComponent return body; } - - @override - Future onLoad() async { - await super.onLoad(); - gameRef.addContactCallback( - LayerSensorBallContactCallback<_SpaceshipRampOpening>(), - ); - } } class _SpaceshipRampBackgroundRailingSpriteComponent extends SpriteComponent @@ -255,10 +247,10 @@ class _SpaceshipRampForegroundRailing extends BodyComponent _SpaceshipRampForegroundRailing() : super( priority: RenderPriority.spaceshipRampForegroundRailing, + renderBody: false, children: [_SpaceshipRampForegroundRailingSpriteComponent()], ) { layer = Layer.spaceshipEntranceRamp; - renderBody = false; } List _createFixtureDefs() { @@ -321,8 +313,7 @@ class _SpaceshipRampForegroundRailingSpriteComponent extends SpriteComponent } class _SpaceshipRampBase extends BodyComponent with InitialPosition, Layered { - _SpaceshipRampBase() { - renderBody = false; + _SpaceshipRampBase() : super(renderBody: false) { layer = Layer.board; } @@ -363,9 +354,7 @@ class _SpaceshipRampOpening extends LayerSensor { orientation: LayerEntranceOrientation.down, insidePriority: RenderPriority.ballOnSpaceshipRamp, outsidePriority: outsidePriority, - ) { - renderBody = false; - } + ); final double _rotation; diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/behaviors.dart b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/behaviors.dart new file mode 100644 index 00000000..faaa510b --- /dev/null +++ b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/behaviors.dart @@ -0,0 +1,2 @@ +export 'sparky_bumper_ball_contact_behavior.dart'; +export 'sparky_bumper_blinking_behavior.dart'; diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart new file mode 100644 index 00000000..57db300c --- /dev/null +++ b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior.dart @@ -0,0 +1,14 @@ +// ignore_for_file: public_member_api_docs + +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +class SparkyBumperBallContactBehavior extends ContactBehavior { + @override + void beginContact(Object other, Contact contact) { + super.beginContact(other, contact); + if (other is! Ball) return; + parent.bloc.onBallContacted(); + } +} diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior.dart b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior.dart new file mode 100644 index 00000000..81cfa5e1 --- /dev/null +++ b/packages/pinball_components/lib/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior.dart @@ -0,0 +1,39 @@ +import 'package:flame/components.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// {@template sparky_bumper_blinking_behavior} +/// Makes a [SparkyBumper] blink back to [SparkyBumperState.active] when +/// [SparkyBumperState.inactive]. +/// {@endtemplate} +class SparkyBumperBlinkingBehavior extends TimerComponent + with ParentIsA { + /// {@macro sparky_bumper_sprite_behavior} + SparkyBumperBlinkingBehavior() : super(period: 0.05); + + void _onNewState(SparkyBumperState state) { + switch (state) { + case SparkyBumperState.active: + break; + case SparkyBumperState.inactive: + timer + ..reset() + ..start(); + break; + } + } + + @override + Future onLoad() async { + await super.onLoad(); + timer.stop(); + parent.bloc.stream.listen(_onNewState); + } + + @override + void onTick() { + super.onTick(); + timer.stop(); + parent.bloc.onBlinked(); + } +} diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart new file mode 100644 index 00000000..bbb9b63b --- /dev/null +++ b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_cubit.dart @@ -0,0 +1,17 @@ +// ignore_for_file: public_member_api_docs + +import 'package:bloc/bloc.dart'; + +part 'sparky_bumper_state.dart'; + +class SparkyBumperCubit extends Cubit { + SparkyBumperCubit() : super(SparkyBumperState.active); + + void onBallContacted() { + emit(SparkyBumperState.inactive); + } + + void onBlinked() { + emit(SparkyBumperState.active); + } +} diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart new file mode 100644 index 00000000..35cc5ffa --- /dev/null +++ b/packages/pinball_components/lib/src/components/sparky_bumper/cubit/sparky_bumper_state.dart @@ -0,0 +1,10 @@ +part of 'sparky_bumper_cubit.dart'; + +/// Indicates the [SparkyBumperCubit]'s current state. +enum SparkyBumperState { + /// A lit up bumper. + active, + + /// A dimmed bumper. + inactive, +} diff --git a/packages/pinball_components/lib/src/components/sparky_bumper.dart b/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart similarity index 57% rename from packages/pinball_components/lib/src/components/sparky_bumper.dart rename to packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart index becac26b..d6434375 100644 --- a/packages/pinball_components/lib/src/components/sparky_bumper.dart +++ b/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart @@ -4,6 +4,10 @@ import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flutter/material.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/sparky_bumper/behaviors/behaviors.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +export 'cubit/sparky_bumper_cubit.dart'; /// {@template sparky_bumper} /// Bumper for Sparky area. @@ -16,58 +20,92 @@ class SparkyBumper extends BodyComponent with InitialPosition { required String onAssetPath, required String offAssetPath, required Vector2 spritePosition, + required this.bloc, + Iterable? children, }) : _majorRadius = majorRadius, _minorRadius = minorRadius, super( priority: RenderPriority.sparkyBumper, + renderBody: false, children: [ + SparkyBumperBallContactBehavior(), + SparkyBumperBlinkingBehavior(), _SparkyBumperSpriteGroupComponent( onAssetPath: onAssetPath, offAssetPath: offAssetPath, position: spritePosition, + state: bloc.state, ), + ...?children, ], - ) { - renderBody = false; - } + ); /// {@macro sparky_bumper} - SparkyBumper.a() - : this._( + SparkyBumper.a({ + Iterable? children, + }) : this._( majorRadius: 2.9, minorRadius: 2.1, onAssetPath: Assets.images.sparky.bumper.a.active.keyName, offAssetPath: Assets.images.sparky.bumper.a.inactive.keyName, spritePosition: Vector2(0, -0.25), + bloc: SparkyBumperCubit(), + children: children, ); /// {@macro sparky_bumper} - SparkyBumper.b() - : this._( + SparkyBumper.b({ + Iterable? children, + }) : this._( majorRadius: 2.85, minorRadius: 2, onAssetPath: Assets.images.sparky.bumper.b.active.keyName, offAssetPath: Assets.images.sparky.bumper.b.inactive.keyName, spritePosition: Vector2(0, -0.35), + bloc: SparkyBumperCubit(), + children: children, ); /// {@macro sparky_bumper} - SparkyBumper.c() - : this._( + SparkyBumper.c({ + Iterable? children, + }) : this._( majorRadius: 3, minorRadius: 2.2, onAssetPath: Assets.images.sparky.bumper.c.active.keyName, offAssetPath: Assets.images.sparky.bumper.c.inactive.keyName, spritePosition: Vector2(0, -0.4), + bloc: SparkyBumperCubit(), + children: children, ); + /// Creates an [SparkyBumper] without any children. + /// + /// This can be used for testing [SparkyBumper]'s behaviors in isolation. + // TODO(alestiago): Refactor injecting bloc once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + @visibleForTesting + SparkyBumper.test({ + required this.bloc, + }) : _majorRadius = 3, + _minorRadius = 2.2; + final double _majorRadius; final double _minorRadius; + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + final SparkyBumperCubit bloc; + @override - Body createBody() { - renderBody = false; + void onRemove() { + bloc.close(); + super.onRemove(); + } + @override + Body createBody() { final shape = EllipseShape( center: Vector2.zero(), majorRadius: _majorRadius, @@ -83,37 +121,22 @@ class SparkyBumper extends BodyComponent with InitialPosition { return world.createBody(bodyDef)..createFixture(fixtureDef); } - - /// Animates the [DashNestBumper]. - Future animate() async { - final spriteGroupComponent = firstChild<_SparkyBumperSpriteGroupComponent>() - ?..current = SparkyBumperSpriteState.inactive; - await Future.delayed(const Duration(milliseconds: 50)); - spriteGroupComponent?.current = SparkyBumperSpriteState.active; - } -} - -/// Indicates the [SparkyBumper]'s current sprite state. -@visibleForTesting -enum SparkyBumperSpriteState { - /// A lit up bumper. - active, - - /// A dimmed bumper. - inactive, } class _SparkyBumperSpriteGroupComponent - extends SpriteGroupComponent with HasGameRef { + extends SpriteGroupComponent + with HasGameRef, ParentIsA { _SparkyBumperSpriteGroupComponent({ required String onAssetPath, required String offAssetPath, required Vector2 position, + required SparkyBumperState state, }) : _onAssetPath = onAssetPath, _offAssetPath = offAssetPath, super( anchor: Anchor.center, position: position, + current: state, ); final String _onAssetPath; @@ -122,15 +145,20 @@ class _SparkyBumperSpriteGroupComponent @override Future onLoad() async { await super.onLoad(); + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + parent.bloc.stream.listen((state) => current = state); + final sprites = { - SparkyBumperSpriteState.active: - Sprite(gameRef.images.fromCache(_onAssetPath)), - SparkyBumperSpriteState.inactive: - Sprite(gameRef.images.fromCache(_offAssetPath)), + SparkyBumperState.active: Sprite( + gameRef.images.fromCache(_onAssetPath), + ), + SparkyBumperState.inactive: Sprite( + gameRef.images.fromCache(_offAssetPath), + ), }; this.sprites = sprites; - - current = SparkyBumperSpriteState.active; size = sprites[current]!.originalSize / 10; } } diff --git a/packages/pinball_components/lib/src/components/sparky_computer.dart b/packages/pinball_components/lib/src/components/sparky_computer.dart index 481de63d..7f0cef8c 100644 --- a/packages/pinball_components/lib/src/components/sparky_computer.dart +++ b/packages/pinball_components/lib/src/components/sparky_computer.dart @@ -23,10 +23,9 @@ class _ComputerBase extends BodyComponent with InitialPosition { _ComputerBase() : super( priority: RenderPriority.computerBase, + renderBody: false, children: [_ComputerBaseSpriteComponent()], - ) { - renderBody = false; - } + ); List _createFixtureDefs() { final leftEdge = EdgeShape() diff --git a/packages/pinball_components/pubspec.yaml b/packages/pinball_components/pubspec.yaml index a7cb8367..27bf0aec 100644 --- a/packages/pinball_components/pubspec.yaml +++ b/packages/pinball_components/pubspec.yaml @@ -7,8 +7,13 @@ environment: sdk: ">=2.16.0 <3.0.0" dependencies: + bloc: ^8.0.3 flame: ^1.1.1 - flame_forge2d: ^0.11.0 + flame_forge2d: + git: + url: https://github.com/flame-engine/flame/ + path: packages/flame_forge2d/ + ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f flutter: sdk: flutter geometry: @@ -19,8 +24,8 @@ dependencies: pinball_theme: path: ../pinball_theme - dev_dependencies: + bloc_test: ^9.0.3 flame_test: ^1.3.0 flutter_test: sdk: flutter diff --git a/packages/pinball_components/sandbox/lib/stories/google_word/google_letter_game.dart b/packages/pinball_components/sandbox/lib/stories/google_word/google_letter_game.dart index d8022e57..be90fdb9 100644 --- a/packages/pinball_components/sandbox/lib/stories/google_word/google_letter_game.dart +++ b/packages/pinball_components/sandbox/lib/stories/google_word/google_letter_game.dart @@ -17,7 +17,6 @@ class GoogleLetterGame extends BallGame { @override Future onLoad() async { await super.onLoad(); - addContactCallback(_BallGoogleLetterContactCallback()); camera.followVector2(Vector2.zero()); await add(GoogleLetter(0)); @@ -25,12 +24,3 @@ class GoogleLetterGame extends BallGame { await traceAllBodies(); } } - -class _BallGoogleLetterContactCallback - extends ContactCallback { - @override - void begin(Ball a, GoogleLetter b, Contact contact) { - super.begin(a, b, contact); - b.activate(); - } -} diff --git a/packages/pinball_components/sandbox/pubspec.lock b/packages/pinball_components/sandbox/pubspec.lock index d7ab8901..8d61da32 100644 --- a/packages/pinball_components/sandbox/pubspec.lock +++ b/packages/pinball_components/sandbox/pubspec.lock @@ -102,9 +102,11 @@ packages: flame_forge2d: dependency: "direct main" description: - name: flame_forge2d - url: "https://pub.dartlang.org" - source: hosted + path: "packages/flame_forge2d" + ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f + resolved-ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f + url: "https://github.com/flame-engine/flame/" + source: git version: "0.11.0" flutter: dependency: "direct main" @@ -169,7 +171,7 @@ packages: name: js url: "https://pub.dartlang.org" source: hosted - version: "0.6.3" + version: "0.6.4" json_annotation: dependency: transitive description: @@ -197,7 +199,7 @@ packages: name: material_color_utilities url: "https://pub.dartlang.org" source: hosted - version: "0.1.3" + version: "0.1.4" meta: dependency: transitive description: @@ -218,7 +220,7 @@ packages: name: path url: "https://pub.dartlang.org" source: hosted - version: "1.8.0" + version: "1.8.1" path_provider_linux: dependency: transitive description: @@ -349,7 +351,7 @@ packages: name: source_span url: "https://pub.dartlang.org" source: hosted - version: "1.8.1" + version: "1.8.2" stack_trace: dependency: transitive description: @@ -384,7 +386,7 @@ packages: name: test_api url: "https://pub.dartlang.org" source: hosted - version: "0.4.8" + version: "0.4.9" typed_data: dependency: transitive description: @@ -454,7 +456,7 @@ packages: name: vector_math url: "https://pub.dartlang.org" source: hosted - version: "2.1.1" + version: "2.1.2" very_good_analysis: dependency: "direct dev" description: diff --git a/packages/pinball_components/sandbox/pubspec.yaml b/packages/pinball_components/sandbox/pubspec.yaml index dd9f8259..d663cb04 100644 --- a/packages/pinball_components/sandbox/pubspec.yaml +++ b/packages/pinball_components/sandbox/pubspec.yaml @@ -9,7 +9,11 @@ environment: dependencies: dashbook: ^0.1.7 flame: ^1.1.1 - flame_forge2d: ^0.11.0 + flame_forge2d: + git: + url: https://github.com/flame-engine/flame/ + path: packages/flame_forge2d/ + ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f flutter: sdk: flutter pinball_components: diff --git a/packages/pinball_components/test/helpers/mocks.dart b/packages/pinball_components/test/helpers/mocks.dart index 520555df..d69a6131 100644 --- a/packages/pinball_components/test/helpers/mocks.dart +++ b/packages/pinball_components/test/helpers/mocks.dart @@ -15,7 +15,12 @@ class MockGame extends Mock implements Forge2DGame {} class MockContact extends Mock implements Contact {} -class MockContactCallback extends Mock - implements ContactCallback {} - class MockComponent extends Mock implements Component {} + +class MockAlienBumperCubit extends Mock implements AlienBumperCubit {} + +class MockGoogleLetterCubit extends Mock implements GoogleLetterCubit {} + +class MockSparkyBumperCubit extends Mock implements SparkyBumperCubit {} + +class MockDashNestBumperCubit extends Mock implements DashNestBumperCubit {} diff --git a/packages/pinball_components/test/src/components/alien_bumper/alien_bumper_test.dart b/packages/pinball_components/test/src/components/alien_bumper/alien_bumper_test.dart new file mode 100644 index 00000000..be34d4f8 --- /dev/null +++ b/packages/pinball_components/test/src/components/alien_bumper/alien_bumper_test.dart @@ -0,0 +1,78 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame/components.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/alien_bumper/behaviors/behaviors.dart'; + +import '../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final assets = [ + Assets.images.alienBumper.a.active.keyName, + Assets.images.alienBumper.a.inactive.keyName, + Assets.images.alienBumper.b.active.keyName, + Assets.images.alienBumper.b.inactive.keyName, + ]; + final flameTester = FlameTester(() => TestGame(assets)); + + group('AlienBumper', () { + flameTester.test('"a" loads correctly', (game) async { + final alienBumper = AlienBumper.a(); + await game.ensureAdd(alienBumper); + expect(game.contains(alienBumper), isTrue); + }); + + flameTester.test('"b" loads correctly', (game) async { + final alienBumper = AlienBumper.b(); + await game.ensureAdd(alienBumper); + expect(game.contains(alienBumper), isTrue); + }); + + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + flameTester.test('closes bloc when removed', (game) async { + final bloc = MockAlienBumperCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: AlienBumperState.active, + ); + when(bloc.close).thenAnswer((_) async {}); + final alienBumper = AlienBumper.test(bloc: bloc); + + await game.ensureAdd(alienBumper); + game.remove(alienBumper); + await game.ready(); + + verify(bloc.close).called(1); + }); + + group('adds', () { + flameTester.test('new children', (game) async { + final component = Component(); + final alienBumper = AlienBumper.a( + children: [component], + ); + await game.ensureAdd(alienBumper); + expect(alienBumper.children, contains(component)); + }); + + flameTester.test('an AlienBumperBallContactBehavior', (game) async { + final alienBumper = AlienBumper.a(); + await game.ensureAdd(alienBumper); + expect( + alienBumper.children + .whereType() + .single, + isNotNull, + ); + }); + }); + }); +} diff --git a/packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior_test.dart b/packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior_test.dart new file mode 100644 index 00000000..93904958 --- /dev/null +++ b/packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_ball_contact_behavior_test.dart @@ -0,0 +1,48 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/alien_bumper/behaviors/behaviors.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(TestGame.new); + + group( + 'AlienBumperBallContactBehavior', + () { + test('can be instantiated', () { + expect( + AlienBumperBallContactBehavior(), + isA(), + ); + }); + + flameTester.test( + 'beginContact emits onBallContacted when contacts with a ball', + (game) async { + final behavior = AlienBumperBallContactBehavior(); + final bloc = MockAlienBumperCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: AlienBumperState.active, + ); + + final alienBumper = AlienBumper.test(bloc: bloc); + await alienBumper.add(behavior); + await game.ensureAdd(alienBumper); + + behavior.beginContact(MockBall(), MockContact()); + + verify(alienBumper.bloc.onBallContacted).called(1); + }, + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior_test.dart b/packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior_test.dart new file mode 100644 index 00000000..e8e5a571 --- /dev/null +++ b/packages/pinball_components/test/src/components/alien_bumper/behaviors/alien_bumper_blinking_behavior_test.dart @@ -0,0 +1,45 @@ +import 'dart:async'; + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/alien_bumper/behaviors/behaviors.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(TestGame.new); + + group( + 'AlienBumperBlinkingBehavior', + () { + flameTester.testGameWidget( + 'calls onBlinked after 0.05 seconds when inactive', + setUp: (game, tester) async { + final behavior = AlienBumperBlinkingBehavior(); + final bloc = MockAlienBumperCubit(); + final streamController = StreamController(); + whenListen( + bloc, + streamController.stream, + initialState: AlienBumperState.active, + ); + + final alienBumper = AlienBumper.test(bloc: bloc); + await alienBumper.add(behavior); + await game.ensureAdd(alienBumper); + + streamController.add(AlienBumperState.inactive); + await tester.pump(); + game.update(0.05); + + await streamController.close(); + verify(bloc.onBlinked).called(1); + }, + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/alien_bumper/cubit/alien_bumper_cubit_test.dart b/packages/pinball_components/test/src/components/alien_bumper/cubit/alien_bumper_cubit_test.dart new file mode 100644 index 00000000..140249ea --- /dev/null +++ b/packages/pinball_components/test/src/components/alien_bumper/cubit/alien_bumper_cubit_test.dart @@ -0,0 +1,24 @@ +import 'package:bloc_test/bloc_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/pinball_components.dart'; + +void main() { + group( + 'AlienBumperCubit', + () { + blocTest( + 'onBallContacted emits inactive', + build: AlienBumperCubit.new, + act: (bloc) => bloc.onBallContacted(), + expect: () => [AlienBumperState.inactive], + ); + + blocTest( + 'onBlinked emits active', + build: AlienBumperCubit.new, + act: (bloc) => bloc.onBlinked(), + expect: () => [AlienBumperState.active], + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/alien_bumper_test.dart b/packages/pinball_components/test/src/components/alien_bumper_test.dart deleted file mode 100644 index c6384759..00000000 --- a/packages/pinball_components/test/src/components/alien_bumper_test.dart +++ /dev/null @@ -1,61 +0,0 @@ -// ignore_for_file: cascade_invocations - -import 'package:flame/components.dart'; -import 'package:flame_test/flame_test.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:pinball_components/pinball_components.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - TestWidgetsFlutterBinding.ensureInitialized(); - final assets = [ - Assets.images.alienBumper.a.active.keyName, - Assets.images.alienBumper.a.inactive.keyName, - Assets.images.alienBumper.b.active.keyName, - Assets.images.alienBumper.b.inactive.keyName, - ]; - final flameTester = FlameTester(() => TestGame(assets)); - - group('AlienBumper', () { - flameTester.test('"a" loads correctly', (game) async { - final bumper = AlienBumper.a(); - await game.ensureAdd(bumper); - - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('"b" loads correctly', (game) async { - final bumper = AlienBumper.b(); - await game.ensureAdd(bumper); - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('animate switches between on and off sprites', - (game) async { - final bumper = AlienBumper.a(); - await game.ensureAdd(bumper); - - final spriteGroupComponent = bumper.firstChild()!; - - expect( - spriteGroupComponent.current, - equals(AlienBumperSpriteState.active), - ); - - final future = bumper.animate(); - - expect( - spriteGroupComponent.current, - equals(AlienBumperSpriteState.inactive), - ); - - await future; - - expect( - spriteGroupComponent.current, - equals(AlienBumperSpriteState.active), - ); - }); - }); -} diff --git a/packages/pinball_components/test/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_ball_contact_behavior_test.dart b/packages/pinball_components/test/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_ball_contact_behavior_test.dart new file mode 100644 index 00000000..bf7513bd --- /dev/null +++ b/packages/pinball_components/test/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_ball_contact_behavior_test.dart @@ -0,0 +1,48 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/dash_nest_bumper/behaviors/behaviors.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(TestGame.new); + + group( + 'DashNestBumperBallContactBehavior', + () { + test('can be instantiated', () { + expect( + DashNestBumperBallContactBehavior(), + isA(), + ); + }); + + flameTester.test( + 'beginContact emits onBallContacted when contacts with a ball', + (game) async { + final behavior = DashNestBumperBallContactBehavior(); + final bloc = MockDashNestBumperCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: DashNestBumperState.active, + ); + + final dashNestBumper = DashNestBumper.test(bloc: bloc); + await dashNestBumper.add(behavior); + await game.ensureAdd(dashNestBumper); + + behavior.beginContact(MockBall(), MockContact()); + + verify(dashNestBumper.bloc.onBallContacted).called(1); + }, + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit_test.dart b/packages/pinball_components/test/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit_test.dart new file mode 100644 index 00000000..7e26bbf3 --- /dev/null +++ b/packages/pinball_components/test/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit_test.dart @@ -0,0 +1,24 @@ +import 'package:bloc_test/bloc_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/pinball_components.dart'; + +void main() { + group( + 'DashNestBumperCubit', + () { + blocTest( + 'onBallContacted emits active', + build: DashNestBumperCubit.new, + act: (bloc) => bloc.onBallContacted(), + expect: () => [DashNestBumperState.active], + ); + + blocTest( + 'onReset emits inactive', + build: DashNestBumperCubit.new, + act: (bloc) => bloc.onReset(), + expect: () => [DashNestBumperState.inactive], + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart b/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart new file mode 100644 index 00000000..67764951 --- /dev/null +++ b/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart @@ -0,0 +1,88 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame/components.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/dash_nest_bumper/behaviors/behaviors.dart'; + +import '../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('DashNestBumper', () { + final assets = [ + Assets.images.dash.bumper.main.active.keyName, + Assets.images.dash.bumper.main.inactive.keyName, + Assets.images.dash.bumper.a.active.keyName, + Assets.images.dash.bumper.a.inactive.keyName, + Assets.images.dash.bumper.b.active.keyName, + Assets.images.dash.bumper.b.inactive.keyName, + ]; + final flameTester = FlameTester(() => TestGame(assets)); + + flameTester.test('"main" loads correctly', (game) async { + final bumper = DashNestBumper.main(); + await game.ensureAdd(bumper); + expect(game.contains(bumper), isTrue); + }); + + flameTester.test('"a" loads correctly', (game) async { + final bumper = DashNestBumper.a(); + await game.ensureAdd(bumper); + + expect(game.contains(bumper), isTrue); + }); + + flameTester.test('"b" loads correctly', (game) async { + final bumper = DashNestBumper.b(); + await game.ensureAdd(bumper); + expect(game.contains(bumper), isTrue); + }); + + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + flameTester.test('closes bloc when removed', (game) async { + final bloc = MockDashNestBumperCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: DashNestBumperState.inactive, + ); + when(bloc.close).thenAnswer((_) async {}); + final dashNestBumper = DashNestBumper.test(bloc: bloc); + + await game.ensureAdd(dashNestBumper); + game.remove(dashNestBumper); + await game.ready(); + + verify(bloc.close).called(1); + }); + + group('adds', () { + flameTester.test('adds new children', (game) async { + final component = Component(); + final dashNestBumper = DashNestBumper.a( + children: [component], + ); + await game.ensureAdd(dashNestBumper); + expect(dashNestBumper.children, contains(component)); + }); + + flameTester.test('a DashNestBumperBallContactBehavior', (game) async { + final dashNestBumper = DashNestBumper.a(); + await game.ensureAdd(dashNestBumper); + expect( + dashNestBumper.children + .whereType() + .single, + isNotNull, + ); + }); + }); + }); +} diff --git a/packages/pinball_components/test/src/components/dash_nest_bumper_test.dart b/packages/pinball_components/test/src/components/dash_nest_bumper_test.dart deleted file mode 100644 index ac036ef4..00000000 --- a/packages/pinball_components/test/src/components/dash_nest_bumper_test.dart +++ /dev/null @@ -1,77 +0,0 @@ -// ignore_for_file: cascade_invocations - -import 'package:flame/components.dart'; -import 'package:flame_test/flame_test.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:pinball_components/pinball_components.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - TestWidgetsFlutterBinding.ensureInitialized(); - - group('DashNestBumper', () { - final assets = [ - Assets.images.dash.bumper.main.active.keyName, - Assets.images.dash.bumper.main.inactive.keyName, - Assets.images.dash.bumper.a.active.keyName, - Assets.images.dash.bumper.a.inactive.keyName, - Assets.images.dash.bumper.b.active.keyName, - Assets.images.dash.bumper.b.inactive.keyName, - ]; - final flameTester = FlameTester(() => TestGame(assets)); - - flameTester.test('"main" loads correctly', (game) async { - final bumper = DashNestBumper.main(); - await game.ensureAdd(bumper); - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('"a" loads correctly', (game) async { - final bumper = DashNestBumper.a(); - await game.ensureAdd(bumper); - - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('"b" loads correctly', (game) async { - final bumper = DashNestBumper.b(); - await game.ensureAdd(bumper); - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('activate switches to active sprite', (game) async { - final bumper = DashNestBumper.main(); - await game.ensureAdd(bumper); - - final spriteGroupComponent = bumper.firstChild()!; - - expect( - spriteGroupComponent.current, - equals(DashNestBumperSpriteState.inactive), - ); - - bumper.activate(); - - expect( - spriteGroupComponent.current, - equals(DashNestBumperSpriteState.active), - ); - }); - - flameTester.test('deactivate switches to inactive sprite', (game) async { - final bumper = DashNestBumper.main(); - await game.ensureAdd(bumper); - - final spriteGroupComponent = bumper.firstChild()! - ..current = DashNestBumperSpriteState.active; - - bumper.deactivate(); - - expect( - spriteGroupComponent.current, - equals(DashNestBumperSpriteState.inactive), - ); - }); - }); -} diff --git a/packages/pinball_components/test/src/components/google_letter/behaviors/google_letter_ball_contact_behavior_test.dart b/packages/pinball_components/test/src/components/google_letter/behaviors/google_letter_ball_contact_behavior_test.dart new file mode 100644 index 00000000..bf261460 --- /dev/null +++ b/packages/pinball_components/test/src/components/google_letter/behaviors/google_letter_ball_contact_behavior_test.dart @@ -0,0 +1,48 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/google_letter/behaviors/behaviors.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(TestGame.new); + + group( + 'GoogleLetterBallContactBehavior', + () { + test('can be instantiated', () { + expect( + GoogleLetterBallContactBehavior(), + isA(), + ); + }); + + flameTester.test( + 'beginContact emits onBallContacted when contacts with a ball', + (game) async { + final behavior = GoogleLetterBallContactBehavior(); + final bloc = MockGoogleLetterCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: GoogleLetterState.active, + ); + + final googleLetter = GoogleLetter.test(bloc: bloc); + await googleLetter.add(behavior); + await game.ensureAdd(googleLetter); + + behavior.beginContact(MockBall(), MockContact()); + + verify(googleLetter.bloc.onBallContacted).called(1); + }, + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/google_letter/cubit/google_letter_cubit_test.dart b/packages/pinball_components/test/src/components/google_letter/cubit/google_letter_cubit_test.dart new file mode 100644 index 00000000..390aa192 --- /dev/null +++ b/packages/pinball_components/test/src/components/google_letter/cubit/google_letter_cubit_test.dart @@ -0,0 +1,24 @@ +import 'package:bloc_test/bloc_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/pinball_components.dart'; + +void main() { + group( + 'GoogleLetterCubit', + () { + blocTest( + 'onBallContacted emits active', + build: GoogleLetterCubit.new, + act: (bloc) => bloc.onBallContacted(), + expect: () => [GoogleLetterState.active], + ); + + blocTest( + 'onReset emits inactive', + build: GoogleLetterCubit.new, + act: (bloc) => bloc.onReset(), + expect: () => [GoogleLetterState.inactive], + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/google_letter_test.dart b/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart similarity index 62% rename from packages/pinball_components/test/src/components/google_letter_test.dart rename to packages/pinball_components/test/src/components/google_letter/google_letter_test.dart index cdfd3c4a..624168b9 100644 --- a/packages/pinball_components/test/src/components/google_letter_test.dart +++ b/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart @@ -1,11 +1,13 @@ // ignore_for_file: cascade_invocations -import 'package:flame/effects.dart'; +import 'package:bloc_test/bloc_test.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/google_letter/behaviors/behaviors.dart'; -import '../../helpers/helpers.dart'; +import '../../../helpers/helpers.dart'; void main() { TestWidgetsFlutterBinding.ensureInitialized(); @@ -83,44 +85,35 @@ void main() { expect(() => GoogleLetter(6), throwsA(isA())); }); - group('activate', () { - flameTester.test('returns normally', (game) async { - final googleLetter = GoogleLetter(0); - await game.ensureAdd(googleLetter); - await expectLater(googleLetter.activate, returnsNormally); - }); - - flameTester.test('adds an Effect', (game) async { - final googleLetter = GoogleLetter(0); - await game.ensureAdd(googleLetter); - await googleLetter.activate(); - await game.ready(); - - expect( - googleLetter.descendants().whereType().length, - equals(1), - ); - }); + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + flameTester.test('closes bloc when removed', (game) async { + final bloc = MockGoogleLetterCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: GoogleLetterState.active, + ); + when(bloc.close).thenAnswer((_) async {}); + final googleLetter = GoogleLetter.test(bloc: bloc); + + await game.ensureAdd(googleLetter); + game.remove(googleLetter); + await game.ready(); + + verify(bloc.close).called(1); }); - group('deactivate', () { - flameTester.test('returns normally', (game) async { - final googleLetter = GoogleLetter(0); - await game.ensureAdd(googleLetter); - await expectLater(googleLetter.deactivate, returnsNormally); - }); - - flameTester.test('adds an Effect', (game) async { - final googleLetter = GoogleLetter(0); - await game.ensureAdd(googleLetter); - await googleLetter.deactivate(); - await game.ready(); - - expect( - googleLetter.descendants().whereType().length, - equals(1), - ); - }); + flameTester.test('adds a GoogleLetterBallContactBehavior', (game) async { + final googleLetter = GoogleLetter(0); + await game.ensureAdd(googleLetter); + expect( + googleLetter.children + .whereType() + .single, + isNotNull, + ); }); }); } diff --git a/packages/pinball_components/test/src/components/layer_sensor_test.dart b/packages/pinball_components/test/src/components/layer_sensor_test.dart index f91a6bcb..2d1b21be 100644 --- a/packages/pinball_components/test/src/components/layer_sensor_test.dart +++ b/packages/pinball_components/test/src/components/layer_sensor_test.dart @@ -22,11 +22,6 @@ class TestLayerSensor extends LayerSensor { Shape get shape => PolygonShape()..setAsBoxXY(1, 1); } -class TestLayerSensorBallContactCallback - extends LayerSensorBallContactCallback { - TestLayerSensorBallContactCallback() : super(); -} - void main() { TestWidgetsFlutterBinding.ensureInitialized(); final flameTester = FlameTester(TestGame.new); @@ -113,7 +108,7 @@ void main() { }); }); - group('LayerSensorBallContactCallback', () { + group('beginContact', () { late Ball ball; late Body body; @@ -135,18 +130,17 @@ void main() { insidePriority: insidePriority, insideLayer: Layer.spaceshipEntranceRamp, )..initialPosition = Vector2(0, 10); - final callback = TestLayerSensorBallContactCallback(); when(() => body.linearVelocity).thenReturn(Vector2(0, -1)); - callback.begin(ball, sensor, MockContact()); + sensor.beginContact(ball, MockContact()); verify(() => ball.layer = sensor.insideLayer).called(1); verify(() => ball.priority = sensor.insidePriority).called(1); verify(ball.reorderChildren).called(1); when(() => ball.layer).thenReturn(sensor.insideLayer); - callback.begin(ball, sensor, MockContact()); + sensor.beginContact(ball, MockContact()); verify(() => ball.layer = Layer.board); verify(() => ball.priority = RenderPriority.ballOnBoard).called(1); verify(ball.reorderChildren).called(1); @@ -161,18 +155,17 @@ void main() { insidePriority: insidePriority, insideLayer: Layer.spaceshipEntranceRamp, )..initialPosition = Vector2(0, 10); - final callback = TestLayerSensorBallContactCallback(); when(() => body.linearVelocity).thenReturn(Vector2(0, 1)); - callback.begin(ball, sensor, MockContact()); + sensor.beginContact(ball, MockContact()); verify(() => ball.layer = sensor.insideLayer).called(1); verify(() => ball.priority = sensor.insidePriority).called(1); verify(ball.reorderChildren).called(1); when(() => ball.layer).thenReturn(sensor.insideLayer); - callback.begin(ball, sensor, MockContact()); + sensor.beginContact(ball, MockContact()); verify(() => ball.layer = Layer.board); verify(() => ball.priority = RenderPriority.ballOnBoard).called(1); verify(ball.reorderChildren).called(1); diff --git a/packages/pinball_components/test/src/components/signpost_test.dart b/packages/pinball_components/test/src/components/signpost_test.dart index 018c1bee..23aa6bd0 100644 --- a/packages/pinball_components/test/src/components/signpost_test.dart +++ b/packages/pinball_components/test/src/components/signpost_test.dart @@ -151,5 +151,14 @@ void main() { expect(spriteComponent.current, SignpostSpriteState.inactive); }, ); + + flameTester.test('adds new children', (game) async { + final component = Component(); + final signpost = Signpost( + children: [component], + ); + await game.ensureAdd(signpost); + expect(signpost.children, contains(component)); + }); }); } diff --git a/packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior_test.dart b/packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior_test.dart new file mode 100644 index 00000000..88bd8145 --- /dev/null +++ b/packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_ball_contact_behavior_test.dart @@ -0,0 +1,48 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/sparky_bumper/behaviors/behaviors.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(TestGame.new); + + group( + 'SparkyBumperBallContactBehavior', + () { + test('can be instantiated', () { + expect( + SparkyBumperBallContactBehavior(), + isA(), + ); + }); + + flameTester.test( + 'beginContact emits onBallContacted when contacts with a ball', + (game) async { + final behavior = SparkyBumperBallContactBehavior(); + final bloc = MockSparkyBumperCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: SparkyBumperState.active, + ); + + final sparkyBumper = SparkyBumper.test(bloc: bloc); + await sparkyBumper.add(behavior); + await game.ensureAdd(sparkyBumper); + + behavior.beginContact(MockBall(), MockContact()); + + verify(sparkyBumper.bloc.onBallContacted).called(1); + }, + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior_test.dart b/packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior_test.dart new file mode 100644 index 00000000..0d938820 --- /dev/null +++ b/packages/pinball_components/test/src/components/sparky_bumper/behaviors/sparky_bumper_blinking_behavior_test.dart @@ -0,0 +1,45 @@ +import 'dart:async'; + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/sparky_bumper/behaviors/behaviors.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(TestGame.new); + + group( + 'SparkyBumperBlinkingBehavior', + () { + flameTester.testGameWidget( + 'calls onBlinked after 0.05 seconds when inactive', + setUp: (game, tester) async { + final behavior = SparkyBumperBlinkingBehavior(); + final bloc = MockSparkyBumperCubit(); + final streamController = StreamController(); + whenListen( + bloc, + streamController.stream, + initialState: SparkyBumperState.active, + ); + + final sparkyBumper = SparkyBumper.test(bloc: bloc); + await sparkyBumper.add(behavior); + await game.ensureAdd(sparkyBumper); + + streamController.add(SparkyBumperState.inactive); + await tester.pump(); + game.update(0.05); + + await streamController.close(); + verify(bloc.onBlinked).called(1); + }, + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/sparky_bumper/cubit/sparky_bumper_cubit_test.dart b/packages/pinball_components/test/src/components/sparky_bumper/cubit/sparky_bumper_cubit_test.dart new file mode 100644 index 00000000..4192f806 --- /dev/null +++ b/packages/pinball_components/test/src/components/sparky_bumper/cubit/sparky_bumper_cubit_test.dart @@ -0,0 +1,24 @@ +import 'package:bloc_test/bloc_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/pinball_components.dart'; + +void main() { + group( + 'SparkyBumperCubit', + () { + blocTest( + 'onBallContacted emits inactive', + build: SparkyBumperCubit.new, + act: (bloc) => bloc.onBallContacted(), + expect: () => [SparkyBumperState.inactive], + ); + + blocTest( + 'onBlinked emits active', + build: SparkyBumperCubit.new, + act: (bloc) => bloc.onBlinked(), + expect: () => [SparkyBumperState.active], + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart b/packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart new file mode 100644 index 00000000..225b5922 --- /dev/null +++ b/packages/pinball_components/test/src/components/sparky_bumper/sparky_bumper_test.dart @@ -0,0 +1,86 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame/components.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/sparky_bumper/behaviors/behaviors.dart'; + +import '../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final assets = [ + Assets.images.sparky.bumper.a.active.keyName, + Assets.images.sparky.bumper.a.inactive.keyName, + Assets.images.sparky.bumper.b.active.keyName, + Assets.images.sparky.bumper.b.inactive.keyName, + Assets.images.sparky.bumper.c.active.keyName, + Assets.images.sparky.bumper.c.inactive.keyName, + ]; + final flameTester = FlameTester(() => TestGame(assets)); + + group('SparkyBumper', () { + flameTester.test('"a" loads correctly', (game) async { + final sparkyBumper = SparkyBumper.a(); + await game.ensureAdd(sparkyBumper); + expect(game.contains(sparkyBumper), isTrue); + }); + + flameTester.test('"b" loads correctly', (game) async { + final sparkyBumper = SparkyBumper.b(); + await game.ensureAdd(sparkyBumper); + expect(game.contains(sparkyBumper), isTrue); + }); + + flameTester.test('"c" loads correctly', (game) async { + final sparkyBumper = SparkyBumper.c(); + await game.ensureAdd(sparkyBumper); + expect(game.contains(sparkyBumper), isTrue); + }); + + // TODO(alestiago): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + // ignore: public_member_api_docs + flameTester.test('closes bloc when removed', (game) async { + final bloc = MockSparkyBumperCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: SparkyBumperState.active, + ); + when(bloc.close).thenAnswer((_) async {}); + final sparkyBumper = SparkyBumper.test(bloc: bloc); + + await game.ensureAdd(sparkyBumper); + game.remove(sparkyBumper); + await game.ready(); + + verify(bloc.close).called(1); + }); + + group('adds', () { + flameTester.test('new children', (game) async { + final component = Component(); + final sparkyBumper = SparkyBumper.a( + children: [component], + ); + await game.ensureAdd(sparkyBumper); + expect(sparkyBumper.children, contains(component)); + }); + + flameTester.test('a SparkyBumperBallContactBehavior', (game) async { + final sparkyBumper = SparkyBumper.a(); + await game.ensureAdd(sparkyBumper); + expect( + sparkyBumper.children + .whereType() + .single, + isNotNull, + ); + }); + }); + }); +} diff --git a/packages/pinball_components/test/src/components/sparky_bumper_test.dart b/packages/pinball_components/test/src/components/sparky_bumper_test.dart deleted file mode 100644 index a2fcc5ed..00000000 --- a/packages/pinball_components/test/src/components/sparky_bumper_test.dart +++ /dev/null @@ -1,69 +0,0 @@ -// ignore_for_file: cascade_invocations - -import 'package:flame/components.dart'; -import 'package:flame_test/flame_test.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:pinball_components/pinball_components.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - TestWidgetsFlutterBinding.ensureInitialized(); - final assets = [ - Assets.images.sparky.bumper.a.active.keyName, - Assets.images.sparky.bumper.a.inactive.keyName, - Assets.images.sparky.bumper.b.active.keyName, - Assets.images.sparky.bumper.b.inactive.keyName, - Assets.images.sparky.bumper.c.active.keyName, - Assets.images.sparky.bumper.c.inactive.keyName, - ]; - final flameTester = FlameTester(() => TestGame(assets)); - - group('SparkyBumper', () { - flameTester.test('"a" loads correctly', (game) async { - final bumper = SparkyBumper.a(); - await game.ensureAdd(bumper); - - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('"b" loads correctly', (game) async { - final bumper = SparkyBumper.b(); - await game.ensureAdd(bumper); - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('"c" loads correctly', (game) async { - final bumper = SparkyBumper.c(); - await game.ensureAdd(bumper); - expect(game.contains(bumper), isTrue); - }); - - flameTester.test('animate switches between on and off sprites', - (game) async { - final bumper = SparkyBumper.a(); - await game.ensureAdd(bumper); - - final spriteGroupComponent = bumper.firstChild()!; - - expect( - spriteGroupComponent.current, - equals(SparkyBumperSpriteState.active), - ); - - final future = bumper.animate(); - - expect( - spriteGroupComponent.current, - equals(SparkyBumperSpriteState.inactive), - ); - - await future; - - expect( - spriteGroupComponent.current, - equals(SparkyBumperSpriteState.active), - ); - }); - }); -} diff --git a/packages/pinball_flame/lib/pinball_flame.dart b/packages/pinball_flame/lib/pinball_flame.dart index 709e7627..7eb4c3a9 100644 --- a/packages/pinball_flame/lib/pinball_flame.dart +++ b/packages/pinball_flame/lib/pinball_flame.dart @@ -2,5 +2,7 @@ library pinball_flame; export 'src/blueprint.dart'; export 'src/component_controller.dart'; +export 'src/contact_behavior.dart'; export 'src/keyboard_input_controller.dart'; +export 'src/parent_is_a.dart'; export 'src/sprite_animation.dart'; diff --git a/packages/pinball_flame/lib/src/contact_behavior.dart b/packages/pinball_flame/lib/src/contact_behavior.dart new file mode 100644 index 00000000..79112398 --- /dev/null +++ b/packages/pinball_flame/lib/src/contact_behavior.dart @@ -0,0 +1,95 @@ +import 'package:flame/components.dart'; +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// Appends a new [ContactCallbacks] to the parent. +/// +/// This is a convenience class for adding a [ContactCallbacks] to the parent. +/// In constract with just adding a [ContactCallbacks] to the parent's body +/// userData, this class respects the previous [ContactCallbacks] in the +/// parent's body userData, if any. Hence, it avoids overriding any previous +/// [ContactCallbacks] in the parent. +/// +/// It does so by grouping the [ContactCallbacks] in a [_ContactCallbacksGroup], +/// and resetting the parent's userData accordingly. +// TODO(alestiago): Make use of generics to infer the type of the contact. +// https://github.com/VGVentures/pinball/pull/234#discussion_r859182267 +// TODO(alestiago): Consider if there is a need to support adjusting a fixture's +// userData. +class ContactBehavior extends Component + with ContactCallbacks, ParentIsA { + @override + @mustCallSuper + Future onLoad() async { + final userData = parent.body.userData; + if (userData is _ContactCallbacksGroup) { + userData.addContactCallbacks(this); + } else if (userData is ContactCallbacks) { + final contactCallbacksGroup = _ContactCallbacksGroup() + ..addContactCallbacks(userData) + ..addContactCallbacks(this); + parent.body.userData = contactCallbacksGroup; + } else { + parent.body.userData = this; + } + } +} + +class _ContactCallbacksGroup implements ContactCallbacks { + final List _contactCallbacks = []; + + @override + @mustCallSuper + void beginContact(Object other, Contact contact) { + onBeginContact?.call(other, contact); + for (final callback in _contactCallbacks) { + callback.beginContact(other, contact); + } + } + + @override + @mustCallSuper + void endContact(Object other, Contact contact) { + onEndContact?.call(other, contact); + for (final callback in _contactCallbacks) { + callback.endContact(other, contact); + } + } + + @override + @mustCallSuper + void preSolve(Object other, Contact contact, Manifold oldManifold) { + onPreSolve?.call(other, contact, oldManifold); + for (final callback in _contactCallbacks) { + callback.preSolve(other, contact, oldManifold); + } + } + + @override + @mustCallSuper + void postSolve(Object other, Contact contact, ContactImpulse impulse) { + onPostSolve?.call(other, contact, impulse); + for (final callback in _contactCallbacks) { + callback.postSolve(other, contact, impulse); + } + } + + void addContactCallbacks(ContactCallbacks callback) { + _contactCallbacks.add(callback); + } + + @override + void Function(Object other, Contact contact)? onBeginContact; + + @override + void Function(Object other, Contact contact)? onEndContact; + + @override + void Function(Object other, Contact contact, ContactImpulse impulse)? + onPostSolve; + + @override + void Function(Object other, Contact contact, Manifold oldManifold)? + onPreSolve; +} diff --git a/packages/pinball_flame/lib/src/parent_is_a.dart b/packages/pinball_flame/lib/src/parent_is_a.dart new file mode 100644 index 00000000..19159c89 --- /dev/null +++ b/packages/pinball_flame/lib/src/parent_is_a.dart @@ -0,0 +1,15 @@ +import 'package:flame/components.dart'; + +// TODO(alestiago): Remove once the following is merged: +// https://github.com/flame-engine/flame/pull/1566 + +/// A mixin that ensures a parent is of the given type [T]. +mixin ParentIsA on Component { + @override + T get parent => super.parent! as T; + + @override + Future? addToParent(covariant T parent) { + return super.addToParent(parent); + } +} diff --git a/packages/pinball_flame/pubspec.yaml b/packages/pinball_flame/pubspec.yaml index ad8ec131..89caf5bb 100644 --- a/packages/pinball_flame/pubspec.yaml +++ b/packages/pinball_flame/pubspec.yaml @@ -8,7 +8,11 @@ environment: dependencies: flame: ^1.1.1 - flame_forge2d: ^0.11.0 + flame_forge2d: + git: + url: https://github.com/flame-engine/flame/ + path: packages/flame_forge2d/ + ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f flutter: sdk: flutter diff --git a/packages/pinball_flame/test/helpers/mocks.dart b/packages/pinball_flame/test/helpers/mocks.dart index bf96390d..1c5042ff 100644 --- a/packages/pinball_flame/test/helpers/mocks.dart +++ b/packages/pinball_flame/test/helpers/mocks.dart @@ -4,7 +4,4 @@ import 'package:mocktail/mocktail.dart'; class MockForge2DGame extends Mock implements Forge2DGame {} -class MockContactCallback extends Mock - implements ContactCallback {} - class MockComponent extends Mock implements Component {} diff --git a/packages/pinball_flame/test/src/contact_behavior_test.dart b/packages/pinball_flame/test/src/contact_behavior_test.dart new file mode 100644 index 00000000..630156ed --- /dev/null +++ b/packages/pinball_flame/test/src/contact_behavior_test.dart @@ -0,0 +1,153 @@ +// ignore_for_file: cascade_invocations + +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +class _TestBodyComponent extends BodyComponent { + @override + Body createBody() => world.createBody(BodyDef()); +} + +class _TestContactBehavior extends ContactBehavior { + int beginContactCallsCount = 0; + @override + void beginContact(Object other, Contact contact) { + beginContactCallsCount++; + super.beginContact(other, contact); + } + + int endContactCallsCount = 0; + @override + void endContact(Object other, Contact contact) { + endContactCallsCount++; + super.endContact(other, contact); + } + + int preSolveContactCallsCount = 0; + @override + void preSolve(Object other, Contact contact, Manifold oldManifold) { + preSolveContactCallsCount++; + super.preSolve(other, contact, oldManifold); + } + + int postSolveContactCallsCount = 0; + @override + void postSolve(Object other, Contact contact, ContactImpulse impulse) { + postSolveContactCallsCount++; + super.postSolve(other, contact, impulse); + } +} + +class _MockContactCallbacks extends Mock implements ContactCallbacks {} + +class _MockContact extends Mock implements Contact {} + +class _MockManifold extends Mock implements Manifold {} + +class _MockContactImpulse extends Mock implements ContactImpulse {} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(Forge2DGame.new); + + group('ContactBehavior', () { + late Object other; + late Contact contact; + late Manifold manifold; + late ContactImpulse contactImpulse; + + setUp(() { + other = Object(); + contact = _MockContact(); + manifold = _MockManifold(); + contactImpulse = _MockContactImpulse(); + }); + + flameTester.test( + 'should add a new ContactCallbacks to the parent', + (game) async { + final parent = _TestBodyComponent(); + final contactBehavior = ContactBehavior(); + await parent.add(contactBehavior); + await game.ensureAdd(parent); + + expect(parent.body.userData, contactBehavior); + }, + ); + + flameTester.test( + "should respect the previous ContactCallbacks in the parent's userData", + (game) async { + final parent = _TestBodyComponent(); + await game.ensureAdd(parent); + final contactCallbacks1 = _MockContactCallbacks(); + parent.body.userData = contactCallbacks1; + + final contactBehavior = ContactBehavior(); + await parent.ensureAdd(contactBehavior); + + final contactCallbacks = parent.body.userData! as ContactCallbacks; + + contactCallbacks.beginContact(other, contact); + verify( + () => contactCallbacks1.beginContact(other, contact), + ).called(1); + + contactCallbacks.endContact(other, contact); + verify( + () => contactCallbacks1.endContact(other, contact), + ).called(1); + + contactCallbacks.preSolve(other, contact, manifold); + verify( + () => contactCallbacks1.preSolve(other, contact, manifold), + ).called(1); + + contactCallbacks.postSolve(other, contact, contactImpulse); + verify( + () => contactCallbacks1.postSolve(other, contact, contactImpulse), + ).called(1); + }, + ); + + flameTester.test('can group multiple ContactBehaviors and keep listening', + (game) async { + final parent = _TestBodyComponent(); + await game.ensureAdd(parent); + + final contactBehavior1 = _TestContactBehavior(); + final contactBehavior2 = _TestContactBehavior(); + final contactBehavior3 = _TestContactBehavior(); + await parent.ensureAddAll([ + contactBehavior1, + contactBehavior2, + contactBehavior3, + ]); + + final contactCallbacks = parent.body.userData! as ContactCallbacks; + + contactCallbacks.beginContact(other, contact); + expect(contactBehavior1.beginContactCallsCount, equals(1)); + expect(contactBehavior2.beginContactCallsCount, equals(1)); + expect(contactBehavior3.beginContactCallsCount, equals(1)); + + contactCallbacks.endContact(other, contact); + expect(contactBehavior1.endContactCallsCount, equals(1)); + expect(contactBehavior2.endContactCallsCount, equals(1)); + expect(contactBehavior3.endContactCallsCount, equals(1)); + + contactCallbacks.preSolve(other, contact, manifold); + expect(contactBehavior1.preSolveContactCallsCount, equals(1)); + expect(contactBehavior2.preSolveContactCallsCount, equals(1)); + expect(contactBehavior3.preSolveContactCallsCount, equals(1)); + + contactCallbacks.postSolve(other, contact, contactImpulse); + expect(contactBehavior1.postSolveContactCallsCount, equals(1)); + expect(contactBehavior2.postSolveContactCallsCount, equals(1)); + expect(contactBehavior3.postSolveContactCallsCount, equals(1)); + }); + }); +} diff --git a/pubspec.lock b/pubspec.lock index 1a502f37..4a851209 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -7,14 +7,14 @@ packages: name: _fe_analyzer_shared url: "https://pub.dartlang.org" source: hosted - version: "31.0.0" + version: "39.0.0" analyzer: dependency: transitive description: name: analyzer url: "https://pub.dartlang.org" source: hosted - version: "2.8.0" + version: "4.0.0" args: dependency: transitive description: @@ -71,13 +71,6 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "1.3.1" - cli_util: - dependency: transitive - description: - name: cli_util - url: "https://pub.dartlang.org" - source: hosted - version: "0.3.5" clock: dependency: transitive description: @@ -214,9 +207,11 @@ packages: flame_forge2d: dependency: "direct main" description: - name: flame_forge2d - url: "https://pub.dartlang.org" - source: hosted + path: "packages/flame_forge2d" + ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f + resolved-ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f + url: "https://github.com/flame-engine/flame/" + source: git version: "0.11.0" flame_test: dependency: "direct dev" @@ -321,7 +316,7 @@ packages: name: js url: "https://pub.dartlang.org" source: hosted - version: "0.6.3" + version: "0.6.4" json_annotation: dependency: transitive description: @@ -356,7 +351,7 @@ packages: name: material_color_utilities url: "https://pub.dartlang.org" source: hosted - version: "0.1.3" + version: "0.1.4" meta: dependency: transitive description: @@ -419,7 +414,7 @@ packages: name: path url: "https://pub.dartlang.org" source: hosted - version: "1.8.0" + version: "1.8.1" path_provider: dependency: transitive description: @@ -592,7 +587,7 @@ packages: name: source_span url: "https://pub.dartlang.org" source: hosted - version: "1.8.1" + version: "1.8.2" stack_trace: dependency: transitive description: @@ -634,21 +629,21 @@ packages: name: test url: "https://pub.dartlang.org" source: hosted - version: "1.19.5" + version: "1.21.1" test_api: dependency: transitive description: name: test_api url: "https://pub.dartlang.org" source: hosted - version: "0.4.8" + version: "0.4.9" test_core: dependency: transitive description: name: test_core url: "https://pub.dartlang.org" source: hosted - version: "0.4.9" + version: "0.4.13" typed_data: dependency: transitive description: @@ -669,7 +664,7 @@ packages: name: vector_math url: "https://pub.dartlang.org" source: hosted - version: "2.1.1" + version: "2.1.2" very_good_analysis: dependency: "direct dev" description: diff --git a/pubspec.yaml b/pubspec.yaml index 3b950c27..48c570c3 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -12,7 +12,11 @@ dependencies: equatable: ^2.0.3 flame: ^1.1.1 flame_bloc: ^1.2.0 - flame_forge2d: ^0.11.0 + flame_forge2d: + git: + url: https://github.com/flame-engine/flame/ + path: packages/flame_forge2d/ + ref: a50d4a1e7d9eaf66726ed1bb9894c9d495547d8f flutter: sdk: flutter flutter_bloc: ^8.0.1 diff --git a/test/game/components/alien_zone_test.dart b/test/game/components/alien_zone_test.dart index de4e58fc..7feaded8 100644 --- a/test/game/components/alien_zone_test.dart +++ b/test/game/components/alien_zone_test.dart @@ -1,13 +1,10 @@ // ignore_for_file: cascade_invocations -import 'dart:ui'; - -import 'package:bloc_test/bloc_test.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; -import 'package:mocktail/mocktail.dart'; import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; import '../../helpers/helpers.dart'; @@ -19,16 +16,16 @@ void main() { Assets.images.alienBumper.b.active.keyName, Assets.images.alienBumper.b.inactive.keyName, ]; - final flameTester = FlameTester(() => EmptyPinballTestGame(assets)); + final flameTester = FlameTester( + () => EmptyPinballTestGame(assets: assets), + ); group('AlienZone', () { flameTester.test( 'loads correctly', (game) async { - final alienZone = AlienZone(); - await game.ensureAdd(alienZone); - - expect(game.contains(alienZone), isTrue); + await game.addFromBlueprint(AlienZone()); + await game.ready(); }, ); @@ -37,68 +34,15 @@ void main() { 'two AlienBumper', (game) async { final alienZone = AlienZone(); - await game.ensureAdd(alienZone); + await game.addFromBlueprint(alienZone); + await game.ready(); expect( - alienZone.descendants().whereType().length, + game.descendants().whereType().length, equals(2), ); }, ); }); - - group('bumpers', () { - late GameBloc gameBloc; - - setUp(() { - gameBloc = MockGameBloc(); - whenListen( - gameBloc, - const Stream.empty(), - initialState: const GameState.initial(), - ); - }); - - final flameBlocTester = FlameBlocTester( - gameBuilder: EmptyPinballTestGame.new, - blocBuilder: () => gameBloc, - assets: assets, - ); - - flameTester.test('call animate on contact', (game) async { - final contactCallback = AlienBumperBallContactCallback(); - final bumper = MockAlienBumper(); - final ball = MockBall(); - - when(bumper.animate).thenAnswer((_) async {}); - - contactCallback.begin(bumper, ball, MockContact()); - - verify(bumper.animate).called(1); - }); - - flameBlocTester.testGameWidget( - 'add Scored event', - setUp: (game, tester) async { - final ball = Ball(baseColor: const Color(0xFF00FFFF)); - final alienZone = AlienZone(); - - await game.ensureAdd(alienZone); - await game.ensureAdd(ball); - game.addContactCallback(BallScorePointsCallback(game)); - - final bumpers = alienZone.descendants().whereType(); - - for (final bumper in bumpers) { - beginContact(game, bumper, ball); - verify( - () => gameBloc.add( - Scored(points: bumper.points), - ), - ).called(1); - } - }, - ); - }); }); } diff --git a/test/game/components/board_test.dart b/test/game/components/board_test.dart index bc1c5c39..a73d7a50 100644 --- a/test/game/components/board_test.dart +++ b/test/game/components/board_test.dart @@ -26,7 +26,9 @@ void main() { Assets.images.flipper.left.keyName, Assets.images.flipper.right.keyName, ]; - final flameTester = FlameTester(() => EmptyPinballTestGame(assets)); + final flameTester = FlameTester( + () => EmptyPinballTestGame(assets: assets), + ); group('Board', () { flameTester.test( diff --git a/test/game/components/controlled_flipper_test.dart b/test/game/components/controlled_flipper_test.dart index 1b2a7e43..2f970254 100644 --- a/test/game/components/controlled_flipper_test.dart +++ b/test/game/components/controlled_flipper_test.dart @@ -15,7 +15,9 @@ void main() { Assets.images.flipper.left.keyName, Assets.images.flipper.right.keyName, ]; - final flameTester = FlameTester(() => EmptyPinballTestGame(assets)); + final flameTester = FlameTester( + () => EmptyPinballTestGame(assets: assets), + ); final flameBlocTester = FlameBlocTester( gameBuilder: EmptyPinballTestGame.new, diff --git a/test/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior_test.dart b/test/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior_test.dart new file mode 100644 index 00000000..c1834516 --- /dev/null +++ b/test/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior_test.dart @@ -0,0 +1,84 @@ +// ignore_for_file: cascade_invocations + +import 'dart:async'; + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball/game/components/flutter_forest/behaviors/behaviors.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + group('FlutterForestBonusBehavior', () { + late GameBloc gameBloc; + + setUp(() { + gameBloc = MockGameBloc(); + whenListen( + gameBloc, + const Stream.empty(), + initialState: const GameState.initial(), + ); + }); + + final flameBlocTester = FlameBlocTester( + gameBuilder: EmptyPinballTestGame.new, + blocBuilder: () => gameBloc, + ); + + flameBlocTester.testGameWidget( + 'adds GameBonus.dashNest to the game when all bumpers are active', + setUp: (game, tester) async { + final behavior = FlutterForestBonusBehavior(); + final parent = FlutterForest.test(); + final bumpers = [ + DashNestBumper.test(bloc: DashNestBumperCubit()), + DashNestBumper.test(bloc: DashNestBumperCubit()), + DashNestBumper.test(bloc: DashNestBumperCubit()), + ]; + await parent.addAll(bumpers); + await game.ensureAdd(parent); + await parent.ensureAdd(behavior); + + for (final bumper in bumpers) { + bumper.bloc.onBallContacted(); + } + await tester.pump(); + + verify( + () => gameBloc.add(const BonusActivated(GameBonus.dashNest)), + ).called(1); + }, + ); + + flameBlocTester.testGameWidget( + 'adds a new ball to the game when all bumpers are active', + setUp: (game, tester) async { + final behavior = FlutterForestBonusBehavior(); + final parent = FlutterForest.test(); + final bumpers = [ + DashNestBumper.test(bloc: DashNestBumperCubit()), + DashNestBumper.test(bloc: DashNestBumperCubit()), + DashNestBumper.test(bloc: DashNestBumperCubit()), + ]; + await parent.addAll(bumpers); + await game.ensureAdd(parent); + await parent.ensureAdd(behavior); + + for (final bumper in bumpers) { + bumper.bloc.onBallContacted(); + } + await game.ready(); + + expect( + game.descendants().whereType().single, + isNotNull, + ); + }, + ); + }); +} diff --git a/test/game/components/flutter_forest/flutter_forest_test.dart b/test/game/components/flutter_forest/flutter_forest_test.dart new file mode 100644 index 00000000..4f32e0f4 --- /dev/null +++ b/test/game/components/flutter_forest/flutter_forest_test.dart @@ -0,0 +1,80 @@ +// ignore_for_file: cascade_invocations + +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final assets = [ + Assets.images.dash.bumper.main.active.keyName, + Assets.images.dash.bumper.main.inactive.keyName, + Assets.images.dash.bumper.a.active.keyName, + Assets.images.dash.bumper.a.inactive.keyName, + Assets.images.dash.bumper.b.active.keyName, + Assets.images.dash.bumper.b.inactive.keyName, + Assets.images.dash.animatronic.keyName, + Assets.images.signpost.inactive.keyName, + Assets.images.signpost.active1.keyName, + Assets.images.signpost.active2.keyName, + Assets.images.signpost.active3.keyName, + ]; + final flameTester = FlameTester( + () => EmptyPinballTestGame(assets: assets), + ); + + group('FlutterForest', () { + flameTester.test( + 'loads correctly', + (game) async { + final flutterForest = FlutterForest(); + await game.ensureAdd(flutterForest); + expect(game.contains(flutterForest), isTrue); + }, + ); + + group('loads', () { + flameTester.test( + 'a Signpost', + (game) async { + final flutterForest = FlutterForest(); + await game.ensureAdd(flutterForest); + + expect( + flutterForest.descendants().whereType().length, + equals(1), + ); + }, + ); + + flameTester.test( + 'a DashAnimatronic', + (game) async { + final flutterForest = FlutterForest(); + await game.ensureAdd(flutterForest); + + expect( + flutterForest.firstChild(), + isNotNull, + ); + }, + ); + + flameTester.test( + 'three DashNestBumper', + (game) async { + final flutterForest = FlutterForest(); + await game.ensureAdd(flutterForest); + + expect( + flutterForest.descendants().whereType().length, + equals(3), + ); + }, + ); + }); + }); +} diff --git a/test/game/components/flutter_forest_test.dart b/test/game/components/flutter_forest_test.dart deleted file mode 100644 index 388410d5..00000000 --- a/test/game/components/flutter_forest_test.dart +++ /dev/null @@ -1,177 +0,0 @@ -// ignore_for_file: cascade_invocations - -import 'package:bloc_test/bloc_test.dart'; -import 'package:flame_test/flame_test.dart'; -import 'package:flutter/rendering.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:mocktail/mocktail.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball_components/pinball_components.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - TestWidgetsFlutterBinding.ensureInitialized(); - final assets = [ - Assets.images.dash.bumper.main.active.keyName, - Assets.images.dash.bumper.main.inactive.keyName, - Assets.images.dash.bumper.a.active.keyName, - Assets.images.dash.bumper.a.inactive.keyName, - Assets.images.dash.bumper.b.active.keyName, - Assets.images.dash.bumper.b.inactive.keyName, - Assets.images.dash.animatronic.keyName, - Assets.images.signpost.inactive.keyName, - Assets.images.signpost.active1.keyName, - Assets.images.signpost.active2.keyName, - Assets.images.signpost.active3.keyName, - ]; - final flameTester = FlameTester(() => EmptyPinballTestGame(assets)); - - group('FlutterForest', () { - flameTester.test( - 'loads correctly', - (game) async { - final flutterForest = FlutterForest(); - await game.ensureAdd(flutterForest); - - expect(game.contains(flutterForest), isTrue); - }, - ); - - group('loads', () { - flameTester.test( - 'a Signpost', - (game) async { - final flutterForest = FlutterForest(); - await game.ensureAdd(flutterForest); - - expect( - flutterForest.descendants().whereType().length, - equals(1), - ); - }, - ); - - flameTester.test( - 'a DashAnimatronic', - (game) async { - final flutterForest = FlutterForest(); - await game.ensureAdd(flutterForest); - - expect( - flutterForest.firstChild(), - isNotNull, - ); - }, - ); - - flameTester.test( - 'three DashNestBumper', - (game) async { - final flutterForest = FlutterForest(); - await game.ensureAdd(flutterForest); - - expect( - flutterForest.descendants().whereType().length, - equals(3), - ); - }, - ); - }); - - group('bumpers', () { - late Ball ball; - late GameBloc gameBloc; - - setUp(() { - ball = Ball(baseColor: const Color(0xFF00FFFF)); - }); - - final flameBlocTester = FlameBlocTester( - gameBuilder: () => EmptyPinballTestGame(assets), - blocBuilder: () { - gameBloc = MockGameBloc(); - const state = GameState.initial(); - whenListen(gameBloc, Stream.value(state), initialState: state); - return gameBloc; - }, - assets: assets, - ); - - flameBlocTester.testGameWidget( - 'add Scored event', - setUp: (game, tester) async { - final flutterForest = FlutterForest(); - await game.ensureAddAll([ - flutterForest, - ball, - ]); - game.addContactCallback(BallScorePointsCallback(game)); - - final bumpers = flutterForest.descendants().whereType(); - - for (final bumper in bumpers) { - beginContact(game, bumper, ball); - verify( - () => gameBloc.add( - Scored(points: bumper.points), - ), - ).called(1); - } - }, - ); - - flameBlocTester.testGameWidget( - 'adds GameBonus.dashNest to the game when 3 bumpers are activated', - setUp: (game, _) async { - final ball = Ball(baseColor: const Color(0xFFFF0000)); - final flutterForest = FlutterForest(); - await game.ensureAddAll([flutterForest, ball]); - - final bumpers = flutterForest.children.whereType(); - expect(bumpers.length, equals(3)); - for (final bumper in bumpers) { - beginContact(game, bumper, ball); - await game.ready(); - - if (bumper == bumpers.last) { - verify( - () => gameBloc.add(const BonusActivated(GameBonus.dashNest)), - ).called(1); - } else { - verifyNever( - () => gameBloc.add(const BonusActivated(GameBonus.dashNest)), - ); - } - } - }, - ); - - flameBlocTester.testGameWidget( - 'deactivates bumpers when 3 are active', - setUp: (game, _) async { - final ball = Ball(baseColor: const Color(0xFFFF0000)); - final flutterForest = FlutterForest(); - await game.ensureAddAll([flutterForest, ball]); - - final bumpers = [ - MockDashNestBumper(), - MockDashNestBumper(), - MockDashNestBumper(), - ]; - - for (final bumper in bumpers) { - flutterForest.controller.activateBumper(bumper); - await game.ready(); - - if (bumper == bumpers.last) { - for (final bumper in bumpers) { - verify(bumper.deactivate).called(1); - } - } - } - }, - ); - }); - }); -} diff --git a/test/game/components/google_word/behaviors/google_word_bonus_behavior_test.dart b/test/game/components/google_word/behaviors/google_word_bonus_behavior_test.dart new file mode 100644 index 00000000..deca61ee --- /dev/null +++ b/test/game/components/google_word/behaviors/google_word_bonus_behavior_test.dart @@ -0,0 +1,61 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mockingjay/mockingjay.dart'; +import 'package:pinball/game/components/google_word/behaviors/behaviors.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('GoogleWordBonusBehaviors', () { + late GameBloc gameBloc; + + setUp(() { + gameBloc = MockGameBloc(); + whenListen( + gameBloc, + const Stream.empty(), + initialState: const GameState.initial(), + ); + }); + + final flameBlocTester = FlameBlocTester( + gameBuilder: EmptyPinballTestGame.new, + blocBuilder: () => gameBloc, + ); + + flameBlocTester.testGameWidget( + 'adds GameBonus.googleWord to the game when all letters are activated', + setUp: (game, tester) async { + final behavior = GoogleWordBonusBehavior(); + final parent = GoogleWord.test(); + final letters = [ + GoogleLetter(0), + GoogleLetter(1), + GoogleLetter(2), + GoogleLetter(3), + GoogleLetter(4), + GoogleLetter(5), + ]; + await parent.addAll(letters); + await game.ensureAdd(parent); + await parent.ensureAdd(behavior); + + for (final letter in letters) { + letter.bloc.onBallContacted(); + } + await tester.pump(); + + verify( + () => gameBloc.add(const BonusActivated(GameBonus.googleWord)), + ).called(1); + }, + ); + }); +} diff --git a/test/game/components/google_word/google_word_test.dart b/test/game/components/google_word/google_word_test.dart new file mode 100644 index 00000000..2d7d04e5 --- /dev/null +++ b/test/game/components/google_word/google_word_test.dart @@ -0,0 +1,26 @@ +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester(EmptyPinballTestGame.new); + + group('GoogleWord', () { + flameTester.test( + 'loads the letters correctly', + (game) async { + const word = 'Google'; + final googleWord = GoogleWord(position: Vector2.zero()); + await game.ensureAdd(googleWord); + + final letters = googleWord.children.whereType(); + expect(letters.length, equals(word.length)); + }, + ); + }); +} diff --git a/test/game/components/google_word_test.dart b/test/game/components/google_word_test.dart deleted file mode 100644 index fee7bdd0..00000000 --- a/test/game/components/google_word_test.dart +++ /dev/null @@ -1,73 +0,0 @@ -// ignore_for_file: cascade_invocations - -import 'package:bloc_test/bloc_test.dart'; -import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:flame_test/flame_test.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:mockingjay/mockingjay.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball_components/pinball_components.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - TestWidgetsFlutterBinding.ensureInitialized(); - - group('GoogleWord', () { - late GameBloc gameBloc; - - setUp(() { - gameBloc = MockGameBloc(); - whenListen( - gameBloc, - const Stream.empty(), - initialState: const GameState.initial(), - ); - }); - - final flameTester = FlameTester(EmptyPinballTestGame.new); - final flameBlocTester = FlameBlocTester( - gameBuilder: EmptyPinballTestGame.new, - blocBuilder: () => gameBloc, - ); - - flameTester.test( - 'loads the letters correctly', - (game) async { - const word = 'Google'; - final googleWord = GoogleWord(position: Vector2.zero()); - await game.ensureAdd(googleWord); - - final letters = googleWord.children.whereType(); - expect(letters.length, equals(word.length)); - }, - ); - - flameBlocTester.testGameWidget( - 'adds GameBonus.googleWord to the game when all letters are activated', - setUp: (game, _) async { - final ball = Ball(baseColor: const Color(0xFFFF0000)); - final googleWord = GoogleWord(position: Vector2.zero()); - await game.ensureAddAll([googleWord, ball]); - - final letters = googleWord.children.whereType(); - expect(letters, isNotEmpty); - for (final letter in letters) { - beginContact(game, letter, ball); - await game.ready(); - - if (letter == letters.last) { - verify( - () => gameBloc.add(const BonusActivated(GameBonus.googleWord)), - ).called(1); - } else { - verifyNever( - () => gameBloc.add(const BonusActivated(GameBonus.googleWord)), - ); - } - } - }, - ); - }); -} diff --git a/test/game/components/score_points_test.dart b/test/game/components/score_points_test.dart deleted file mode 100644 index dcd0ad82..00000000 --- a/test/game/components/score_points_test.dart +++ /dev/null @@ -1,105 +0,0 @@ -import 'package:flame_forge2d/flame_forge2d.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:mocktail/mocktail.dart'; -import 'package:pinball/game/game.dart'; -import 'package:pinball_audio/pinball_audio.dart'; -import 'package:pinball_components/pinball_components.dart'; - -import '../../helpers/helpers.dart'; - -class FakeScorePoints extends BodyComponent with ScorePoints { - @override - Body createBody() { - throw UnimplementedError(); - } - - @override - int get points => 2; -} - -void main() { - group('BallScorePointsCallback', () { - late PinballGame game; - late GameBloc bloc; - late PinballAudio audio; - late Ball ball; - late FakeScorePoints fakeScorePoints; - - setUp(() { - game = MockPinballGame(); - bloc = MockGameBloc(); - audio = MockPinballAudio(); - fakeScorePoints = FakeScorePoints(); - - ball = MockBall(); - final ballBody = MockBody(); - when(() => ball.body).thenReturn(ballBody); - when(() => ballBody.position).thenReturn(Vector2.all(4)); - }); - - setUpAll(() { - registerFallbackValue(FakeGameEvent()); - }); - - group('begin', () { - test( - 'emits Scored event with points', - () { - when(game.read).thenReturn(bloc); - when(() => game.audio).thenReturn(audio); - - BallScorePointsCallback(game).begin( - ball, - fakeScorePoints, - FakeContact(), - ); - - verify( - () => bloc.add( - Scored(points: fakeScorePoints.points), - ), - ).called(1); - }, - ); - - test( - 'plays a Score sound', - () { - when(game.read).thenReturn(bloc); - when(() => game.audio).thenReturn(audio); - - BallScorePointsCallback(game).begin( - ball, - fakeScorePoints, - FakeContact(), - ); - - verify(audio.score).called(1); - }, - ); - - test( - "adds a ScoreText component at Ball's position", - () { - when(game.read).thenReturn(bloc); - when(() => game.audio).thenReturn(audio); - - BallScorePointsCallback(game).begin( - ball, - fakeScorePoints, - FakeContact(), - ); - - verify( - () => game.add( - ScoreText( - text: fakeScorePoints.points.toString(), - position: ball.body.position, - ), - ), - ).called(1); - }, - ); - }); - }); -} diff --git a/test/game/components/scoring_behavior_test.dart b/test/game/components/scoring_behavior_test.dart new file mode 100644 index 00000000..d5e706b0 --- /dev/null +++ b/test/game/components/scoring_behavior_test.dart @@ -0,0 +1,111 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_audio/pinball_audio.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../helpers/helpers.dart'; + +class _TestBodyComponent extends BodyComponent { + @override + Body createBody() => world.createBody(BodyDef()); +} + +void main() { + group('ScoringBehavior', () { + group('beginContact', () { + late GameBloc bloc; + late PinballAudio audio; + late Ball ball; + late BodyComponent parent; + + setUp(() { + audio = MockPinballAudio(); + + ball = MockBall(); + final ballBody = MockBody(); + when(() => ball.body).thenReturn(ballBody); + when(() => ballBody.position).thenReturn(Vector2.all(4)); + + parent = _TestBodyComponent(); + }); + + final flameBlocTester = FlameBlocTester( + gameBuilder: () => EmptyPinballTestGame( + audio: audio, + ), + blocBuilder: () { + bloc = MockGameBloc(); + const state = GameState( + score: 0, + balls: 0, + bonusHistory: [], + ); + whenListen(bloc, Stream.value(state), initialState: state); + return bloc; + }, + ); + + flameBlocTester.testGameWidget( + 'emits Scored event with points', + setUp: (game, tester) async { + const points = 20; + final scoringBehavior = ScoringBehavior(points: points); + await parent.add(scoringBehavior); + await game.ensureAdd(parent); + + scoringBehavior.beginContact(ball, MockContact()); + + verify( + () => bloc.add( + const Scored(points: points), + ), + ).called(1); + }, + ); + + flameBlocTester.testGameWidget( + 'plays score sound', + setUp: (game, tester) async { + const points = 20; + final scoringBehavior = ScoringBehavior(points: points); + await parent.add(scoringBehavior); + await game.ensureAdd(parent); + + scoringBehavior.beginContact(ball, MockContact()); + + verify(audio.score).called(1); + }, + ); + + flameBlocTester.testGameWidget( + "adds a ScoreText component at Ball's position with points", + setUp: (game, tester) async { + const points = 20; + final scoringBehavior = ScoringBehavior(points: points); + await parent.add(scoringBehavior); + await game.ensureAdd(parent); + + scoringBehavior.beginContact(ball, MockContact()); + await game.ready(); + + final scoreText = game.descendants().whereType(); + expect(scoreText.length, equals(1)); + expect( + scoreText.first.text, + equals(points.toString()), + ); + expect( + scoreText.first.position, + equals(ball.body.position), + ); + }, + ); + }); + }); +} diff --git a/test/game/components/sparky_fire_zone_test.dart b/test/game/components/sparky_fire_zone_test.dart index 0ad69dab..9b254617 100644 --- a/test/game/components/sparky_fire_zone_test.dart +++ b/test/game/components/sparky_fire_zone_test.dart @@ -1,8 +1,5 @@ // ignore_for_file: cascade_invocations -import 'dart:ui'; - -import 'package:bloc_test/bloc_test.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mocktail/mocktail.dart'; @@ -23,7 +20,10 @@ void main() { Assets.images.sparky.bumper.c.inactive.keyName, Assets.images.sparky.animatronic.keyName, ]; - final flameTester = FlameTester(() => EmptyPinballTestGame(assets)); + + final flameTester = FlameTester( + () => EmptyPinballTestGame(assets: assets), + ); group('SparkyFireZone', () { flameTester.test('loads correctly', (game) async { @@ -70,93 +70,40 @@ void main() { }, ); }); - - group('bumpers', () { - late GameBloc gameBloc; - - setUp(() { - gameBloc = MockGameBloc(); - whenListen( - gameBloc, - const Stream.empty(), - initialState: const GameState.initial(), - ); - }); - - final flameBlocTester = FlameBlocTester( - gameBuilder: EmptyPinballTestGame.new, - blocBuilder: () => gameBloc, - assets: assets, - ); - - flameTester.test('call animate on contact', (game) async { - final contactCallback = SparkyBumperBallContactCallback(); - final bumper = MockSparkyBumper(); - final ball = MockBall(); - - when(bumper.animate).thenAnswer((_) async {}); - - contactCallback.begin(bumper, ball, MockContact()); - - verify(bumper.animate).called(1); - }); - - flameBlocTester.testGameWidget( - 'add Scored event', - setUp: (game, tester) async { - final ball = Ball(baseColor: const Color(0xFF00FFFF)); - final sparkyFireZone = SparkyFireZone(); - await game.addFromBlueprint(sparkyFireZone); - await game.ensureAdd(ball); - game.addContactCallback(BallScorePointsCallback(game)); - - final bumpers = sparkyFireZone.components.whereType(); - - for (final bumper in bumpers) { - beginContact(game, bumper, ball); - verify( - () => gameBloc.add( - Scored(points: bumper.points), - ), - ).called(1); - } - }, - ); - }); }); - group('SparkyTurboChargeSensorBallContactCallback', () { + group('SparkyComputerSensor', () { flameTester.test('calls turboCharge', (game) async { - final callback = SparkyComputerSensorBallContactCallback(); + final sensor = SparkyComputerSensor(); final ball = MockControlledBall(); final controller = MockBallController(); when(() => ball.controller).thenReturn(controller); - when(() => ball.gameRef).thenReturn(game); when(controller.turboCharge).thenAnswer((_) async {}); - callback.begin(MockSparkyComputerSensor(), ball, MockContact()); + await game.ensureAddAll([ + sensor, + SparkyAnimatronic(), + ]); + + sensor.beginContact(ball, MockContact()); verify(() => ball.controller.turboCharge()).called(1); }); flameTester.test('plays SparkyAnimatronic', (game) async { - final callback = SparkyComputerSensorBallContactCallback(); + final sensor = SparkyComputerSensor(); + final sparkyAnimatronic = SparkyAnimatronic(); final ball = MockControlledBall(); final controller = MockBallController(); when(() => ball.controller).thenReturn(controller); - when(() => ball.gameRef).thenReturn(game); when(controller.turboCharge).thenAnswer((_) async {}); - - final sparkyFireZone = SparkyFireZone(); - await game.addFromBlueprint(sparkyFireZone); - await game.ready(); - - final sparkyAnimatronic = - sparkyFireZone.components.whereType().single; + await game.ensureAddAll([ + sensor, + sparkyAnimatronic, + ]); expect(sparkyAnimatronic.playing, isFalse); - callback.begin(MockSparkyComputerSensor(), ball, MockContact()); - + sensor.beginContact(ball, MockContact()); expect(sparkyAnimatronic.playing, isTrue); }); }); diff --git a/test/game/components/wall_test.dart b/test/game/components/wall_test.dart index 92fe33ea..2905ab9a 100644 --- a/test/game/components/wall_test.dart +++ b/test/game/components/wall_test.dart @@ -122,7 +122,6 @@ void main() { ); final wall = BottomWall(); await game.ensureAddAll([ball, wall]); - game.addContactCallback(BottomWallBallContactCallback()); beginContact(game, ball, wall); await game.ready(); @@ -139,7 +138,6 @@ void main() { ); final wall = BottomWall(); await game.ensureAddAll([ball, wall]); - game.addContactCallback(BottomWallBallContactCallback()); beginContact(game, ball, wall); await game.ready(); @@ -154,7 +152,6 @@ void main() { final ball = ControlledBall.debug(); final wall = BottomWall(); await game.ensureAddAll([ball, wall]); - game.addContactCallback(BottomWallBallContactCallback()); beginContact(game, ball, wall); await game.ready(); diff --git a/test/game/pinball_game_test.dart b/test/game/pinball_game_test.dart index d6bbb099..b265c0aa 100644 --- a/test/game/pinball_game_test.dart +++ b/test/game/pinball_game_test.dart @@ -57,14 +57,17 @@ void main() { Assets.images.dino.dinoLandTop.keyName, Assets.images.dino.dinoLandBottom.keyName, ]; - final flameTester = FlameTester(() => PinballTestGame(assets)); - final debugModeFlameTester = FlameTester(() => DebugPinballTestGame(assets)); + final flameTester = FlameTester( + () => PinballTestGame(assets: assets), + ); + final debugModeFlameTester = FlameTester( + () => DebugPinballTestGame(assets: assets), + ); group('PinballGame', () { - // TODO(alestiago): test if [PinballGame] registers - // [BallScorePointsCallback] once the following issue is resolved: - // https://github.com/flame-engine/flame/issues/1416 group('components', () { + // TODO(alestiago): tests that Blueprints get added once the Blueprint + // class is removed. flameTester.test( 'has only one BottomWall', (game) async { @@ -96,14 +99,6 @@ void main() { ); }); - flameTester.test( - 'one AlienZone', - (game) async { - await game.ready(); - expect(game.children.whereType().length, equals(1)); - }, - ); - group('controller', () { // TODO(alestiago): Write test to be controller agnostic. group('listenWhen', () { diff --git a/test/helpers/mocks.dart b/test/helpers/mocks.dart index 586ef3b0..da6f5124 100644 --- a/test/helpers/mocks.dart +++ b/test/helpers/mocks.dart @@ -29,9 +29,6 @@ class MockBallController extends Mock implements BallController {} class MockContact extends Mock implements Contact {} -class MockContactCallback extends Mock - implements ContactCallback {} - class MockGameBloc extends Mock implements GameBloc {} class MockStartGameBloc extends Mock implements StartGameBloc {} diff --git a/test/helpers/test_games.dart b/test/helpers/test_games.dart index deeba2c3..baa466b8 100644 --- a/test/helpers/test_games.dart +++ b/test/helpers/test_games.dart @@ -5,6 +5,7 @@ import 'dart:async'; import 'package:flame_bloc/flame_bloc.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball/game/game.dart'; +import 'package:pinball_audio/pinball_audio.dart'; import 'package:pinball_theme/pinball_theme.dart'; import 'helpers.dart'; @@ -16,11 +17,14 @@ class TestGame extends Forge2DGame with FlameBloc { } class PinballTestGame extends PinballGame { - PinballTestGame([List? assets]) - : _assets = assets, + PinballTestGame({ + List? assets, + PinballAudio? audio, + CharacterTheme? theme, + }) : _assets = assets, super( - audio: MockPinballAudio(), - characterTheme: const DashTheme(), + audio: audio ?? MockPinballAudio(), + characterTheme: theme ?? const DashTheme(), ); final List? _assets; @@ -34,11 +38,14 @@ class PinballTestGame extends PinballGame { } class DebugPinballTestGame extends DebugPinballGame { - DebugPinballTestGame([List? assets]) - : _assets = assets, + DebugPinballTestGame({ + List? assets, + PinballAudio? audio, + CharacterTheme? theme, + }) : _assets = assets, super( - audio: MockPinballAudio(), - characterTheme: const DashTheme(), + audio: audio ?? MockPinballAudio(), + characterTheme: theme ?? const DashTheme(), ); final List? _assets; @@ -53,7 +60,15 @@ class DebugPinballTestGame extends DebugPinballGame { } class EmptyPinballTestGame extends PinballTestGame { - EmptyPinballTestGame([List? assets]) : super(assets); + EmptyPinballTestGame({ + List? assets, + PinballAudio? audio, + CharacterTheme? theme, + }) : super( + assets: assets, + audio: audio, + theme: theme, + ); @override Future onLoad() async {