diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml index 82d8fae0..f260a028 100644 --- a/.github/workflows/deploy.yaml +++ b/.github/workflows/deploy.yaml @@ -21,7 +21,7 @@ jobs: - name: Build Flutter App run: | flutter packages get - flutter build web --target lib/main_development.dart --web-renderer canvaskit --release + flutter build web --target lib/main.dart --web-renderer canvaskit --release - name: Deploy to Firebase uses: FirebaseExtended/action-hosting-deploy@v0 diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 5bef442d..48ad112c 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -14,3 +14,4 @@ jobs: flutter_version: 2.10.5 coverage_excludes: "lib/gen/*.dart" test_optimization: false + diff --git a/.github/workflows/spell_check.yaml b/.github/workflows/spell_check.yaml new file mode 100644 index 00000000..bfef58f8 --- /dev/null +++ b/.github/workflows/spell_check.yaml @@ -0,0 +1,21 @@ +name: spell_check + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +on: [pull_request] + +jobs: + build: + name: Spell Check + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Check spelling + uses: zwaldowski/cspell-action@v1 + with: + paths: '**/*.{dart,arb,md}' + config: .vscode/cspell.json \ No newline at end of file diff --git a/.idea/runConfigurations/development.xml b/.idea/runConfigurations/development.xml deleted file mode 100644 index 37d45fe3..00000000 --- a/.idea/runConfigurations/development.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/runConfigurations/main.xml b/.idea/runConfigurations/main.xml new file mode 100644 index 00000000..b5c260ef --- /dev/null +++ b/.idea/runConfigurations/main.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/runConfigurations/production.xml b/.idea/runConfigurations/production.xml deleted file mode 100644 index e55961d8..00000000 --- a/.idea/runConfigurations/production.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/runConfigurations/staging.xml b/.idea/runConfigurations/staging.xml deleted file mode 100644 index 3f7d6219..00000000 --- a/.idea/runConfigurations/staging.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - \ No newline at end of file diff --git a/.vscode/cspell.json b/.vscode/cspell.json new file mode 100644 index 00000000..71c54903 --- /dev/null +++ b/.vscode/cspell.json @@ -0,0 +1,50 @@ +{ + "version": "0.2", + "enabled": true, + "language": "en", + "words": [ + "animatronic", + "argb", + "audioplayers", + "backbox", + "bezier", + "contador", + "cupertino", + "dashbook", + "deserialization", + "dpad", + "endtemplate", + "firestore", + "gapless", + "genhtml", + "goldens", + "lcov", + "leaderboard", + "loadables", + "localizable", + "mixins", + "mocktail", + "mostrado", + "multiball", + "multiballs", + "occluder", + "pรกgina", + "pixelated", + "pixeloid", + "rects", + "rrect", + "serializable", + "sparky's", + "tappable", + "tappables", + "texto", + "theming", + "unawaited", + "unfocus", + "unlayered", + "vsync" + ], + "ignorePaths": [ + ".github/workflows/**" + ] +} diff --git a/.vscode/launch.json b/.vscode/launch.json index 1b855b10..e2ea6cee 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -5,30 +5,10 @@ "version": "0.2.0", "configurations": [ { - "name": "Launch development", + "name": "Launch pinball", "request": "launch", "type": "dart", - "program": "lib/main_development.dart", - "args": [ - "--flavor", - "development", - "--target", - "lib/main_development.dart" - ] - }, - { - "name": "Launch staging", - "request": "launch", - "type": "dart", - "program": "lib/main_staging.dart", - "args": ["--flavor", "staging", "--target", "lib/main_staging.dart"] - }, - { - "name": "Launch production", - "request": "launch", - "type": "dart", - "program": "lib/main_production.dart", - "args": ["--flavor", "production", "--target", "lib/main_production.dart"] + "program": "lib/main.dart" }, { "name": "Launch component sandbox", diff --git a/README.md b/README.md index b91a1c98..957cb05b 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,31 @@ -# Pinball +# I/O Pinball +[![Pinball Header][logo]][pinball_link] + +[![io_pinball][build_status_badge]][workflow_link] ![coverage][coverage_badge] [![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link] [![License: MIT][license_badge]][license_link] -Generated by the [Very Good CLI][very_good_cli_link] ๐Ÿค– +A Pinball game built with [Flutter][flutter_link] and [Firebase][firebase_link] for [Google I/O 2022][google_io_link]. -Google I/O 2022 Pinball game built with Flutter and Firebase +[Try it now][pinball_link] and [learn about how it's made][blog_link]. ---- +_Built by [Very Good Ventures][very_good_ventures_link] in partnership with Google_ -## Getting Started ๐Ÿš€ +_Created using [Very Good CLI][very_good_cli_link] ๐Ÿค–_ -This project contains 3 flavors: +--- -- development -- staging -- production +## Getting Started ๐Ÿš€ -To run the desired flavor either use the launch configuration in VSCode/Android Studio or use the following commands: +To run the desired project either use the launch configuration in VSCode/Android Studio or use the following commands: ```sh -# Development -$ flutter run --flavor development --target lib/main_development.dart - -# Staging -$ flutter run --flavor staging --target lib/main_staging.dart - -# Production -$ flutter run --flavor production --target lib/main_production.dart +$ flutter run -d chrome ``` -_\*Pinball works on iOS, Android, Web, and Windows._ +_\*I/O Pinball works on Web for desktop and mobile._ --- @@ -48,7 +42,6 @@ To view the generated coverage report you can use [lcov](https://github.com/linu ```sh # Generate Coverage Report $ genhtml coverage/lcov.info -o coverage/ - # Open Coverage Report $ open coverage/index.html ``` @@ -101,22 +94,6 @@ Widget build(BuildContext context) { } ``` -### Adding Supported Locales - -Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info.plist` to include the new locale. - -```xml - ... - - CFBundleLocalizations - - en - es - - - ... -``` - ### Adding Translations 1. For each supported locale, add a new ARB file in `lib/l10n/arb`. @@ -154,38 +131,20 @@ Update the `CFBundleLocalizations` array in the `Info.plist` at `ios/Runner/Info } ``` -### Deploy application to Firebase hosting - -Follow the following steps to deploy the application. - -## Firebase CLI - -Install and authenticate with [Firebase CLI tools](https://firebase.google.com/docs/cli) - -## Build the project using the desired environment - -```bash -# Development -$ flutter build web --release --target lib/main_development.dart - -# Staging -$ flutter build web --release --target lib/main_staging.dart - -# Production -$ flutter build web --release --target lib/main_production.dart -``` - -## Deploy - -```bash -$ firebase deploy -``` - +[build_status_badge]: https://github.com/flutter/pinball/actions/workflows/main.yaml/badge.svg [coverage_badge]: coverage_badge.svg +[firebase_link]: https://firebase.google.com/ +[flutter_link]: https://flutter.dev [flutter_localizations_link]: https://api.flutter.dev/flutter/flutter_localizations/flutter_localizations-library.html +[google_io_link]: https://events.google.com/io/ +[blog_link]: https://medium.com/flutter/i-o-pinball-powered-by-flutter-and-firebase-d22423f3f5d [internationalization_link]: https://flutter.dev/docs/development/accessibility-and-localization/internationalization [license_badge]: https://img.shields.io/badge/license-MIT-blue.svg [license_link]: https://opensource.org/licenses/MIT +[logo]: art/readme_header.png +[pinball_link]: https://pinball.flutter.dev [very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg [very_good_analysis_link]: https://pub.dev/packages/very_good_analysis [very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli +[very_good_ventures_link]: https://verygood.ventures/ +[workflow_link]: https://github.com/flutter/pinball/actions/workflows/main.yaml diff --git a/art/readme_header.png b/art/readme_header.png new file mode 100644 index 00000000..43e7fb53 Binary files /dev/null and b/art/readme_header.png differ diff --git a/assets/images/loading_game/io_pinball.png b/assets/images/loading_game/io_pinball.png new file mode 100644 index 00000000..c8d9fadc Binary files /dev/null and b/assets/images/loading_game/io_pinball.png differ diff --git a/lib/app/view/app.dart b/lib/app/view/app.dart index eccff7a6..89f03dfa 100644 --- a/lib/app/view/app.dart +++ b/lib/app/view/app.dart @@ -15,15 +15,15 @@ class App extends StatelessWidget { Key? key, required AuthenticationRepository authenticationRepository, required LeaderboardRepository leaderboardRepository, - required PinballPlayer pinballPlayer, + required PinballAudioPlayer pinballAudioPlayer, }) : _authenticationRepository = authenticationRepository, _leaderboardRepository = leaderboardRepository, - _pinballPlayer = pinballPlayer, + _pinballAudioPlayer = pinballAudioPlayer, super(key: key); final AuthenticationRepository _authenticationRepository; final LeaderboardRepository _leaderboardRepository; - final PinballPlayer _pinballPlayer; + final PinballAudioPlayer _pinballAudioPlayer; @override Widget build(BuildContext context) { @@ -31,7 +31,7 @@ class App extends StatelessWidget { providers: [ RepositoryProvider.value(value: _authenticationRepository), RepositoryProvider.value(value: _leaderboardRepository), - RepositoryProvider.value(value: _pinballPlayer), + RepositoryProvider.value(value: _pinballAudioPlayer), ], child: MultiBlocProvider( providers: [ diff --git a/lib/assets_manager/cubit/assets_manager_cubit.dart b/lib/assets_manager/cubit/assets_manager_cubit.dart index b97483d4..65b780c2 100644 --- a/lib/assets_manager/cubit/assets_manager_cubit.dart +++ b/lib/assets_manager/cubit/assets_manager_cubit.dart @@ -1,27 +1,39 @@ import 'package:bloc/bloc.dart'; import 'package:equatable/equatable.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball/select_character/select_character.dart'; +import 'package:pinball_audio/pinball_audio.dart'; part 'assets_manager_state.dart'; -/// {@template assets_manager_cubit} -/// Cubit responsable for pre loading any game assets -/// {@endtemplate} class AssetsManagerCubit extends Cubit { - /// {@macro assets_manager_cubit} - AssetsManagerCubit(List loadables) - : super( - AssetsManagerState.initial( - loadables: loadables, - ), - ); + AssetsManagerCubit(this._game, this._audioPlayer) + : super(const AssetsManagerState.initial()); + + final PinballGame _game; + final PinballAudioPlayer _audioPlayer; - /// Loads the assets Future load() async { + /// Assigning loadables is a very expensive operation. With this purposeful + /// delay here, which is a bit random in duration but enough to let the UI + /// do its job without adding too much delay for the user, we are letting + /// the UI paint first, and then we start loading the assets. + await Future.delayed(const Duration(milliseconds: 300)); + emit( + state.copyWith( + loadables: [ + _game.preFetchLeaderboard(), + ..._game.preLoadAssets(), + ..._audioPlayer.load(), + ...BonusAnimation.loadAssets(), + ...SelectedCharacter.loadAssets(), + ], + ), + ); final all = state.loadables.map((loadable) async { await loadable; emit(state.copyWith(loaded: [...state.loaded, loadable])); }).toList(); - await Future.wait(all); } } diff --git a/lib/assets_manager/cubit/assets_manager_state.dart b/lib/assets_manager/cubit/assets_manager_state.dart index 8ef1e874..4847adc6 100644 --- a/lib/assets_manager/cubit/assets_manager_state.dart +++ b/lib/assets_manager/cubit/assets_manager_state.dart @@ -11,9 +11,8 @@ class AssetsManagerState extends Equatable { }); /// {@macro assets_manager_state} - const AssetsManagerState.initial({ - required List loadables, - }) : this(loadables: loadables, loaded: const []); + const AssetsManagerState.initial() + : this(loadables: const [], loaded: const []); /// List of futures to load final List loadables; @@ -22,7 +21,11 @@ class AssetsManagerState extends Equatable { final List loaded; /// Returns a value between 0 and 1 to indicate the loading progress - double get progress => loaded.length / loadables.length; + double get progress => + loadables.isEmpty ? 0 : loaded.length / loadables.length; + + /// Only returns false if all the assets have been loaded + bool get isLoading => progress != 1; /// Returns a copy of this instance with the given parameters /// updated diff --git a/lib/assets_manager/views/assets_loading_page.dart b/lib/assets_manager/views/assets_loading_page.dart index ddb76803..4e75a3a5 100644 --- a/lib/assets_manager/views/assets_loading_page.dart +++ b/lib/assets_manager/views/assets_loading_page.dart @@ -1,6 +1,7 @@ import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; import 'package:pinball/assets_manager/assets_manager.dart'; +import 'package:pinball/gen/gen.dart'; import 'package:pinball/l10n/l10n.dart'; import 'package:pinball_ui/pinball_ui.dart'; @@ -20,10 +21,9 @@ class AssetsLoadingPage extends StatelessWidget { child: Column( mainAxisSize: MainAxisSize.min, children: [ - Text( - l10n.ioPinball, - style: headline1!.copyWith(fontSize: 80), - textAlign: TextAlign.center, + Padding( + padding: const EdgeInsets.symmetric(horizontal: 20), + child: Assets.images.loadingGame.ioPinball.image(), ), const SizedBox(height: 40), AnimatedEllipsisText( diff --git a/lib/game/behaviors/bonus_noise_behavior.dart b/lib/game/behaviors/bonus_noise_behavior.dart index 70c8ad3e..b330dc9f 100644 --- a/lib/game/behaviors/bonus_noise_behavior.dart +++ b/lib/game/behaviors/bonus_noise_behavior.dart @@ -15,7 +15,7 @@ class BonusNoiseBehavior extends Component { }, onNewState: (state) { final bonus = state.bonusHistory.last; - final audioPlayer = readProvider(); + final audioPlayer = readProvider(); switch (bonus) { case GameBonus.googleWord: @@ -25,10 +25,13 @@ class BonusNoiseBehavior extends Component { audioPlayer.play(PinballAudio.sparky); break; case GameBonus.dinoChomp: + audioPlayer.play(PinballAudio.dino); break; case GameBonus.androidSpaceship: + audioPlayer.play(PinballAudio.android); break; case GameBonus.dashNest: + audioPlayer.play(PinballAudio.dash); break; } }, diff --git a/lib/game/behaviors/bumper_noise_behavior.dart b/lib/game/behaviors/bumper_noise_behavior.dart index 926fff96..4144241a 100644 --- a/lib/game/behaviors/bumper_noise_behavior.dart +++ b/lib/game/behaviors/bumper_noise_behavior.dart @@ -6,6 +6,6 @@ class BumperNoiseBehavior extends ContactBehavior { @override void beginContact(Object other, Contact contact) { super.beginContact(other, contact); - readProvider().play(PinballAudio.bumper); + readProvider().play(PinballAudio.bumper); } } diff --git a/lib/game/behaviors/scoring_behavior.dart b/lib/game/behaviors/scoring_behavior.dart index 8b403d1e..4d6d8b42 100644 --- a/lib/game/behaviors/scoring_behavior.dart +++ b/lib/game/behaviors/scoring_behavior.dart @@ -15,7 +15,7 @@ import 'package:pinball_flame/pinball_flame.dart'; /// {@endtemplate} class ScoringBehavior extends Component with HasGameRef, FlameBlocReader { - /// {@macto scoring_behavior} + /// {@macro scoring_behavior} ScoringBehavior({ required Points points, required Vector2 position, diff --git a/lib/game/bloc/game_bloc.dart b/lib/game/bloc/game_bloc.dart index d00e5da1..795d04e2 100644 --- a/lib/game/bloc/game_bloc.dart +++ b/lib/game/bloc/game_bloc.dart @@ -12,7 +12,6 @@ class GameBloc extends Bloc { on(_onScored); on(_onIncreasedMultiplier); on(_onBonusActivated); - on(_onSparkyTurboChargeActivated); on(_onGameOver); on(_onGameStarted); } @@ -65,18 +64,4 @@ class GameBloc extends Bloc { ), ); } - - Future _onSparkyTurboChargeActivated( - SparkyTurboChargeActivated event, - Emitter emit, - ) async { - emit( - state.copyWith( - bonusHistory: [ - ...state.bonusHistory, - GameBonus.sparkyTurboCharge, - ], - ), - ); - } } diff --git a/lib/game/bloc/game_event.dart b/lib/game/bloc/game_event.dart index a8e8593b..126ba299 100644 --- a/lib/game/bloc/game_event.dart +++ b/lib/game/bloc/game_event.dart @@ -40,13 +40,6 @@ class BonusActivated extends GameEvent { List get props => [bonus]; } -class SparkyTurboChargeActivated extends GameEvent { - const SparkyTurboChargeActivated(); - - @override - List get props => []; -} - /// {@template multiplier_increased_game_event} /// Added when a multiplier is gained. /// {@endtemplate} diff --git a/lib/game/bloc/game_state.dart b/lib/game/bloc/game_state.dart index c45da958..8fcab789 100644 --- a/lib/game/bloc/game_state.dart +++ b/lib/game/bloc/game_state.dart @@ -5,7 +5,7 @@ enum GameBonus { /// Bonus achieved when the ball activates all Google letters. googleWord, - /// Bonus achieved when the user activates all dash nest bumpers. + /// Bonus achieved when the user activates all dash bumpers. dashNest, /// Bonus achieved when a ball enters Sparky's computer. diff --git a/lib/game/components/android_acres/android_acres.dart b/lib/game/components/android_acres/android_acres.dart index 7f9fff13..902eb11c 100644 --- a/lib/game/components/android_acres/android_acres.dart +++ b/lib/game/components/android_acres/android_acres.dart @@ -1,6 +1,7 @@ // ignore_for_file: avoid_renaming_method_parameters import 'package:flame/components.dart'; +import 'package:flame_bloc/flame_bloc.dart'; import 'package:flutter/material.dart'; import 'package:pinball/game/behaviors/behaviors.dart'; import 'package:pinball/game/components/android_acres/behaviors/behaviors.dart'; @@ -15,42 +16,43 @@ class AndroidAcres extends Component { AndroidAcres() : super( children: [ - SpaceshipRamp( + FlameBlocProvider( + create: AndroidSpaceshipCubit.new, children: [ - RampShotBehavior( - points: Points.fiveThousand, - ), - RampBonusBehavior( - points: Points.oneMillion, + SpaceshipRamp( + children: [ + RampShotBehavior(points: Points.fiveThousand), + RampBonusBehavior(points: Points.oneMillion), + ], ), + SpaceshipRail(), + AndroidSpaceship(position: Vector2(-26.5, -28.5)), + AndroidAnimatronic( + children: [ + ScoringContactBehavior(points: Points.twoHundredThousand), + ], + )..initialPosition = Vector2(-26, -28.25), + AndroidBumper.a( + children: [ + ScoringContactBehavior(points: Points.twentyThousand), + BumperNoiseBehavior(), + ], + )..initialPosition = Vector2(-25.2, 1.5), + AndroidBumper.b( + children: [ + ScoringContactBehavior(points: Points.twentyThousand), + BumperNoiseBehavior(), + ], + )..initialPosition = Vector2(-32.9, -9.3), + AndroidBumper.cow( + children: [ + ScoringContactBehavior(points: Points.twentyThousand), + BumperNoiseBehavior(), + ], + )..initialPosition = Vector2(-20.7, -13), + AndroidSpaceshipBonusBehavior(), ], ), - SpaceshipRail(), - AndroidSpaceship(position: Vector2(-26.5, -28.5)), - AndroidAnimatronic( - children: [ - ScoringContactBehavior(points: Points.twoHundredThousand), - ], - )..initialPosition = Vector2(-26, -28.25), - AndroidBumper.a( - children: [ - ScoringContactBehavior(points: Points.twentyThousand), - BumperNoiseBehavior(), - ], - )..initialPosition = Vector2(-25.2, 1.5), - AndroidBumper.b( - children: [ - ScoringContactBehavior(points: Points.twentyThousand), - BumperNoiseBehavior(), - ], - )..initialPosition = Vector2(-32.9, -9.3), - AndroidBumper.cow( - children: [ - ScoringContactBehavior(points: Points.twentyThousand), - BumperNoiseBehavior(), - ], - )..initialPosition = Vector2(-20.7, -13), - AndroidSpaceshipBonusBehavior(), ], ); diff --git a/lib/game/components/android_acres/behaviors/android_spaceship_bonus_behavior.dart b/lib/game/components/android_acres/behaviors/android_spaceship_bonus_behavior.dart index cbb6e516..3b6f59ec 100644 --- a/lib/game/components/android_acres/behaviors/android_spaceship_bonus_behavior.dart +++ b/lib/game/components/android_acres/behaviors/android_spaceship_bonus_behavior.dart @@ -5,18 +5,21 @@ import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; /// Adds a [GameBonus.androidSpaceship] when [AndroidSpaceship] has a bonus. -class AndroidSpaceshipBonusBehavior extends Component - with ParentIsA, FlameBlocReader { +class AndroidSpaceshipBonusBehavior extends Component { @override - void onMount() { - super.onMount(); - final androidSpaceship = parent.firstChild()!; - androidSpaceship.bloc.stream.listen((state) { - final listenWhen = state == AndroidSpaceshipState.withBonus; - if (!listenWhen) return; - - bloc.add(const BonusActivated(GameBonus.androidSpaceship)); - androidSpaceship.bloc.onBonusAwarded(); - }); + Future onLoad() async { + await super.onLoad(); + await add( + FlameBlocListener( + listenWhen: (_, state) => state == AndroidSpaceshipState.withBonus, + onNewState: (state) { + readBloc().add( + const BonusActivated(GameBonus.androidSpaceship), + ); + readBloc() + .onBonusAwarded(); + }, + ), + ); } } diff --git a/lib/game/components/backbox/backbox.dart b/lib/game/components/backbox/backbox.dart index b3743df3..e455e89f 100644 --- a/lib/game/components/backbox/backbox.dart +++ b/lib/game/components/backbox/backbox.dart @@ -5,27 +5,37 @@ import 'package:flutter/material.dart'; import 'package:leaderboard_repository/leaderboard_repository.dart'; import 'package:pinball/game/components/backbox/bloc/backbox_bloc.dart'; import 'package:pinball/game/components/backbox/displays/displays.dart'; +import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; import 'package:pinball_theme/pinball_theme.dart' hide Assets; +import 'package:platform_helper/platform_helper.dart'; /// {@template backbox} /// The [Backbox] of the pinball machine. /// {@endtemplate} -class Backbox extends PositionComponent with ZIndex { +class Backbox extends PositionComponent with ZIndex, HasGameRef { /// {@macro backbox} Backbox({ required LeaderboardRepository leaderboardRepository, - }) : _bloc = BackboxBloc(leaderboardRepository: leaderboardRepository); + required List? entries, + }) : _bloc = BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: entries, + ), + _platformHelper = PlatformHelper(); /// {@macro backbox} @visibleForTesting Backbox.test({ required BackboxBloc bloc, - }) : _bloc = bloc; + required PlatformHelper platformHelper, + }) : _bloc = bloc, + _platformHelper = platformHelper; late final Component _display; final BackboxBloc _bloc; + final PlatformHelper _platformHelper; late StreamSubscription _subscription; @override @@ -34,8 +44,6 @@ class Backbox extends PositionComponent with ZIndex { anchor = Anchor.bottomCenter; zIndex = ZIndexes.backbox; - _bloc.add(LeaderboardRequested()); - await add(_BackboxSpriteComponent()); await add(_display = Component()); _build(_bloc.state); @@ -57,7 +65,12 @@ class Backbox extends PositionComponent with ZIndex { _display.add(LoadingDisplay()); } else if (state is LeaderboardSuccessState) { _display.add(LeaderboardDisplay(entries: state.entries)); + } else if (state is LeaderboardFailureState) { + _display.add(LeaderboardFailureDisplay()); } else if (state is InitialsFormState) { + if (_platformHelper.isMobile) { + gameRef.overlays.add(PinballGame.mobileControlsOverlay); + } _display.add( InitialsInputDisplay( score: state.score, @@ -74,9 +87,26 @@ class Backbox extends PositionComponent with ZIndex { ), ); } else if (state is InitialsSuccessState) { - _display.add(InitialsSubmissionSuccessDisplay()); + _display.add( + GameOverInfoDisplay( + onShare: () { + _bloc.add(ShareScoreRequested(score: state.score)); + }, + ), + ); } else if (state is InitialsFailureState) { - _display.add(InitialsSubmissionFailureDisplay()); + _display.add( + InitialsSubmissionFailureDisplay( + onDismissed: () { + _bloc.add( + PlayerInitialsRequested( + score: state.score, + character: state.character, + ), + ); + }, + ), + ); } } diff --git a/lib/game/components/backbox/bloc/backbox_bloc.dart b/lib/game/components/backbox/bloc/backbox_bloc.dart index b3952a0c..8a89b1bd 100644 --- a/lib/game/components/backbox/bloc/backbox_bloc.dart +++ b/lib/game/components/backbox/bloc/backbox_bloc.dart @@ -14,10 +14,16 @@ class BackboxBloc extends Bloc { /// {@macro backbox_bloc} BackboxBloc({ required LeaderboardRepository leaderboardRepository, + required List? initialEntries, }) : _leaderboardRepository = leaderboardRepository, - super(LoadingState()) { + super( + initialEntries != null + ? LeaderboardSuccessState(entries: initialEntries) + : LeaderboardFailureState(), + ) { on(_onPlayerInitialsRequested); on(_onPlayerInitialsSubmitted); + on(_onScoreShareRequested); on(_onLeaderboardRequested); } @@ -48,13 +54,33 @@ class BackboxBloc extends Bloc { character: event.character.toType, ), ); - emit(InitialsSuccessState()); + emit( + InitialsSuccessState( + score: event.score, + ), + ); } catch (error, stackTrace) { addError(error, stackTrace); - emit(InitialsFailureState()); + emit( + InitialsFailureState( + score: event.score, + character: event.character, + ), + ); } } + Future _onScoreShareRequested( + ShareScoreRequested event, + Emitter emit, + ) async { + emit( + ShareState( + score: event.score, + ), + ); + } + Future _onLeaderboardRequested( LeaderboardRequested event, Emitter emit, diff --git a/lib/game/components/backbox/bloc/backbox_event.dart b/lib/game/components/backbox/bloc/backbox_event.dart index 40ad4bfb..a842d191 100644 --- a/lib/game/components/backbox/bloc/backbox_event.dart +++ b/lib/game/components/backbox/bloc/backbox_event.dart @@ -52,6 +52,22 @@ class PlayerInitialsSubmitted extends BackboxEvent { List get props => [score, initials, character]; } +/// {@template share_score_requested} +/// Event when user requests to share their score. +/// {@endtemplate} +class ShareScoreRequested extends BackboxEvent { + /// {@macro share_score_requested} + const ShareScoreRequested({ + required this.score, + }); + + /// Player's score. + final int score; + + @override + List get props => [score]; +} + /// Event that triggers the fetching of the leaderboard class LeaderboardRequested extends BackboxEvent { @override diff --git a/lib/game/components/backbox/bloc/backbox_state.dart b/lib/game/components/backbox/bloc/backbox_state.dart index 482bb298..d1025a09 100644 --- a/lib/game/components/backbox/bloc/backbox_state.dart +++ b/lib/game/components/backbox/bloc/backbox_state.dart @@ -54,14 +54,51 @@ class InitialsFormState extends BackboxState { List get props => [score, character]; } -/// State when the leaderboard was successfully loaded. +/// {@template initials_success_state} +/// State when the score and initials were successfully submitted. +/// {@endtemplate} class InitialsSuccessState extends BackboxState { + /// {@macro initials_success_state} + const InitialsSuccessState({ + required this.score, + }) : super(); + + /// Player's score. + final int score; + @override - List get props => []; + List get props => [score]; } /// State when the initials submission failed. class InitialsFailureState extends BackboxState { + const InitialsFailureState({ + required this.score, + required this.character, + }); + + /// Player's score. + final int score; + + /// Player's character. + final CharacterTheme character; + @override - List get props => []; + List get props => [score, character]; +} + +/// {@template share_state} +/// State when the user is sharing their score. +/// {@endtemplate} +class ShareState extends BackboxState { + /// {@macro share_state} + const ShareState({ + required this.score, + }) : super(); + + /// Player's score. + final int score; + + @override + List get props => [score]; } diff --git a/lib/game/components/backbox/displays/displays.dart b/lib/game/components/backbox/displays/displays.dart index 4dda7048..2b8a38ae 100644 --- a/lib/game/components/backbox/displays/displays.dart +++ b/lib/game/components/backbox/displays/displays.dart @@ -1,5 +1,7 @@ +export 'game_over_info_display.dart'; export 'initials_input_display.dart'; export 'initials_submission_failure_display.dart'; export 'initials_submission_success_display.dart'; export 'leaderboard_display.dart'; +export 'leaderboard_failure_display.dart'; export 'loading_display.dart'; diff --git a/lib/game/components/backbox/displays/game_over_info_display.dart b/lib/game/components/backbox/displays/game_over_info_display.dart new file mode 100644 index 00000000..c7708bde --- /dev/null +++ b/lib/game/components/backbox/displays/game_over_info_display.dart @@ -0,0 +1,311 @@ +import 'dart:async'; + +import 'package:flame/components.dart'; +import 'package:flame/input.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; +import 'package:pinball_ui/pinball_ui.dart'; +import 'package:share_repository/share_repository.dart'; + +/// Signature for the callback called when the user tries to share their score +/// from the [GameOverInfoDisplay]. +typedef OnShareTap = void Function(); + +final _titleTextPaint = TextPaint( + style: const TextStyle( + fontSize: 1.6, + color: PinballColors.white, + fontFamily: PinballFonts.pixeloidSans, + ), +); + +final _titleBoldTextPaint = TextPaint( + style: const TextStyle( + fontSize: 1.4, + color: PinballColors.white, + fontFamily: PinballFonts.pixeloidSans, + fontWeight: FontWeight.bold, + ), +); + +final _linkTextPaint = TextPaint( + style: const TextStyle( + fontSize: 1.7, + color: PinballColors.orange, + fontFamily: PinballFonts.pixeloidSans, + fontWeight: FontWeight.bold, + ), +); + +final _descriptionTextPaint = TextPaint( + style: const TextStyle( + fontSize: 1.6, + color: PinballColors.white, + fontFamily: PinballFonts.pixeloidSans, + ), +); + +/// {@template game_over_info_display} +/// Display with links to share your score or go to the IO webpage. +/// {@endtemplate} +class GameOverInfoDisplay extends Component with HasGameRef { + /// {@macro game_over_info_display} + GameOverInfoDisplay({ + OnShareTap? onShare, + }) : super( + children: [ + _InstructionsComponent( + onShare: onShare, + ), + ], + ); + + @override + Future onLoad() async { + await super.onLoad(); + gameRef.overlays.add(PinballGame.playButtonOverlay); + } +} + +class _InstructionsComponent extends PositionComponent with HasGameRef { + _InstructionsComponent({ + OnShareTap? onShare, + }) : super( + anchor: Anchor.center, + position: Vector2(0, -25), + children: [ + _TitleComponent(), + _LinksComponent( + onShare: onShare, + ), + _DescriptionComponent(), + ], + ); +} + +class _TitleComponent extends PositionComponent with HasGameRef { + _TitleComponent() + : super( + anchor: Anchor.center, + position: Vector2(0, 3), + children: [ + _TitleBackgroundSpriteComponent(), + _ShareScoreTextComponent(), + _ChallengeFriendsTextComponent(), + ], + ); +} + +class _ShareScoreTextComponent extends TextComponent with HasGameRef { + _ShareScoreTextComponent() + : super( + anchor: Anchor.center, + position: Vector2(0, -1.5), + textRenderer: _titleTextPaint, + ); + + @override + Future onLoad() async { + await super.onLoad(); + text = readProvider().shareYourScore; + } +} + +class _ChallengeFriendsTextComponent extends TextComponent with HasGameRef { + _ChallengeFriendsTextComponent() + : super( + anchor: Anchor.center, + position: Vector2(0, 1.5), + textRenderer: _titleBoldTextPaint, + ); + + @override + Future onLoad() async { + await super.onLoad(); + text = readProvider().andChallengeYourFriends; + } +} + +class _TitleBackgroundSpriteComponent extends SpriteComponent with HasGameRef { + _TitleBackgroundSpriteComponent() + : super( + anchor: Anchor.center, + position: Vector2.zero(), + ); + + @override + Future onLoad() async { + await super.onLoad(); + final sprite = Sprite( + gameRef.images + .fromCache(Assets.images.backbox.displayTitleDecoration.keyName), + ); + this.sprite = sprite; + size = sprite.originalSize / 22; + } +} + +class _LinksComponent extends PositionComponent with HasGameRef { + _LinksComponent({ + OnShareTap? onShare, + }) : super( + anchor: Anchor.center, + position: Vector2(0, 9.2), + children: [ + ShareLinkComponent(onTap: onShare), + GoogleIOLinkComponent(), + ], + ); +} + +/// {@template share_link_component} +/// Link button to navigate to sharing score display. +/// {@endtemplate} +class ShareLinkComponent extends TextComponent with HasGameRef, Tappable { + /// {@macro share_link_component} + ShareLinkComponent({ + OnShareTap? onTap, + }) : _onTap = onTap, + super( + anchor: Anchor.center, + position: Vector2(-7, 0), + textRenderer: _linkTextPaint, + ); + + final OnShareTap? _onTap; + + @override + bool onTapDown(TapDownInfo info) { + _onTap?.call(); + return true; + } + + @override + Future onLoad() async { + await super.onLoad(); + await add( + RectangleComponent( + size: Vector2(6.4, 0.2), + paint: Paint()..color = PinballColors.orange, + anchor: Anchor.center, + position: Vector2(3.2, 2.3), + ), + ); + + text = readProvider().share; + } +} + +/// {@template google_io_link_component} +/// Link button to navigate to Google I/O site. +/// {@endtemplate} +class GoogleIOLinkComponent extends TextComponent with HasGameRef, Tappable { + /// {@macro google_io_link_component} + GoogleIOLinkComponent() + : super( + anchor: Anchor.center, + position: Vector2(6, 0), + textRenderer: _linkTextPaint, + ); + + @override + bool onTapDown(TapDownInfo info) { + openLink(ShareRepository.googleIOEvent); + return true; + } + + @override + Future onLoad() async { + await super.onLoad(); + await add( + RectangleComponent( + size: Vector2(10.2, 0.2), + paint: Paint()..color = PinballColors.orange, + anchor: Anchor.center, + position: Vector2(5.1, 2.3), + ), + ); + + text = readProvider().gotoIO; + } +} + +class _DescriptionComponent extends PositionComponent with HasGameRef { + _DescriptionComponent() + : super( + anchor: Anchor.center, + position: Vector2(0, 13), + children: [ + _LearnMoreTextComponent(), + _FirebaseTextComponent(), + OpenSourceTextComponent(), + ], + ); +} + +class _LearnMoreTextComponent extends TextComponent with HasGameRef { + _LearnMoreTextComponent() + : super( + anchor: Anchor.center, + position: Vector2.zero(), + textRenderer: _descriptionTextPaint, + ); + + @override + Future onLoad() async { + await super.onLoad(); + text = readProvider().learnMore; + } +} + +class _FirebaseTextComponent extends TextComponent with HasGameRef { + _FirebaseTextComponent() + : super( + anchor: Anchor.center, + position: Vector2(-8.5, 2.5), + textRenderer: _descriptionTextPaint, + ); + + @override + Future onLoad() async { + await super.onLoad(); + text = readProvider().firebaseOr; + } +} + +/// {@template open_source_link_component} +/// Link text to navigate to Open Source site. +/// {@endtemplate} +@visibleForTesting +class OpenSourceTextComponent extends TextComponent with HasGameRef, Tappable { + /// {@macro open_source_link_component} + OpenSourceTextComponent() + : super( + anchor: Anchor.center, + position: Vector2(13.5, 2.5), + textRenderer: _descriptionTextPaint, + ); + + @override + bool onTapDown(TapDownInfo info) { + openLink(ShareRepository.openSourceCode); + return true; + } + + @override + Future onLoad() async { + await super.onLoad(); + await add( + RectangleComponent( + size: Vector2(16, 0.2), + paint: Paint()..color = PinballColors.white, + anchor: Anchor.center, + position: Vector2(8, 2.3), + ), + ); + text = readProvider().openSourceCode; + } +} diff --git a/lib/game/components/backbox/displays/initials_input_display.dart b/lib/game/components/backbox/displays/initials_input_display.dart index 68c58f43..54780c2d 100644 --- a/lib/game/components/backbox/displays/initials_input_display.dart +++ b/lib/game/components/backbox/displays/initials_input_display.dart @@ -77,7 +77,7 @@ class InitialsInputDisplay extends Component with HasGameRef { ); } - /// Returns the current inputed initials + /// Returns the current entered initials String get initials => children .whereType() .map((prompt) => prompt.char) diff --git a/lib/game/components/backbox/displays/initials_submission_failure_display.dart b/lib/game/components/backbox/displays/initials_submission_failure_display.dart index 4cc5a9f5..a9bd84c5 100644 --- a/lib/game/components/backbox/displays/initials_submission_failure_display.dart +++ b/lib/game/components/backbox/displays/initials_submission_failure_display.dart @@ -1,27 +1,47 @@ import 'package:flame/components.dart'; import 'package:flutter/material.dart'; import 'package:pinball/game/game.dart'; +import 'package:pinball/l10n/l10n.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; import 'package:pinball_ui/pinball_ui.dart'; final _bodyTextPaint = TextPaint( style: const TextStyle( - fontSize: 3, + fontSize: 1.8, color: PinballColors.white, fontFamily: PinballFonts.pixeloidSans, + fontWeight: FontWeight.w400, ), ); /// {@template initials_submission_failure_display} /// [Backbox] display for when a failure occurs during initials submission. /// {@endtemplate} -class InitialsSubmissionFailureDisplay extends TextComponent { +class InitialsSubmissionFailureDisplay extends Component { + /// {@macro initials_submission_failure_display} + InitialsSubmissionFailureDisplay({ + required this.onDismissed, + }); + + final VoidCallback onDismissed; + @override Future onLoad() async { - await super.onLoad(); - position = Vector2(0, -10); - anchor = Anchor.center; - text = 'Failure!'; - textRenderer = _bodyTextPaint; + final l10n = readProvider(); + + await addAll([ + ErrorComponent.bold( + label: l10n.initialsErrorTitle, + position: Vector2(0, -20), + ), + TextComponent( + text: l10n.initialsErrorMessage, + anchor: Anchor.center, + position: Vector2(0, -12), + textRenderer: _bodyTextPaint, + ), + TimerComponent(period: 4, onTick: onDismissed), + ]); } } diff --git a/lib/game/components/backbox/displays/leaderboard_failure_display.dart b/lib/game/components/backbox/displays/leaderboard_failure_display.dart new file mode 100644 index 00000000..a519f9e2 --- /dev/null +++ b/lib/game/components/backbox/displays/leaderboard_failure_display.dart @@ -0,0 +1,23 @@ +import 'package:flame/components.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// {@template leaderboard_failure_display} +/// Display showing an error message when the leaderboard couldn't be loaded +/// {@endtemplate} +class LeaderboardFailureDisplay extends Component { + /// {@macro leaderboard_failure_display} + LeaderboardFailureDisplay(); + + @override + Future onLoad() async { + final l10n = readProvider(); + await add( + ErrorComponent( + label: l10n.leaderboardErrorMessage, + position: Vector2(0, -18), + ), + ); + } +} diff --git a/lib/game/components/controlled_plunger.dart b/lib/game/components/controlled_plunger.dart index c8cb90fb..f709de66 100644 --- a/lib/game/components/controlled_plunger.dart +++ b/lib/game/components/controlled_plunger.dart @@ -30,7 +30,7 @@ class PlungerNoiseBehavior extends Component { @override Future onLoad() async { await super.onLoad(); - readProvider().play(PinballAudio.launcher); + readProvider().play(PinballAudio.launcher); } @override 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 index bf1b52c4..3c4ef02a 100644 --- a/lib/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior.dart +++ b/lib/game/components/flutter_forest/behaviors/flutter_forest_bonus_behavior.dart @@ -7,9 +7,9 @@ import 'package:pinball_flame/pinball_flame.dart'; /// Bonus obtained at the [FlutterForest]. /// -/// When all [DashNestBumper]s are hit at least once three times, the [Signpost] +/// When all [DashBumper]s are hit at least once three times, the [Signpost] /// progresses. When the [Signpost] fully progresses, the [GameBonus.dashNest] -/// is awarded, and the [DashNestBumper.main] releases a new [Ball]. +/// is awarded, and the [DashBumper.main] releases a new [Ball]. class FlutterForestBonusBehavior extends Component with ParentIsA, @@ -19,14 +19,14 @@ class FlutterForestBonusBehavior extends Component void onMount() { super.onMount(); - final bumpers = parent.children.whereType(); + final bumpers = parent.children.whereType(); final signpost = parent.firstChild()!; final animatronic = parent.firstChild()!; for (final bumper in bumpers) { bumper.bloc.stream.listen((state) { final activatedAllBumpers = bumpers.every( - (bumper) => bumper.bloc.state == DashNestBumperState.active, + (bumper) => bumper.bloc.state == DashBumperState.active, ); if (activatedAllBumpers) { diff --git a/lib/game/components/flutter_forest/flutter_forest.dart b/lib/game/components/flutter_forest/flutter_forest.dart index 1cc055ae..39783bb1 100644 --- a/lib/game/components/flutter_forest/flutter_forest.dart +++ b/lib/game/components/flutter_forest/flutter_forest.dart @@ -9,7 +9,7 @@ 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. +/// off [DashBumper]s. /// {@endtemplate} class FlutterForest extends Component with ZIndex { /// {@macro flutter_forest} @@ -22,19 +22,19 @@ class FlutterForest extends Component with ZIndex { BumperNoiseBehavior(), ], )..initialPosition = Vector2(7.95, -58.35), - DashNestBumper.main( + DashBumper.main( children: [ ScoringContactBehavior(points: Points.twoHundredThousand), BumperNoiseBehavior(), ], )..initialPosition = Vector2(18.55, -59.35), - DashNestBumper.a( + DashBumper.a( children: [ ScoringContactBehavior(points: Points.twentyThousand), BumperNoiseBehavior(), ], )..initialPosition = Vector2(8.95, -51.95), - DashNestBumper.b( + DashBumper.b( children: [ ScoringContactBehavior(points: Points.twentyThousand), BumperNoiseBehavior(), diff --git a/lib/game/components/game_bloc_status_listener.dart b/lib/game/components/game_bloc_status_listener.dart index 84627eb0..1a5a06df 100644 --- a/lib/game/components/game_bloc_status_listener.dart +++ b/lib/game/components/game_bloc_status_listener.dart @@ -20,7 +20,7 @@ class GameBlocStatusListener extends Component case GameStatus.waiting: break; case GameStatus.playing: - readProvider().play(PinballAudio.backgroundMusic); + readProvider().play(PinballAudio.backgroundMusic); gameRef .descendants() .whereType() @@ -29,7 +29,7 @@ class GameBlocStatusListener extends Component gameRef.overlays.remove(PinballGame.playButtonOverlay); break; case GameStatus.gameOver: - readProvider().play(PinballAudio.gameOverVoiceOver); + readProvider().play(PinballAudio.gameOverVoiceOver); gameRef.descendants().whereType().first.requestInitials( score: state.displayScore, character: readBloc() @@ -45,8 +45,11 @@ class GameBlocStatusListener extends Component } } - void _addFlipperKeyControls(Flipper flipper) => - flipper.add(FlipperKeyControllingBehavior()); + void _addFlipperKeyControls(Flipper flipper) { + flipper + ..add(FlipperKeyControllingBehavior()) + ..moveDown(); + } void _removeFlipperKeyControls(Flipper flipper) => flipper .descendants() diff --git a/lib/game/game_assets.dart b/lib/game/game_assets.dart index 6befce67..0f5c6626 100644 --- a/lib/game/game_assets.dart +++ b/lib/game/game_assets.dart @@ -1,3 +1,4 @@ +import 'package:flame/extensions.dart'; import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart' as components; import 'package:pinball_theme/pinball_theme.dart' hide Assets; @@ -5,7 +6,7 @@ import 'package:pinball_theme/pinball_theme.dart' hide Assets; /// Add methods to help loading and caching game assets. extension PinballGameAssetsX on PinballGame { /// Returns a list of assets to be loaded - List preLoadAssets() { + List> preLoadAssets() { const dashTheme = DashTheme(); const sparkyTheme = SparkyTheme(); const androidTheme = AndroidTheme(); @@ -100,6 +101,9 @@ extension PinballGameAssetsX on PinballGame { images.load(components.Assets.images.sparky.bumper.c.dimmed.keyName), images.load(components.Assets.images.backbox.marquee.keyName), images.load(components.Assets.images.backbox.displayDivider.keyName), + images.load( + components.Assets.images.backbox.displayTitleDecoration.keyName, + ), images.load(components.Assets.images.googleWord.letter1.lit.keyName), images.load(components.Assets.images.googleWord.letter1.dimmed.keyName), images.load(components.Assets.images.googleWord.letter2.lit.keyName), diff --git a/lib/game/pinball_game.dart b/lib/game/pinball_game.dart index f9747f1e..2a85c2e2 100644 --- a/lib/game/pinball_game.dart +++ b/lib/game/pinball_game.dart @@ -16,16 +16,16 @@ import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; class PinballGame extends PinballForge2DGame - with HasKeyboardHandlerComponents, MultiTouchTapDetector { + with HasKeyboardHandlerComponents, MultiTouchTapDetector, HasTappables { PinballGame({ required CharacterThemeCubit characterThemeBloc, required this.leaderboardRepository, required GameBloc gameBloc, required AppLocalizations l10n, - required PinballPlayer player, + required PinballAudioPlayer audioPlayer, }) : focusNode = FocusNode(), _gameBloc = gameBloc, - _player = player, + _audioPlayer = audioPlayer, _characterThemeBloc = characterThemeBloc, _l10n = l10n, super( @@ -37,6 +37,9 @@ class PinballGame extends PinballForge2DGame /// Identifier of the play button overlay static const playButtonOverlay = 'play_button'; + /// Identifier of the mobile controls overlay + static const mobileControlsOverlay = 'mobile_controls'; + @override Color backgroundColor() => Colors.transparent; @@ -44,7 +47,7 @@ class PinballGame extends PinballForge2DGame final CharacterThemeCubit _characterThemeBloc; - final PinballPlayer _player; + final PinballAudioPlayer _audioPlayer; final LeaderboardRepository leaderboardRepository; @@ -52,6 +55,18 @@ class PinballGame extends PinballForge2DGame final GameBloc _gameBloc; + List? _entries; + + Future preFetchLeaderboard() async { + try { + _entries = await leaderboardRepository.fetchTop10Leaderboard(); + } catch (_) { + // An initial null leaderboard means that we couldn't fetch + // the entries for the [Backbox] and it will show the relevant display. + _entries = null; + } + } + @override Future onLoad() async { await add( @@ -67,7 +82,7 @@ class PinballGame extends PinballForge2DGame children: [ MultiFlameProvider( providers: [ - FlameProvider.value(_player), + FlameProvider.value(_audioPlayer), FlameProvider.value(leaderboardRepository), FlameProvider.value(_l10n), ], @@ -88,7 +103,10 @@ class PinballGame extends PinballForge2DGame children: [ BoardBackgroundSpriteComponent(), Boundaries(), - Backbox(leaderboardRepository: leaderboardRepository), + Backbox( + leaderboardRepository: leaderboardRepository, + entries: _entries, + ), GoogleGallery(), Multipliers(), Multiballs(), @@ -125,7 +143,7 @@ class PinballGame extends PinballForge2DGame final rocket = descendants().whereType().first; final bounds = rocket.topLeftPosition & rocket.size; - // NOTE(wolfen): As long as Flame does not have https://github.com/flame-engine/flame/issues/1586 we need to check it at the highest level manually. + // NOTE: As long as Flame does not have https://github.com/flame-engine/flame/issues/1586 we need to check it at the highest level manually. if (bounds.contains(info.eventPosition.game.toOffset())) { descendants().whereType().single.pullFor(2); } else { @@ -170,11 +188,11 @@ class DebugPinballGame extends PinballGame with FPSCounter, PanDetector { required CharacterThemeCubit characterThemeBloc, required LeaderboardRepository leaderboardRepository, required AppLocalizations l10n, - required PinballPlayer player, + required PinballAudioPlayer audioPlayer, required GameBloc gameBloc, }) : super( characterThemeBloc: characterThemeBloc, - player: player, + audioPlayer: audioPlayer, leaderboardRepository: leaderboardRepository, l10n: l10n, gameBloc: gameBloc, diff --git a/lib/game/view/pinball_game_page.dart b/lib/game/view/pinball_game_page.dart index c67b2d10..5c21f257 100644 --- a/lib/game/view/pinball_game_page.dart +++ b/lib/game/view/pinball_game_page.dart @@ -21,79 +21,61 @@ class PinballGamePage extends StatelessWidget { final bool isDebugMode; - static Route route({bool isDebugMode = kDebugMode}) { - return MaterialPageRoute( - builder: (_) => PinballGamePage(isDebugMode: isDebugMode), - ); - } - @override Widget build(BuildContext context) { final characterThemeBloc = context.read(); - final player = context.read(); + final audioPlayer = context.read(); final leaderboardRepository = context.read(); final gameBloc = context.read(); final game = isDebugMode ? DebugPinballGame( characterThemeBloc: characterThemeBloc, - player: player, + audioPlayer: audioPlayer, leaderboardRepository: leaderboardRepository, l10n: context.l10n, gameBloc: gameBloc, ) : PinballGame( characterThemeBloc: characterThemeBloc, - player: player, + audioPlayer: audioPlayer, leaderboardRepository: leaderboardRepository, l10n: context.l10n, gameBloc: gameBloc, ); - final loadables = [ - ...game.preLoadAssets(), - ...player.load(), - ...BonusAnimation.loadAssets(), - ...SelectedCharacter.loadAssets(), - ]; - - return BlocProvider( - create: (_) => AssetsManagerCubit(loadables)..load(), - child: PinballGameView(game: game), + return Container( + decoration: const CrtBackground(), + child: Scaffold( + backgroundColor: PinballColors.transparent, + body: BlocProvider( + create: (_) => AssetsManagerCubit(game, audioPlayer)..load(), + child: PinballGameView(game), + ), + ), ); } } class PinballGameView extends StatelessWidget { - const PinballGameView({ - Key? key, - required this.game, - }) : super(key: key); + const PinballGameView(this.game, {Key? key}) : super(key: key); final PinballGame game; @override Widget build(BuildContext context) { - final isLoading = context.select( - (AssetsManagerCubit bloc) => bloc.state.progress != 1, - ); - return Container( - decoration: const CrtBackground(), - child: Scaffold( - backgroundColor: PinballColors.transparent, - body: isLoading + return BlocBuilder( + builder: (context, state) { + return state.isLoading ? const AssetsLoadingPage() - : PinballGameLoadedView(game: game), - ), + : PinballGameLoadedView(game); + }, ); } } @visibleForTesting class PinballGameLoadedView extends StatelessWidget { - const PinballGameLoadedView({ - Key? key, - required this.game, - }) : super(key: key); + const PinballGameLoadedView(this.game, {Key? key}) : super(key: key); final PinballGame game; @@ -122,6 +104,14 @@ class PinballGameLoadedView extends StatelessWidget { child: PlayButtonOverlay(), ); }, + PinballGame.mobileControlsOverlay: (context, game) { + return Positioned( + bottom: 0, + left: 0, + right: 0, + child: MobileControls(game: game), + ); + }, }, ), ), diff --git a/lib/game/view/widgets/mobile_controls.dart b/lib/game/view/widgets/mobile_controls.dart new file mode 100644 index 00000000..c5761eb6 --- /dev/null +++ b/lib/game/view/widgets/mobile_controls.dart @@ -0,0 +1,46 @@ +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball_flame/pinball_flame.dart'; +import 'package:pinball_ui/pinball_ui.dart'; + +/// {@template mobile_controls} +/// Widget with the controls used to enable the user initials input on mobile. +/// {@endtemplate} +class MobileControls extends StatelessWidget { + /// {@macro mobile_controls} + const MobileControls({ + Key? key, + required this.game, + }) : super(key: key); + + /// Game instance + final PinballGame game; + + @override + Widget build(BuildContext context) { + final l10n = AppLocalizations.of(context); + return Row( + mainAxisAlignment: MainAxisAlignment.spaceEvenly, + children: [ + MobileDpad( + onTapUp: () => game.triggerVirtualKeyUp(LogicalKeyboardKey.arrowUp), + onTapDown: () => game.triggerVirtualKeyUp( + LogicalKeyboardKey.arrowDown, + ), + onTapLeft: () => game.triggerVirtualKeyUp( + LogicalKeyboardKey.arrowLeft, + ), + onTapRight: () => game.triggerVirtualKeyUp( + LogicalKeyboardKey.arrowRight, + ), + ), + PinballButton( + text: l10n.enter, + onTap: () => game.triggerVirtualKeyUp(LogicalKeyboardKey.enter), + ), + ], + ); + } +} diff --git a/lib/game/view/widgets/mobile_dpad.dart b/lib/game/view/widgets/mobile_dpad.dart new file mode 100644 index 00000000..abad496b --- /dev/null +++ b/lib/game/view/widgets/mobile_dpad.dart @@ -0,0 +1,75 @@ +import 'package:flutter/material.dart'; +import 'package:pinball_ui/pinball_ui.dart'; + +/// {@template mobile_dpad} +/// Widget rendering 4 directional input arrows. +/// {@endtemplate} +class MobileDpad extends StatelessWidget { + /// {@template mobile_dpad} + const MobileDpad({ + Key? key, + required this.onTapUp, + required this.onTapDown, + required this.onTapLeft, + required this.onTapRight, + }) : super(key: key); + + static const _size = 180.0; + + /// Called when dpad up is pressed + final VoidCallback onTapUp; + + /// Called when dpad down is pressed + final VoidCallback onTapDown; + + /// Called when dpad left is pressed + final VoidCallback onTapLeft; + + /// Called when dpad right is pressed + final VoidCallback onTapRight; + + @override + Widget build(BuildContext context) { + return SizedBox( + width: _size, + height: _size, + child: Column( + children: [ + Row( + children: [ + const Spacer(), + PinballDpadButton( + direction: PinballDpadDirection.up, + onTap: onTapUp, + ), + const Spacer(), + ], + ), + Row( + children: [ + PinballDpadButton( + direction: PinballDpadDirection.left, + onTap: onTapLeft, + ), + const Spacer(), + PinballDpadButton( + direction: PinballDpadDirection.right, + onTap: onTapRight, + ), + ], + ), + Row( + children: [ + const Spacer(), + PinballDpadButton( + direction: PinballDpadDirection.down, + onTap: onTapDown, + ), + const Spacer(), + ], + ), + ], + ), + ); + } +} diff --git a/lib/game/view/widgets/replay_button_overlay.dart b/lib/game/view/widgets/replay_button_overlay.dart new file mode 100644 index 00000000..c0b2a67d --- /dev/null +++ b/lib/game/view/widgets/replay_button_overlay.dart @@ -0,0 +1,25 @@ +import 'package:flutter/material.dart'; +import 'package:flutter_bloc/flutter_bloc.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball/start_game/start_game.dart'; +import 'package:pinball_ui/pinball_ui.dart'; + +/// {@template replay_button_overlay} +/// [Widget] that renders the button responsible for restarting the game. +/// {@endtemplate} +class ReplayButtonOverlay extends StatelessWidget { + /// {@macro replay_button_overlay} + const ReplayButtonOverlay({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { + final l10n = context.l10n; + + return PinballButton( + text: l10n.replay, + onTap: () { + context.read().add(const ReplayTapped()); + }, + ); + } +} diff --git a/lib/game/view/widgets/widgets.dart b/lib/game/view/widgets/widgets.dart index 5d1fccf8..0093cad2 100644 --- a/lib/game/view/widgets/widgets.dart +++ b/lib/game/view/widgets/widgets.dart @@ -1,5 +1,8 @@ export 'bonus_animation.dart'; export 'game_hud.dart'; +export 'mobile_controls.dart'; +export 'mobile_dpad.dart'; export 'play_button_overlay.dart'; +export 'replay_button_overlay.dart'; export 'round_count_display.dart'; export 'score_view.dart'; diff --git a/lib/gen/assets.gen.dart b/lib/gen/assets.gen.dart index 33d2bbd1..f0b6fdeb 100644 --- a/lib/gen/assets.gen.dart +++ b/lib/gen/assets.gen.dart @@ -15,6 +15,8 @@ class $AssetsImagesGen { $AssetsImagesComponentsGen get components => const $AssetsImagesComponentsGen(); $AssetsImagesLinkBoxGen get linkBox => const $AssetsImagesLinkBoxGen(); + $AssetsImagesLoadingGameGen get loadingGame => + const $AssetsImagesLoadingGameGen(); $AssetsImagesScoreGen get score => const $AssetsImagesScoreGen(); } @@ -62,6 +64,14 @@ class $AssetsImagesLinkBoxGen { const AssetGenImage('assets/images/link_box/info_icon.png'); } +class $AssetsImagesLoadingGameGen { + const $AssetsImagesLoadingGameGen(); + + /// File path: assets/images/loading_game/io_pinball.png + AssetGenImage get ioPinball => + const AssetGenImage('assets/images/loading_game/io_pinball.png'); +} + class $AssetsImagesScoreGen { const $AssetsImagesScoreGen(); diff --git a/lib/how_to_play/widgets/how_to_play_dialog.dart b/lib/how_to_play/widgets/how_to_play_dialog.dart index 0113319e..8a709605 100644 --- a/lib/how_to_play/widgets/how_to_play_dialog.dart +++ b/lib/how_to_play/widgets/how_to_play_dialog.dart @@ -91,7 +91,9 @@ class _HowToPlayDialogState extends State { return WillPopScope( onWillPop: () { widget.onDismissCallback.call(); - context.read().play(PinballAudio.ioPinballVoiceOver); + context + .read() + .play(PinballAudio.ioPinballVoiceOver); return Future.value(true); }, child: PinballDialog( @@ -240,7 +242,7 @@ class _DesktopFlipperControls extends StatelessWidget { children: [ Text( l10n.flipperControls, - style: Theme.of(context).textTheme.subtitle2, + style: Theme.of(context).textTheme.headline4, ), const SizedBox(height: 10), Column( diff --git a/lib/l10n/arb/app_en.arb b/lib/l10n/arb/app_en.arb index aa1a24f6..8573c585 100644 --- a/lib/l10n/arb/app_en.arb +++ b/lib/l10n/arb/app_en.arb @@ -148,8 +148,56 @@ "@loading": { "description": "Text shown to indicate loading times" }, + "replay": "Replay", + "@replay": { + "description": "Text displayed on the share page for replay button" + }, "ioPinball": "I/O Pinball", "@ioPinball": { "description": "I/O Pinball - Name of the game" + }, + "shareYourScore": "Share your score", + "@shareYourScore": { + "description": "Text shown on title of info screen" + }, + "andChallengeYourFriends": "AND CHALLENGE YOUR FRIENDS", + "@challengeYourFriends": { + "description": "Text shown on title of info screen" + }, + "share": "SHARE", + "@share": { + "description": "Text for share link on info screen." + }, + "gotoIO": "GO TO I/O", + "@gotoIO": { + "description": "Text for going to I/O site link on info screen." + }, + "learnMore": "Learn more about building games in Flutter with", + "@learnMore": { + "description": "Text shown on description of info screen" + }, + "firebaseOr": "Firebase or dive right into the", + "@firebaseOr": { + "description": "Text shown on description of info screen" + }, + "openSourceCode": "open source code.", + "@openSourceCode": { + "description": "Text shown on description of info screen" + }, + "enter": "Enter", + "@enter": { + "description": "Text shown on the mobile controls enter button" + }, + "initialsErrorTitle": "Uh-oh... well, that didnโ€™t work", + "@enter": { + "description": "Title shown when the initials submission fails" + }, + "initialsErrorMessage": "Please try a different combination of letters", + "@initialsErrorMessage": { + "description": "Message on shown when the initials submission fails" + }, + "leaderboardErrorMessage": "No connection. Leaderboard and sharing functionality is unavailable.", + "@leaderboardErrorMessage": { + "description": "Text shown when the leaderboard had an error while loading" } } diff --git a/lib/main_production.dart b/lib/main.dart similarity index 89% rename from lib/main_production.dart rename to lib/main.dart index 67d83b81..158966c8 100644 --- a/lib/main_production.dart +++ b/lib/main.dart @@ -11,7 +11,7 @@ void main() { bootstrap((firestore, firebaseAuth) async { final leaderboardRepository = LeaderboardRepository(firestore); final authenticationRepository = AuthenticationRepository(firebaseAuth); - final pinballPlayer = PinballPlayer(); + final pinballAudioPlayer = PinballAudioPlayer(); unawaited( Firebase.initializeApp().then( (_) => authenticationRepository.authenticateAnonymously(), @@ -20,7 +20,7 @@ void main() { return App( authenticationRepository: authenticationRepository, leaderboardRepository: leaderboardRepository, - pinballPlayer: pinballPlayer, + pinballAudioPlayer: pinballAudioPlayer, ); }); } diff --git a/lib/main_development.dart b/lib/main_development.dart deleted file mode 100644 index 67d83b81..00000000 --- a/lib/main_development.dart +++ /dev/null @@ -1,26 +0,0 @@ -import 'dart:async'; - -import 'package:authentication_repository/authentication_repository.dart'; -import 'package:firebase_core/firebase_core.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:pinball/app/app.dart'; -import 'package:pinball/bootstrap.dart'; -import 'package:pinball_audio/pinball_audio.dart'; - -void main() { - bootstrap((firestore, firebaseAuth) async { - final leaderboardRepository = LeaderboardRepository(firestore); - final authenticationRepository = AuthenticationRepository(firebaseAuth); - final pinballPlayer = PinballPlayer(); - unawaited( - Firebase.initializeApp().then( - (_) => authenticationRepository.authenticateAnonymously(), - ), - ); - return App( - authenticationRepository: authenticationRepository, - leaderboardRepository: leaderboardRepository, - pinballPlayer: pinballPlayer, - ); - }); -} diff --git a/lib/main_staging.dart b/lib/main_staging.dart deleted file mode 100644 index 67d83b81..00000000 --- a/lib/main_staging.dart +++ /dev/null @@ -1,26 +0,0 @@ -import 'dart:async'; - -import 'package:authentication_repository/authentication_repository.dart'; -import 'package:firebase_core/firebase_core.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:pinball/app/app.dart'; -import 'package:pinball/bootstrap.dart'; -import 'package:pinball_audio/pinball_audio.dart'; - -void main() { - bootstrap((firestore, firebaseAuth) async { - final leaderboardRepository = LeaderboardRepository(firestore); - final authenticationRepository = AuthenticationRepository(firebaseAuth); - final pinballPlayer = PinballPlayer(); - unawaited( - Firebase.initializeApp().then( - (_) => authenticationRepository.authenticateAnonymously(), - ), - ); - return App( - authenticationRepository: authenticationRepository, - leaderboardRepository: leaderboardRepository, - pinballPlayer: pinballPlayer, - ); - }); -} diff --git a/lib/more_information/more_information_dialog.dart b/lib/more_information/more_information_dialog.dart index 179c06f5..b9a9ddbb 100644 --- a/lib/more_information/more_information_dialog.dart +++ b/lib/more_information/more_information_dialog.dart @@ -55,8 +55,6 @@ class _LinkBoxHeader extends StatelessWidget { @override Widget build(BuildContext context) { final l10n = context.l10n; - final indent = MediaQuery.of(context).size.width / 5; - return Column( children: [ Text( @@ -68,11 +66,9 @@ class _LinkBoxHeader extends StatelessWidget { overflow: TextOverflow.ellipsis, ), const SizedBox(height: 12), - Divider( - color: PinballColors.white, - endIndent: indent, - indent: indent, - thickness: 2, + const SizedBox( + width: 200, + child: Divider(color: PinballColors.white, thickness: 2), ), ], ); diff --git a/lib/start_game/bloc/start_game_bloc.dart b/lib/start_game/bloc/start_game_bloc.dart index 3a96b57b..5892cd80 100644 --- a/lib/start_game/bloc/start_game_bloc.dart +++ b/lib/start_game/bloc/start_game_bloc.dart @@ -11,6 +11,7 @@ class StartGameBloc extends Bloc { /// {@macro start_game_bloc} StartGameBloc() : super(const StartGameState.initial()) { on(_onPlayTapped); + on(_onReplayTapped); on(_onCharacterSelected); on(_onHowToPlayFinished); } @@ -26,6 +27,17 @@ class StartGameBloc extends Bloc { ); } + void _onReplayTapped( + ReplayTapped event, + Emitter emit, + ) { + emit( + state.copyWith( + status: StartGameStatus.selectCharacter, + ), + ); + } + void _onCharacterSelected( CharacterSelected event, Emitter emit, diff --git a/lib/start_game/bloc/start_game_event.dart b/lib/start_game/bloc/start_game_event.dart index ce164e97..ae216c32 100644 --- a/lib/start_game/bloc/start_game_event.dart +++ b/lib/start_game/bloc/start_game_event.dart @@ -19,6 +19,17 @@ class PlayTapped extends StartGameEvent { List get props => []; } +/// {@template replay_tapped} +/// Replay tapped event. +/// {@endtemplate} +class ReplayTapped extends StartGameEvent { + /// {@macro replay_tapped} + const ReplayTapped(); + + @override + List get props => []; +} + /// {@template character_selected} /// Character selected event. /// {@endtemplate} diff --git a/packages/pinball_audio/assets/sfx/android.mp3 b/packages/pinball_audio/assets/sfx/android.mp3 new file mode 100644 index 00000000..33bebe07 Binary files /dev/null and b/packages/pinball_audio/assets/sfx/android.mp3 differ diff --git a/packages/pinball_audio/assets/sfx/dash.mp3 b/packages/pinball_audio/assets/sfx/dash.mp3 new file mode 100644 index 00000000..1180fc4e Binary files /dev/null and b/packages/pinball_audio/assets/sfx/dash.mp3 differ diff --git a/packages/pinball_audio/assets/sfx/dino.mp3 b/packages/pinball_audio/assets/sfx/dino.mp3 new file mode 100644 index 00000000..e8e4a1d5 Binary files /dev/null and b/packages/pinball_audio/assets/sfx/dino.mp3 differ diff --git a/packages/pinball_audio/lib/gen/assets.gen.dart b/packages/pinball_audio/lib/gen/assets.gen.dart index 08e83d87..bdd8e09e 100644 --- a/packages/pinball_audio/lib/gen/assets.gen.dart +++ b/packages/pinball_audio/lib/gen/assets.gen.dart @@ -14,8 +14,11 @@ class $AssetsMusicGen { class $AssetsSfxGen { const $AssetsSfxGen(); + String get android => 'assets/sfx/android.mp3'; String get bumperA => 'assets/sfx/bumper_a.mp3'; String get bumperB => 'assets/sfx/bumper_b.mp3'; + String get dash => 'assets/sfx/dash.mp3'; + String get dino => 'assets/sfx/dino.mp3'; String get gameOverVoiceOver => 'assets/sfx/game_over_voice_over.mp3'; String get google => 'assets/sfx/google.mp3'; String get ioPinballVoiceOver => 'assets/sfx/io_pinball_voice_over.mp3'; diff --git a/packages/pinball_audio/lib/src/pinball_audio.dart b/packages/pinball_audio/lib/src/pinball_audio.dart index 95c993c5..1756d965 100644 --- a/packages/pinball_audio/lib/src/pinball_audio.dart +++ b/packages/pinball_audio/lib/src/pinball_audio.dart @@ -28,6 +28,15 @@ enum PinballAudio { /// Sparky sparky, + + /// Android + android, + + /// Dino + dino, + + /// Dash + dash, } /// Defines the contract of the creation of an [AudioPool]. @@ -136,12 +145,12 @@ class _BumperAudio extends _Audio { } } -/// {@template pinball_player} +/// {@template pinball_audio_player} /// Sound manager for the pinball game /// {@endtemplate} -class PinballPlayer { - /// {@macro pinball_player} - PinballPlayer({ +class PinballAudioPlayer { + /// {@macro pinball_audio_player} + PinballAudioPlayer({ CreateAudioPool? createAudioPool, PlaySingleAudio? playSingleAudio, LoopSingleAudio? loopSingleAudio, @@ -169,6 +178,21 @@ class PinballPlayer { playSingleAudio: _playSingleAudio, path: Assets.sfx.sparky, ), + PinballAudio.dino: _SimplePlayAudio( + preCacheSingleAudio: _preCacheSingleAudio, + playSingleAudio: _playSingleAudio, + path: Assets.sfx.dino, + ), + PinballAudio.dash: _SimplePlayAudio( + preCacheSingleAudio: _preCacheSingleAudio, + playSingleAudio: _playSingleAudio, + path: Assets.sfx.dash, + ), + PinballAudio.android: _SimplePlayAudio( + preCacheSingleAudio: _preCacheSingleAudio, + playSingleAudio: _playSingleAudio, + path: Assets.sfx.android, + ), PinballAudio.launcher: _SimplePlayAudio( preCacheSingleAudio: _preCacheSingleAudio, playSingleAudio: _playSingleAudio, @@ -220,7 +244,7 @@ class PinballPlayer { return audios.values.map((a) => a.load()).toList(); } - /// Plays the received auido + /// Plays the received audio void play(PinballAudio audio) { assert( audios.containsKey(audio), diff --git a/packages/pinball_audio/test/src/pinball_audio_test.dart b/packages/pinball_audio/test/src/pinball_audio_test.dart index 39060eb2..8374e820 100644 --- a/packages/pinball_audio/test/src/pinball_audio_test.dart +++ b/packages/pinball_audio/test/src/pinball_audio_test.dart @@ -51,7 +51,7 @@ void main() { late _MockLoopSingleAudio loopSingleAudio; late _PreCacheSingleAudio preCacheSingleAudio; late Random seed; - late PinballPlayer player; + late PinballAudioPlayer audioPlayer; setUpAll(() { registerFallbackValue(_MockAudioCache()); @@ -81,7 +81,7 @@ void main() { seed = _MockRandom(); - player = PinballPlayer( + audioPlayer = PinballAudioPlayer( configureAudioCache: configureAudioCache.onCall, createAudioPool: createAudioPool.onCall, playSingleAudio: playSingleAudio.onCall, @@ -92,12 +92,12 @@ void main() { }); test('can be instantiated', () { - expect(PinballPlayer(), isNotNull); + expect(PinballAudioPlayer(), isNotNull); }); group('load', () { test('creates the bumpers pools', () async { - await Future.wait(player.load()); + await Future.wait(audioPlayer.load()); verify( () => createAudioPool.onCall( @@ -117,25 +117,25 @@ void main() { }); test('configures the audio cache instance', () async { - await Future.wait(player.load()); + await Future.wait(audioPlayer.load()); verify(() => configureAudioCache.onCall(FlameAudio.audioCache)) .called(1); }); test('sets the correct prefix', () async { - player = PinballPlayer( + audioPlayer = PinballAudioPlayer( createAudioPool: createAudioPool.onCall, playSingleAudio: playSingleAudio.onCall, preCacheSingleAudio: preCacheSingleAudio.onCall, ); - await Future.wait(player.load()); + await Future.wait(audioPlayer.load()); expect(FlameAudio.audioCache.prefix, equals('')); }); test('pre cache the assets', () async { - await Future.wait(player.load()); + await Future.wait(audioPlayer.load()); verify( () => preCacheSingleAudio @@ -145,6 +145,18 @@ void main() { () => preCacheSingleAudio .onCall('packages/pinball_audio/assets/sfx/sparky.mp3'), ).called(1); + verify( + () => preCacheSingleAudio + .onCall('packages/pinball_audio/assets/sfx/dino.mp3'), + ).called(1); + verify( + () => preCacheSingleAudio + .onCall('packages/pinball_audio/assets/sfx/android.mp3'), + ).called(1); + verify( + () => preCacheSingleAudio + .onCall('packages/pinball_audio/assets/sfx/dash.mp3'), + ).called(1); verify( () => preCacheSingleAudio.onCall( 'packages/pinball_audio/assets/sfx/io_pinball_voice_over.mp3', @@ -197,8 +209,8 @@ void main() { group('when seed is true', () { test('plays the bumper A sound pool', () async { when(seed.nextBool).thenReturn(true); - await Future.wait(player.load()); - player.play(PinballAudio.bumper); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.bumper); verify(() => bumperAPool.start(volume: 0.6)).called(1); }); @@ -207,8 +219,8 @@ void main() { group('when seed is false', () { test('plays the bumper B sound pool', () async { when(seed.nextBool).thenReturn(false); - await Future.wait(player.load()); - player.play(PinballAudio.bumper); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.bumper); verify(() => bumperBPool.start(volume: 0.6)).called(1); }); @@ -217,8 +229,8 @@ void main() { group('google', () { test('plays the correct file', () async { - await Future.wait(player.load()); - player.play(PinballAudio.google); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.google); verify( () => playSingleAudio @@ -229,8 +241,8 @@ void main() { group('sparky', () { test('plays the correct file', () async { - await Future.wait(player.load()); - player.play(PinballAudio.sparky); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.sparky); verify( () => playSingleAudio @@ -239,10 +251,46 @@ void main() { }); }); + group('dino', () { + test('plays the correct file', () async { + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.dino); + + verify( + () => playSingleAudio + .onCall('packages/pinball_audio/${Assets.sfx.dino}'), + ).called(1); + }); + }); + + group('android', () { + test('plays the correct file', () async { + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.android); + + verify( + () => playSingleAudio + .onCall('packages/pinball_audio/${Assets.sfx.android}'), + ).called(1); + }); + }); + + group('dash', () { + test('plays the correct file', () async { + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.dash); + + verify( + () => playSingleAudio + .onCall('packages/pinball_audio/${Assets.sfx.dash}'), + ).called(1); + }); + }); + group('launcher', () { test('plays the correct file', () async { - await Future.wait(player.load()); - player.play(PinballAudio.launcher); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.launcher); verify( () => playSingleAudio @@ -253,8 +301,8 @@ void main() { group('ioPinballVoiceOver', () { test('plays the correct file', () async { - await Future.wait(player.load()); - player.play(PinballAudio.ioPinballVoiceOver); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.ioPinballVoiceOver); verify( () => playSingleAudio.onCall( @@ -266,8 +314,8 @@ void main() { group('gameOverVoiceOver', () { test('plays the correct file', () async { - await Future.wait(player.load()); - player.play(PinballAudio.gameOverVoiceOver); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.gameOverVoiceOver); verify( () => playSingleAudio.onCall( @@ -279,8 +327,8 @@ void main() { group('backgroundMusic', () { test('plays the correct file', () async { - await Future.wait(player.load()); - player.play(PinballAudio.backgroundMusic); + await Future.wait(audioPlayer.load()); + audioPlayer.play(PinballAudio.backgroundMusic); verify( () => loopSingleAudio @@ -292,10 +340,13 @@ void main() { test( 'throws assertions error when playing an unregistered audio', () async { - player.audios.remove(PinballAudio.google); - await Future.wait(player.load()); + audioPlayer.audios.remove(PinballAudio.google); + await Future.wait(audioPlayer.load()); - expect(() => player.play(PinballAudio.google), throwsAssertionError); + expect( + () => audioPlayer.play(PinballAudio.google), + throwsAssertionError, + ); }, ); }); diff --git a/packages/pinball_components/assets/images/backbox/display_title_decoration.png b/packages/pinball_components/assets/images/backbox/display_title_decoration.png new file mode 100644 index 00000000..71f8d609 Binary files /dev/null and b/packages/pinball_components/assets/images/backbox/display_title_decoration.png differ diff --git a/packages/pinball_components/assets/images/dino/top-wall.png b/packages/pinball_components/assets/images/dino/top-wall.png index 7ee69411..76dc4f12 100644 Binary files a/packages/pinball_components/assets/images/dino/top-wall.png and b/packages/pinball_components/assets/images/dino/top-wall.png differ diff --git a/packages/pinball_components/lib/gen/assets.gen.dart b/packages/pinball_components/lib/gen/assets.gen.dart index cfe34184..53ac5c72 100644 --- a/packages/pinball_components/lib/gen/assets.gen.dart +++ b/packages/pinball_components/lib/gen/assets.gen.dart @@ -3,6 +3,8 @@ /// FlutterGen /// ***************************************************** +// ignore_for_file: directives_ordering,unnecessary_import + import 'package:flutter/widgets.dart'; class $AssetsImagesGen { @@ -12,13 +14,19 @@ class $AssetsImagesGen { $AssetsImagesBackboxGen get backbox => const $AssetsImagesBackboxGen(); $AssetsImagesBallGen get ball => const $AssetsImagesBallGen(); $AssetsImagesBaseboardGen get baseboard => const $AssetsImagesBaseboardGen(); + + /// File path: assets/images/board-background.png AssetGenImage get boardBackground => const AssetGenImage('assets/images/board-background.png'); + $AssetsImagesBoundaryGen get boundary => const $AssetsImagesBoundaryGen(); $AssetsImagesDashGen get dash => const $AssetsImagesDashGen(); $AssetsImagesDinoGen get dino => const $AssetsImagesDinoGen(); + + /// File path: assets/images/error_background.png AssetGenImage get errorBackground => const AssetGenImage('assets/images/error_background.png'); + $AssetsImagesFlapperGen get flapper => const $AssetsImagesFlapperGen(); $AssetsImagesFlipperGen get flipper => const $AssetsImagesFlipperGen(); $AssetsImagesGoogleRolloverGen get googleRollover => @@ -53,8 +61,15 @@ class $AssetsImagesAndroidGen { class $AssetsImagesBackboxGen { const $AssetsImagesBackboxGen(); + /// File path: assets/images/backbox/display-divider.png AssetGenImage get displayDivider => const AssetGenImage('assets/images/backbox/display-divider.png'); + + /// File path: assets/images/backbox/display_title_decoration.png + AssetGenImage get displayTitleDecoration => + const AssetGenImage('assets/images/backbox/display_title_decoration.png'); + + /// File path: assets/images/backbox/marquee.png AssetGenImage get marquee => const AssetGenImage('assets/images/backbox/marquee.png'); } @@ -62,6 +77,7 @@ class $AssetsImagesBackboxGen { class $AssetsImagesBallGen { const $AssetsImagesBallGen(); + /// File path: assets/images/ball/flame_effect.png AssetGenImage get flameEffect => const AssetGenImage('assets/images/ball/flame_effect.png'); } @@ -69,8 +85,11 @@ class $AssetsImagesBallGen { class $AssetsImagesBaseboardGen { const $AssetsImagesBaseboardGen(); + /// File path: assets/images/baseboard/left.png AssetGenImage get left => const AssetGenImage('assets/images/baseboard/left.png'); + + /// File path: assets/images/baseboard/right.png AssetGenImage get right => const AssetGenImage('assets/images/baseboard/right.png'); } @@ -78,10 +97,15 @@ class $AssetsImagesBaseboardGen { class $AssetsImagesBoundaryGen { const $AssetsImagesBoundaryGen(); + /// File path: assets/images/boundary/bottom.png AssetGenImage get bottom => const AssetGenImage('assets/images/boundary/bottom.png'); + + /// File path: assets/images/boundary/outer-bottom.png AssetGenImage get outerBottom => const AssetGenImage('assets/images/boundary/outer-bottom.png'); + + /// File path: assets/images/boundary/outer.png AssetGenImage get outer => const AssetGenImage('assets/images/boundary/outer.png'); } @@ -89,8 +113,10 @@ class $AssetsImagesBoundaryGen { class $AssetsImagesDashGen { const $AssetsImagesDashGen(); + /// File path: assets/images/dash/animatronic.png AssetGenImage get animatronic => const AssetGenImage('assets/images/dash/animatronic.png'); + $AssetsImagesDashBumperGen get bumper => const $AssetsImagesDashBumperGen(); } @@ -99,10 +125,16 @@ class $AssetsImagesDinoGen { $AssetsImagesDinoAnimatronicGen get animatronic => const $AssetsImagesDinoAnimatronicGen(); + + /// File path: assets/images/dino/bottom-wall.png AssetGenImage get bottomWall => const AssetGenImage('assets/images/dino/bottom-wall.png'); + + /// File path: assets/images/dino/top-wall-tunnel.png AssetGenImage get topWallTunnel => const AssetGenImage('assets/images/dino/top-wall-tunnel.png'); + + /// File path: assets/images/dino/top-wall.png AssetGenImage get topWall => const AssetGenImage('assets/images/dino/top-wall.png'); } @@ -110,10 +142,15 @@ class $AssetsImagesDinoGen { class $AssetsImagesFlapperGen { const $AssetsImagesFlapperGen(); + /// File path: assets/images/flapper/back-support.png AssetGenImage get backSupport => const AssetGenImage('assets/images/flapper/back-support.png'); + + /// File path: assets/images/flapper/flap.png AssetGenImage get flap => const AssetGenImage('assets/images/flapper/flap.png'); + + /// File path: assets/images/flapper/front-support.png AssetGenImage get frontSupport => const AssetGenImage('assets/images/flapper/front-support.png'); } @@ -121,8 +158,11 @@ class $AssetsImagesFlapperGen { class $AssetsImagesFlipperGen { const $AssetsImagesFlipperGen(); + /// File path: assets/images/flipper/left.png AssetGenImage get left => const AssetGenImage('assets/images/flipper/left.png'); + + /// File path: assets/images/flipper/right.png AssetGenImage get right => const AssetGenImage('assets/images/flipper/right.png'); } @@ -163,10 +203,15 @@ class $AssetsImagesKickerGen { class $AssetsImagesLaunchRampGen { const $AssetsImagesLaunchRampGen(); + /// File path: assets/images/launch_ramp/background-railing.png AssetGenImage get backgroundRailing => const AssetGenImage('assets/images/launch_ramp/background-railing.png'); + + /// File path: assets/images/launch_ramp/foreground-railing.png AssetGenImage get foregroundRailing => const AssetGenImage('assets/images/launch_ramp/foreground-railing.png'); + + /// File path: assets/images/launch_ramp/ramp.png AssetGenImage get ramp => const AssetGenImage('assets/images/launch_ramp/ramp.png'); } @@ -174,8 +219,11 @@ class $AssetsImagesLaunchRampGen { class $AssetsImagesMultiballGen { const $AssetsImagesMultiballGen(); + /// File path: assets/images/multiball/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/multiball/dimmed.png'); + + /// File path: assets/images/multiball/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/multiball/lit.png'); } @@ -193,8 +241,11 @@ class $AssetsImagesMultiplierGen { class $AssetsImagesPlungerGen { const $AssetsImagesPlungerGen(); + /// File path: assets/images/plunger/plunger.png AssetGenImage get plunger => const AssetGenImage('assets/images/plunger/plunger.png'); + + /// File path: assets/images/plunger/rocket.png AssetGenImage get rocket => const AssetGenImage('assets/images/plunger/rocket.png'); } @@ -202,12 +253,19 @@ class $AssetsImagesPlungerGen { class $AssetsImagesScoreGen { const $AssetsImagesScoreGen(); + /// File path: assets/images/score/five-thousand.png AssetGenImage get fiveThousand => const AssetGenImage('assets/images/score/five-thousand.png'); + + /// File path: assets/images/score/one-million.png AssetGenImage get oneMillion => const AssetGenImage('assets/images/score/one-million.png'); + + /// File path: assets/images/score/twenty-thousand.png AssetGenImage get twentyThousand => const AssetGenImage('assets/images/score/twenty-thousand.png'); + + /// File path: assets/images/score/two-hundred-thousand.png AssetGenImage get twoHundredThousand => const AssetGenImage('assets/images/score/two-hundred-thousand.png'); } @@ -215,12 +273,19 @@ class $AssetsImagesScoreGen { class $AssetsImagesSignpostGen { const $AssetsImagesSignpostGen(); + /// File path: assets/images/signpost/active1.png AssetGenImage get active1 => const AssetGenImage('assets/images/signpost/active1.png'); + + /// File path: assets/images/signpost/active2.png AssetGenImage get active2 => const AssetGenImage('assets/images/signpost/active2.png'); + + /// File path: assets/images/signpost/active3.png AssetGenImage get active3 => const AssetGenImage('assets/images/signpost/active3.png'); + + /// File path: assets/images/signpost/inactive.png AssetGenImage get inactive => const AssetGenImage('assets/images/signpost/inactive.png'); } @@ -228,12 +293,19 @@ class $AssetsImagesSignpostGen { class $AssetsImagesSkillShotGen { const $AssetsImagesSkillShotGen(); + /// File path: assets/images/skill_shot/decal.png AssetGenImage get decal => const AssetGenImage('assets/images/skill_shot/decal.png'); + + /// File path: assets/images/skill_shot/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/skill_shot/dimmed.png'); + + /// File path: assets/images/skill_shot/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/skill_shot/lit.png'); + + /// File path: assets/images/skill_shot/pin.png AssetGenImage get pin => const AssetGenImage('assets/images/skill_shot/pin.png'); } @@ -241,8 +313,11 @@ class $AssetsImagesSkillShotGen { class $AssetsImagesSlingshotGen { const $AssetsImagesSlingshotGen(); + /// File path: assets/images/slingshot/lower.png AssetGenImage get lower => const AssetGenImage('assets/images/slingshot/lower.png'); + + /// File path: assets/images/slingshot/upper.png AssetGenImage get upper => const AssetGenImage('assets/images/slingshot/upper.png'); } @@ -250,8 +325,10 @@ class $AssetsImagesSlingshotGen { class $AssetsImagesSparkyGen { const $AssetsImagesSparkyGen(); + /// File path: assets/images/sparky/animatronic.png AssetGenImage get animatronic => const AssetGenImage('assets/images/sparky/animatronic.png'); + $AssetsImagesSparkyBumperGen get bumper => const $AssetsImagesSparkyBumperGen(); $AssetsImagesSparkyComputerGen get computer => @@ -272,8 +349,11 @@ class $AssetsImagesAndroidBumperGen { class $AssetsImagesAndroidRailGen { const $AssetsImagesAndroidRailGen(); + /// File path: assets/images/android/rail/exit.png AssetGenImage get exit => const AssetGenImage('assets/images/android/rail/exit.png'); + + /// File path: assets/images/android/rail/main.png AssetGenImage get main => const AssetGenImage('assets/images/android/rail/main.png'); } @@ -283,12 +363,20 @@ class $AssetsImagesAndroidRampGen { $AssetsImagesAndroidRampArrowGen get arrow => const $AssetsImagesAndroidRampArrowGen(); + + /// File path: assets/images/android/ramp/board-opening.png AssetGenImage get boardOpening => const AssetGenImage('assets/images/android/ramp/board-opening.png'); + + /// File path: assets/images/android/ramp/main.png AssetGenImage get main => const AssetGenImage('assets/images/android/ramp/main.png'); + + /// File path: assets/images/android/ramp/railing-background.png AssetGenImage get railingBackground => const AssetGenImage('assets/images/android/ramp/railing-background.png'); + + /// File path: assets/images/android/ramp/railing-foreground.png AssetGenImage get railingForeground => const AssetGenImage('assets/images/android/ramp/railing-foreground.png'); } @@ -296,10 +384,15 @@ class $AssetsImagesAndroidRampGen { class $AssetsImagesAndroidSpaceshipGen { const $AssetsImagesAndroidSpaceshipGen(); + /// File path: assets/images/android/spaceship/animatronic.png AssetGenImage get animatronic => const AssetGenImage('assets/images/android/spaceship/animatronic.png'); + + /// File path: assets/images/android/spaceship/light-beam.png AssetGenImage get lightBeam => const AssetGenImage('assets/images/android/spaceship/light-beam.png'); + + /// File path: assets/images/android/spaceship/saucer.png AssetGenImage get saucer => const AssetGenImage('assets/images/android/spaceship/saucer.png'); } @@ -316,8 +409,11 @@ class $AssetsImagesDashBumperGen { class $AssetsImagesDinoAnimatronicGen { const $AssetsImagesDinoAnimatronicGen(); + /// File path: assets/images/dino/animatronic/head.png AssetGenImage get head => const AssetGenImage('assets/images/dino/animatronic/head.png'); + + /// File path: assets/images/dino/animatronic/mouth.png AssetGenImage get mouth => const AssetGenImage('assets/images/dino/animatronic/mouth.png'); } @@ -343,8 +439,11 @@ class $AssetsImagesGoogleRolloverRightGen { class $AssetsImagesGoogleWordLetter1Gen { const $AssetsImagesGoogleWordLetter1Gen(); + /// File path: assets/images/google_word/letter1/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/google_word/letter1/dimmed.png'); + + /// File path: assets/images/google_word/letter1/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/google_word/letter1/lit.png'); } @@ -352,8 +451,11 @@ class $AssetsImagesGoogleWordLetter1Gen { class $AssetsImagesGoogleWordLetter2Gen { const $AssetsImagesGoogleWordLetter2Gen(); + /// File path: assets/images/google_word/letter2/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/google_word/letter2/dimmed.png'); + + /// File path: assets/images/google_word/letter2/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/google_word/letter2/lit.png'); } @@ -361,8 +463,11 @@ class $AssetsImagesGoogleWordLetter2Gen { class $AssetsImagesGoogleWordLetter3Gen { const $AssetsImagesGoogleWordLetter3Gen(); + /// File path: assets/images/google_word/letter3/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/google_word/letter3/dimmed.png'); + + /// File path: assets/images/google_word/letter3/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/google_word/letter3/lit.png'); } @@ -370,8 +475,11 @@ class $AssetsImagesGoogleWordLetter3Gen { class $AssetsImagesGoogleWordLetter4Gen { const $AssetsImagesGoogleWordLetter4Gen(); + /// File path: assets/images/google_word/letter4/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/google_word/letter4/dimmed.png'); + + /// File path: assets/images/google_word/letter4/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/google_word/letter4/lit.png'); } @@ -379,8 +487,11 @@ class $AssetsImagesGoogleWordLetter4Gen { class $AssetsImagesGoogleWordLetter5Gen { const $AssetsImagesGoogleWordLetter5Gen(); + /// File path: assets/images/google_word/letter5/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/google_word/letter5/dimmed.png'); + + /// File path: assets/images/google_word/letter5/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/google_word/letter5/lit.png'); } @@ -388,8 +499,11 @@ class $AssetsImagesGoogleWordLetter5Gen { class $AssetsImagesGoogleWordLetter6Gen { const $AssetsImagesGoogleWordLetter6Gen(); + /// File path: assets/images/google_word/letter6/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/google_word/letter6/dimmed.png'); + + /// File path: assets/images/google_word/letter6/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/google_word/letter6/lit.png'); } @@ -397,8 +511,11 @@ class $AssetsImagesGoogleWordLetter6Gen { class $AssetsImagesKickerLeftGen { const $AssetsImagesKickerLeftGen(); + /// File path: assets/images/kicker/left/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/kicker/left/dimmed.png'); + + /// File path: assets/images/kicker/left/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/kicker/left/lit.png'); } @@ -406,8 +523,11 @@ class $AssetsImagesKickerLeftGen { class $AssetsImagesKickerRightGen { const $AssetsImagesKickerRightGen(); + /// File path: assets/images/kicker/right/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/kicker/right/dimmed.png'); + + /// File path: assets/images/kicker/right/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/kicker/right/lit.png'); } @@ -415,8 +535,11 @@ class $AssetsImagesKickerRightGen { class $AssetsImagesMultiplierX2Gen { const $AssetsImagesMultiplierX2Gen(); + /// File path: assets/images/multiplier/x2/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/multiplier/x2/dimmed.png'); + + /// File path: assets/images/multiplier/x2/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/multiplier/x2/lit.png'); } @@ -424,8 +547,11 @@ class $AssetsImagesMultiplierX2Gen { class $AssetsImagesMultiplierX3Gen { const $AssetsImagesMultiplierX3Gen(); + /// File path: assets/images/multiplier/x3/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/multiplier/x3/dimmed.png'); + + /// File path: assets/images/multiplier/x3/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/multiplier/x3/lit.png'); } @@ -433,8 +559,11 @@ class $AssetsImagesMultiplierX3Gen { class $AssetsImagesMultiplierX4Gen { const $AssetsImagesMultiplierX4Gen(); + /// File path: assets/images/multiplier/x4/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/multiplier/x4/dimmed.png'); + + /// File path: assets/images/multiplier/x4/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/multiplier/x4/lit.png'); } @@ -442,8 +571,11 @@ class $AssetsImagesMultiplierX4Gen { class $AssetsImagesMultiplierX5Gen { const $AssetsImagesMultiplierX5Gen(); + /// File path: assets/images/multiplier/x5/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/multiplier/x5/dimmed.png'); + + /// File path: assets/images/multiplier/x5/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/multiplier/x5/lit.png'); } @@ -451,8 +583,11 @@ class $AssetsImagesMultiplierX5Gen { class $AssetsImagesMultiplierX6Gen { const $AssetsImagesMultiplierX6Gen(); + /// File path: assets/images/multiplier/x6/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/multiplier/x6/dimmed.png'); + + /// File path: assets/images/multiplier/x6/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/multiplier/x6/lit.png'); } @@ -468,10 +603,15 @@ class $AssetsImagesSparkyBumperGen { class $AssetsImagesSparkyComputerGen { const $AssetsImagesSparkyComputerGen(); + /// File path: assets/images/sparky/computer/base.png AssetGenImage get base => const AssetGenImage('assets/images/sparky/computer/base.png'); + + /// File path: assets/images/sparky/computer/glow.png AssetGenImage get glow => const AssetGenImage('assets/images/sparky/computer/glow.png'); + + /// File path: assets/images/sparky/computer/top.png AssetGenImage get top => const AssetGenImage('assets/images/sparky/computer/top.png'); } @@ -479,8 +619,11 @@ class $AssetsImagesSparkyComputerGen { class $AssetsImagesAndroidBumperAGen { const $AssetsImagesAndroidBumperAGen(); + /// File path: assets/images/android/bumper/a/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/android/bumper/a/dimmed.png'); + + /// File path: assets/images/android/bumper/a/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/android/bumper/a/lit.png'); } @@ -488,8 +631,11 @@ class $AssetsImagesAndroidBumperAGen { class $AssetsImagesAndroidBumperBGen { const $AssetsImagesAndroidBumperBGen(); + /// File path: assets/images/android/bumper/b/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/android/bumper/b/dimmed.png'); + + /// File path: assets/images/android/bumper/b/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/android/bumper/b/lit.png'); } @@ -497,8 +643,11 @@ class $AssetsImagesAndroidBumperBGen { class $AssetsImagesAndroidBumperCowGen { const $AssetsImagesAndroidBumperCowGen(); + /// File path: assets/images/android/bumper/cow/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/android/bumper/cow/dimmed.png'); + + /// File path: assets/images/android/bumper/cow/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/android/bumper/cow/lit.png'); } @@ -506,16 +655,27 @@ class $AssetsImagesAndroidBumperCowGen { class $AssetsImagesAndroidRampArrowGen { const $AssetsImagesAndroidRampArrowGen(); + /// File path: assets/images/android/ramp/arrow/active1.png AssetGenImage get active1 => const AssetGenImage('assets/images/android/ramp/arrow/active1.png'); + + /// File path: assets/images/android/ramp/arrow/active2.png AssetGenImage get active2 => const AssetGenImage('assets/images/android/ramp/arrow/active2.png'); + + /// File path: assets/images/android/ramp/arrow/active3.png AssetGenImage get active3 => const AssetGenImage('assets/images/android/ramp/arrow/active3.png'); + + /// File path: assets/images/android/ramp/arrow/active4.png AssetGenImage get active4 => const AssetGenImage('assets/images/android/ramp/arrow/active4.png'); + + /// File path: assets/images/android/ramp/arrow/active5.png AssetGenImage get active5 => const AssetGenImage('assets/images/android/ramp/arrow/active5.png'); + + /// File path: assets/images/android/ramp/arrow/inactive.png AssetGenImage get inactive => const AssetGenImage('assets/images/android/ramp/arrow/inactive.png'); } @@ -523,8 +683,11 @@ class $AssetsImagesAndroidRampArrowGen { class $AssetsImagesDashBumperAGen { const $AssetsImagesDashBumperAGen(); + /// File path: assets/images/dash/bumper/a/active.png AssetGenImage get active => const AssetGenImage('assets/images/dash/bumper/a/active.png'); + + /// File path: assets/images/dash/bumper/a/inactive.png AssetGenImage get inactive => const AssetGenImage('assets/images/dash/bumper/a/inactive.png'); } @@ -532,8 +695,11 @@ class $AssetsImagesDashBumperAGen { class $AssetsImagesDashBumperBGen { const $AssetsImagesDashBumperBGen(); + /// File path: assets/images/dash/bumper/b/active.png AssetGenImage get active => const AssetGenImage('assets/images/dash/bumper/b/active.png'); + + /// File path: assets/images/dash/bumper/b/inactive.png AssetGenImage get inactive => const AssetGenImage('assets/images/dash/bumper/b/inactive.png'); } @@ -541,8 +707,11 @@ class $AssetsImagesDashBumperBGen { class $AssetsImagesDashBumperMainGen { const $AssetsImagesDashBumperMainGen(); + /// File path: assets/images/dash/bumper/main/active.png AssetGenImage get active => const AssetGenImage('assets/images/dash/bumper/main/active.png'); + + /// File path: assets/images/dash/bumper/main/inactive.png AssetGenImage get inactive => const AssetGenImage('assets/images/dash/bumper/main/inactive.png'); } @@ -550,8 +719,11 @@ class $AssetsImagesDashBumperMainGen { class $AssetsImagesSparkyBumperAGen { const $AssetsImagesSparkyBumperAGen(); + /// File path: assets/images/sparky/bumper/a/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/sparky/bumper/a/dimmed.png'); + + /// File path: assets/images/sparky/bumper/a/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/sparky/bumper/a/lit.png'); } @@ -559,8 +731,11 @@ class $AssetsImagesSparkyBumperAGen { class $AssetsImagesSparkyBumperBGen { const $AssetsImagesSparkyBumperBGen(); + /// File path: assets/images/sparky/bumper/b/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/sparky/bumper/b/dimmed.png'); + + /// File path: assets/images/sparky/bumper/b/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/sparky/bumper/b/lit.png'); } @@ -568,8 +743,11 @@ class $AssetsImagesSparkyBumperBGen { class $AssetsImagesSparkyBumperCGen { const $AssetsImagesSparkyBumperCGen(); + /// File path: assets/images/sparky/bumper/c/dimmed.png AssetGenImage get dimmed => const AssetGenImage('assets/images/sparky/bumper/c/dimmed.png'); + + /// File path: assets/images/sparky/bumper/c/lit.png AssetGenImage get lit => const AssetGenImage('assets/images/sparky/bumper/c/lit.png'); } diff --git a/packages/pinball_components/lib/gen/fonts.gen.dart b/packages/pinball_components/lib/gen/fonts.gen.dart index b15f2dd0..5f77da16 100644 --- a/packages/pinball_components/lib/gen/fonts.gen.dart +++ b/packages/pinball_components/lib/gen/fonts.gen.dart @@ -3,9 +3,14 @@ /// FlutterGen /// ***************************************************** +// ignore_for_file: directives_ordering,unnecessary_import + class FontFamily { FontFamily._(); + /// Font family: PixeloidMono static const String pixeloidMono = 'PixeloidMono'; + + /// Font family: PixeloidSans static const String pixeloidSans = 'PixeloidSans'; } diff --git a/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart b/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart index b3c721a1..0fd4628d 100644 --- a/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart +++ b/packages/pinball_components/lib/src/components/android_spaceship/android_spaceship.dart @@ -11,10 +11,8 @@ import 'package:pinball_flame/pinball_flame.dart'; export 'cubit/android_spaceship_cubit.dart'; class AndroidSpaceship extends Component { - AndroidSpaceship({ - required Vector2 position, - }) : bloc = AndroidSpaceshipCubit(), - super( + AndroidSpaceship({required Vector2 position}) + : super( children: [ _SpaceshipSaucer()..initialPosition = position, _SpaceshipSaucerSpriteAnimationComponent()..position = position, @@ -38,17 +36,8 @@ class AndroidSpaceship extends Component { /// This can be used for testing [AndroidSpaceship]'s behaviors in isolation. @visibleForTesting AndroidSpaceship.test({ - required this.bloc, Iterable? children, }) : super(children: children); - - final AndroidSpaceshipCubit bloc; - - @override - void onRemove() { - bloc.close(); - super.onRemove(); - } } class _SpaceshipSaucer extends BodyComponent with InitialPosition, Layered { diff --git a/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart b/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart index de5ed1ff..b577b7b3 100644 --- a/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart +++ b/packages/pinball_components/lib/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior.dart.dart @@ -1,14 +1,18 @@ +// ignore_for_file: public_member_api_docs + +import 'package:flame_bloc/flame_bloc.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; class AndroidSpaceshipEntranceBallContactBehavior - extends ContactBehavior { + extends ContactBehavior + with FlameBlocReader { @override void beginContact(Object other, Contact contact) { super.beginContact(other, contact); if (other is! Ball) return; - parent.parent.bloc.onBallEntered(); + bloc.onBallEntered(); } } diff --git a/packages/pinball_components/lib/src/components/ball/ball.dart b/packages/pinball_components/lib/src/components/ball/ball.dart index af7a0361..806e1905 100644 --- a/packages/pinball_components/lib/src/components/ball/ball.dart +++ b/packages/pinball_components/lib/src/components/ball/ball.dart @@ -68,7 +68,7 @@ class Ball extends BodyComponent with Layered, InitialPosition, ZIndex { return world.createBody(bodyDef)..createFixtureFromShape(shape, 1); } - /// Immediatly and completly [stop]s the ball. + /// Immediately and completely [stop]s the ball. /// /// The [Ball] will no longer be affected by any forces, including it's /// weight and those emitted from collisions. diff --git a/packages/pinball_components/lib/src/components/bumping_behavior.dart b/packages/pinball_components/lib/src/components/bumping_behavior.dart index af0d07c3..17931838 100644 --- a/packages/pinball_components/lib/src/components/bumping_behavior.dart +++ b/packages/pinball_components/lib/src/components/bumping_behavior.dart @@ -12,7 +12,7 @@ class BumpingBehavior extends ContactBehavior { /// Determines how strong the bump is. final double _strength; - /// This is used to recoginze the current state of a contact manifold in world + /// This is used to recognize the current state of a contact manifold in world /// coordinates. @visibleForTesting final WorldManifold worldManifold = WorldManifold(); diff --git a/packages/pinball_components/lib/src/components/components.dart b/packages/pinball_components/lib/src/components/components.dart index cfa384ff..bcd4aab6 100644 --- a/packages/pinball_components/lib/src/components/components.dart +++ b/packages/pinball_components/lib/src/components/components.dart @@ -10,10 +10,9 @@ export 'boundaries.dart'; export 'camera_zoom.dart'; export 'chrome_dino/chrome_dino.dart'; export 'dash_animatronic.dart'; -export 'dash_nest_bumper/dash_nest_bumper.dart'; +export 'dash_bumper/dash_bumper.dart'; export 'dino_walls.dart'; export 'error_component.dart'; -export 'fire_effect.dart'; export 'flapper/flapper.dart'; export 'flipper/flipper.dart'; export 'google_letter.dart'; @@ -28,7 +27,7 @@ export 'multiball/multiball.dart'; export 'multiplier/multiplier.dart'; export 'plunger.dart'; export 'rocket.dart'; -export 'score_component.dart'; +export 'score_component/score_component.dart'; export 'shapes/shapes.dart'; export 'signpost/signpost.dart'; export 'skill_shot/skill_shot.dart'; diff --git a/packages/pinball_components/lib/src/components/dash_animatronic.dart b/packages/pinball_components/lib/src/components/dash_animatronic.dart index faa604e9..bb7d983b 100644 --- a/packages/pinball_components/lib/src/components/dash_animatronic.dart +++ b/packages/pinball_components/lib/src/components/dash_animatronic.dart @@ -2,7 +2,7 @@ import 'package:flame/components.dart'; import 'package:pinball_components/pinball_components.dart'; /// {@template dash_animatronic} -/// Animated Dash that sits on top of the [DashNestBumper.main]. +/// Animated Dash that sits on top of the [DashBumper.main]. /// {@endtemplate} class DashAnimatronic extends SpriteAnimationComponent with HasGameRef { /// {@macro dash_animatronic} diff --git a/packages/pinball_components/lib/src/components/dash_bumper/behaviors/behaviors.dart b/packages/pinball_components/lib/src/components/dash_bumper/behaviors/behaviors.dart new file mode 100644 index 00000000..0167887f --- /dev/null +++ b/packages/pinball_components/lib/src/components/dash_bumper/behaviors/behaviors.dart @@ -0,0 +1 @@ +export 'dash_bumper_ball_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_bumper/behaviors/dash_bumper_ball_contact_behavior.dart similarity index 79% rename from packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_contact_behavior.dart rename to packages/pinball_components/lib/src/components/dash_bumper/behaviors/dash_bumper_ball_contact_behavior.dart index 934adef6..d147515c 100644 --- 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_bumper/behaviors/dash_bumper_ball_contact_behavior.dart @@ -2,8 +2,7 @@ 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 { +class DashBumperBallContactBehavior extends ContactBehavior { @override void beginContact(Object other, Contact contact) { super.beginContact(other, contact); diff --git a/packages/pinball_components/lib/src/components/dash_bumper/cubit/dash_bumper_cubit.dart b/packages/pinball_components/lib/src/components/dash_bumper/cubit/dash_bumper_cubit.dart new file mode 100644 index 00000000..84e626c4 --- /dev/null +++ b/packages/pinball_components/lib/src/components/dash_bumper/cubit/dash_bumper_cubit.dart @@ -0,0 +1,17 @@ +import 'package:bloc/bloc.dart'; + +part 'dash_bumper_state.dart'; + +class DashBumperCubit extends Cubit { + DashBumperCubit() : super(DashBumperState.inactive); + + /// Event added when the bumper contacts with a ball. + void onBallContacted() { + emit(DashBumperState.active); + } + + /// Event added when the bumper should return to its initial configuration. + void onReset() { + emit(DashBumperState.inactive); + } +} diff --git a/packages/pinball_components/lib/src/components/dash_bumper/cubit/dash_bumper_state.dart b/packages/pinball_components/lib/src/components/dash_bumper/cubit/dash_bumper_state.dart new file mode 100644 index 00000000..f15d2e57 --- /dev/null +++ b/packages/pinball_components/lib/src/components/dash_bumper/cubit/dash_bumper_state.dart @@ -0,0 +1,10 @@ +part of 'dash_bumper_cubit.dart'; + +/// Indicates the [DashBumperCubit]'s current state. +enum DashBumperState { + /// A lit up bumper. + active, + + /// A dimmed bumper. + inactive, +} diff --git a/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart b/packages/pinball_components/lib/src/components/dash_bumper/dash_bumper.dart similarity index 70% rename from packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart rename to packages/pinball_components/lib/src/components/dash_bumper/dash_bumper.dart index d657c485..1b960610 100644 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper/dash_nest_bumper.dart +++ b/packages/pinball_components/lib/src/components/dash_bumper/dash_bumper.dart @@ -5,17 +5,17 @@ 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/bumping_behavior.dart'; -import 'package:pinball_components/src/components/dash_nest_bumper/behaviors/behaviors.dart'; +import 'package:pinball_components/src/components/dash_bumper/behaviors/behaviors.dart'; import 'package:pinball_flame/pinball_flame.dart'; -export 'cubit/dash_nest_bumper_cubit.dart'; +export 'cubit/dash_bumper_cubit.dart'; -/// {@template dash_nest_bumper} -/// Bumper with a nest appearance. +/// {@template dash_bumper} +/// Bumper for the flutter forest. /// {@endtemplate} -class DashNestBumper extends BodyComponent with InitialPosition { - /// {@macro dash_nest_bumper} - DashNestBumper._({ +class DashBumper extends BodyComponent with InitialPosition { + /// {@macro dash_bumper} + DashBumper._({ required double majorRadius, required double minorRadius, required String activeAssetPath, @@ -28,19 +28,22 @@ class DashNestBumper extends BodyComponent with InitialPosition { super( renderBody: false, children: [ - _DashNestBumperSpriteGroupComponent( + _DashBumperSpriteGroupComponent( activeAssetPath: activeAssetPath, inactiveAssetPath: inactiveAssetPath, position: spritePosition, current: bloc.state, ), - DashNestBumperBallContactBehavior(), + DashBumperBallContactBehavior(), ...?children, ], ); - /// {@macro dash_nest_bumper} - DashNestBumper.main({ + /// {@macro dash_bumper} + /// + /// [DashBumper.main], usually positioned with a [DashAnimatronic] on top of + /// it. + DashBumper.main({ Iterable? children, }) : this._( majorRadius: 5.1, @@ -48,15 +51,18 @@ class DashNestBumper extends BodyComponent with InitialPosition { activeAssetPath: Assets.images.dash.bumper.main.active.keyName, inactiveAssetPath: Assets.images.dash.bumper.main.inactive.keyName, spritePosition: Vector2(0, -0.3), - bloc: DashNestBumperCubit(), + bloc: DashBumperCubit(), children: [ ...?children, BumpingBehavior(strength: 20), ], ); - /// {@macro dash_nest_bumper} - DashNestBumper.a({ + /// {@macro dash_bumper} + /// + /// [DashBumper.a] is positioned at the right side of the [DashBumper.main] in + /// the flutter forest. + DashBumper.a({ Iterable? children, }) : this._( majorRadius: 3, @@ -64,15 +70,18 @@ class DashNestBumper extends BodyComponent with InitialPosition { activeAssetPath: Assets.images.dash.bumper.a.active.keyName, inactiveAssetPath: Assets.images.dash.bumper.a.inactive.keyName, spritePosition: Vector2(0.3, -1.3), - bloc: DashNestBumperCubit(), + bloc: DashBumperCubit(), children: [ ...?children, BumpingBehavior(strength: 20), ], ); - /// {@macro dash_nest_bumper} - DashNestBumper.b({ + /// {@macro dash_bumper} + /// + /// [DashBumper.b] is positioned at the left side of the [DashBumper.main] in + /// the flutter forest. + DashBumper.b({ Iterable? children, }) : this._( majorRadius: 3.1, @@ -80,25 +89,26 @@ class DashNestBumper extends BodyComponent with InitialPosition { activeAssetPath: Assets.images.dash.bumper.b.active.keyName, inactiveAssetPath: Assets.images.dash.bumper.b.inactive.keyName, spritePosition: Vector2(0.4, -1.2), - bloc: DashNestBumperCubit(), + bloc: DashBumperCubit(), children: [ ...?children, BumpingBehavior(strength: 20), ], ); - /// Creates an [DashNestBumper] without any children. + /// Creates a [DashBumper] without any children. /// - /// This can be used for testing [DashNestBumper]'s behaviors in isolation. + /// This can be used for testing [DashBumper]'s behaviors in isolation. @visibleForTesting - DashNestBumper.test({required this.bloc}) + DashBumper.test({required this.bloc}) : _majorRadius = 3, _minorRadius = 2.5; final double _majorRadius; final double _minorRadius; - final DashNestBumperCubit bloc; + // ignore: public_member_api_docs + final DashBumperCubit bloc; @override void onRemove() { @@ -121,14 +131,14 @@ class DashNestBumper extends BodyComponent with InitialPosition { } } -class _DashNestBumperSpriteGroupComponent - extends SpriteGroupComponent - with HasGameRef, ParentIsA { - _DashNestBumperSpriteGroupComponent({ +class _DashBumperSpriteGroupComponent + extends SpriteGroupComponent + with HasGameRef, ParentIsA { + _DashBumperSpriteGroupComponent({ required String activeAssetPath, required String inactiveAssetPath, required Vector2 position, - required DashNestBumperState current, + required DashBumperState current, }) : _activeAssetPath = activeAssetPath, _inactiveAssetPath = inactiveAssetPath, super( @@ -146,9 +156,9 @@ class _DashNestBumperSpriteGroupComponent parent.bloc.stream.listen((state) => current = state); final sprites = { - DashNestBumperState.active: + DashBumperState.active: Sprite(gameRef.images.fromCache(_activeAssetPath)), - DashNestBumperState.inactive: + DashBumperState.inactive: Sprite(gameRef.images.fromCache(_inactiveAssetPath)), }; this.sprites = sprites; 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 deleted file mode 100644 index 839cbd67..00000000 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper/behaviors/behaviors.dart +++ /dev/null @@ -1 +0,0 @@ -export 'dash_nest_bumper_contact_behavior.dart'; 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 deleted file mode 100644 index 04d511a4..00000000 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit.dart +++ /dev/null @@ -1,17 +0,0 @@ -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 deleted file mode 100644 index c169069f..00000000 --- a/packages/pinball_components/lib/src/components/dash_nest_bumper/cubit/dash_nest_bumper_state.dart +++ /dev/null @@ -1,10 +0,0 @@ -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/fire_effect.dart b/packages/pinball_components/lib/src/components/fire_effect.dart deleted file mode 100644 index 77f3dd02..00000000 --- a/packages/pinball_components/lib/src/components/fire_effect.dart +++ /dev/null @@ -1,78 +0,0 @@ -import 'dart:math' as math; - -import 'package:flame/components.dart'; -import 'package:flame/extensions.dart'; -import 'package:flame/particles.dart'; -import 'package:flame_forge2d/flame_forge2d.dart' hide Particle; -import 'package:flutter/material.dart'; - -const _particleRadius = 0.25; - -/// {@template fire_effect} -/// A [BodyComponent] which creates a fire trail effect using the given -/// parameters -/// {@endtemplate} -class FireEffect extends ParticleSystemComponent { - /// {@macro fire_effect} - FireEffect({ - required this.burstPower, - required this.direction, - Vector2? position, - }) : super( - position: position, - ); - - /// A [double] value that will define how "strong" the burst of particles - /// will be. - final double burstPower; - - /// Which direction the burst will aim. - final Vector2 direction; - - @override - Future onLoad() async { - await super.onLoad(); - - final children = [ - ...List.generate(4, (index) { - return CircleParticle( - radius: _particleRadius, - paint: Paint()..color = Colors.yellow.darken((index + 1) / 4), - ); - }), - ...List.generate(4, (index) { - return CircleParticle( - radius: _particleRadius, - paint: Paint()..color = Colors.red.darken((index + 1) / 4), - ); - }), - ...List.generate(4, (index) { - return CircleParticle( - radius: _particleRadius, - paint: Paint()..color = Colors.orange.darken((index + 1) / 4), - ); - }), - ]; - final random = math.Random(); - final spreadTween = Tween(begin: -0.2, end: 0.2); - - particle = Particle.generate( - count: math.max((random.nextDouble() * (burstPower * 10)).toInt(), 1), - generator: (_) { - final spread = Vector2( - spreadTween.transform(random.nextDouble()), - spreadTween.transform(random.nextDouble()), - ); - final finalDirection = Vector2(direction.x, direction.y) + spread; - final speed = finalDirection * (burstPower * 20); - - return AcceleratedParticle( - lifespan: 5 / burstPower, - position: Vector2.zero(), - speed: speed, - child: children[random.nextInt(children.length)], - ); - }, - ); - } -} diff --git a/packages/pinball_components/lib/src/components/flipper/behaviors/flipper_jointing_behavior.dart b/packages/pinball_components/lib/src/components/flipper/behaviors/flipper_jointing_behavior.dart index c0574f6c..8e487141 100644 --- a/packages/pinball_components/lib/src/components/flipper/behaviors/flipper_jointing_behavior.dart +++ b/packages/pinball_components/lib/src/components/flipper/behaviors/flipper_jointing_behavior.dart @@ -6,8 +6,6 @@ import 'package:pinball_flame/pinball_flame.dart'; /// Joints the [Flipper] to allow pivoting around one end. class FlipperJointingBehavior extends Component with ParentIsA, HasGameRef { - late final RevoluteJoint _joint; - @override Future onLoad() async { await super.onLoad(); @@ -19,15 +17,7 @@ class FlipperJointingBehavior extends Component flipper: parent, anchor: anchor, ); - _joint = _FlipperJoint(jointDef); - parent.world.createJoint(_joint); - } - - @override - void onMount() { - gameRef.ready().whenComplete( - () => parent.body.joints.whereType<_FlipperJoint>().first.unlock(), - ); + parent.world.createJoint(RevoluteJoint(jointDef)); } } @@ -50,7 +40,7 @@ class _FlipperAnchor extends JointAnchor { } /// {@template flipper_anchor_revolute_joint_def} -/// Hinges one end of [Flipper] to a [_FlipperAnchor] to achieve a potivoting +/// Hinges one end of [Flipper] to a [_FlipperAnchor] to achieve a pivoting /// motion. /// {@endtemplate} class _FlipperAnchorRevoluteJointDef extends RevoluteJointDef { @@ -58,46 +48,15 @@ class _FlipperAnchorRevoluteJointDef extends RevoluteJointDef { _FlipperAnchorRevoluteJointDef({ required Flipper flipper, required _FlipperAnchor anchor, - }) : side = flipper.side { - enableLimit = true; + }) { initialize( flipper.body, anchor.body, flipper.body.position + anchor.body.position, ); - } - - final BoardSide side; -} -/// {@template flipper_joint} -/// [RevoluteJoint] that controls the pivoting motion of a [Flipper]. -/// {@endtemplate} -class _FlipperJoint extends RevoluteJoint { - /// {@macro flipper_joint} - _FlipperJoint(_FlipperAnchorRevoluteJointDef def) - : side = def.side, - super(def) { - lock(); - } - - /// Half the angle of the arc motion. - static const _halfSweepingAngle = 0.611; - - final BoardSide side; - - /// Locks the [Flipper] to its resting position. - /// - /// The joint is locked when initialized in order to force the [Flipper] - /// at its resting position. - void lock() { - final angle = _halfSweepingAngle * side.direction; - setLimits(angle, angle); - } - - /// Unlocks the [Flipper] from its resting position. - void unlock() { - const angle = _halfSweepingAngle; - setLimits(-angle, angle); + enableLimit = true; + upperAngle = 0.611; + lowerAngle = -upperAngle; } } diff --git a/packages/pinball_components/lib/src/components/joint_anchor.dart b/packages/pinball_components/lib/src/components/joint_anchor.dart index 63875d40..ceba41e3 100644 --- a/packages/pinball_components/lib/src/components/joint_anchor.dart +++ b/packages/pinball_components/lib/src/components/joint_anchor.dart @@ -12,7 +12,7 @@ import 'package:pinball_components/pinball_components.dart'; /// initialize( /// dynamicBody.body, /// anchor.body, -/// dynabmicBody.body + anchor.body.position, +/// dynamicBody.body + anchor.body.position, /// ); /// ``` /// {@endtemplate} diff --git a/packages/pinball_components/lib/src/components/plunger.dart b/packages/pinball_components/lib/src/components/plunger.dart index 44a91b0b..6f38eb37 100644 --- a/packages/pinball_components/lib/src/components/plunger.dart +++ b/packages/pinball_components/lib/src/components/plunger.dart @@ -6,7 +6,7 @@ import 'package:pinball_flame/pinball_flame.dart'; /// {@template plunger} /// [Plunger] serves as a spring, that shoots the ball on the right side of the -/// playfield. +/// play field. /// /// [Plunger] ignores gravity so the player controls its downward [pull]. /// {@endtemplate} diff --git a/packages/pinball_components/lib/src/components/score_component/behaviors/behaviors.dart b/packages/pinball_components/lib/src/components/score_component/behaviors/behaviors.dart new file mode 100644 index 00000000..dba073f0 --- /dev/null +++ b/packages/pinball_components/lib/src/components/score_component/behaviors/behaviors.dart @@ -0,0 +1 @@ +export 'score_component_scaling_behavior.dart'; diff --git a/packages/pinball_components/lib/src/components/score_component/behaviors/score_component_scaling_behavior.dart b/packages/pinball_components/lib/src/components/score_component/behaviors/score_component_scaling_behavior.dart new file mode 100644 index 00000000..5e3d184b --- /dev/null +++ b/packages/pinball_components/lib/src/components/score_component/behaviors/score_component_scaling_behavior.dart @@ -0,0 +1,24 @@ +import 'package:flame/components.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// Scales a [ScoreComponent] according to its position on the board. +class ScoreComponentScalingBehavior extends Component + with ParentIsA { + @override + void update(double dt) { + super.update(dt); + final boardHeight = BoardDimensions.bounds.height; + const maxShrinkValue = 0.83; + + final augmentedPosition = parent.position.y * 3; + final standardizedYPosition = augmentedPosition + (boardHeight / 2); + final scaleFactor = maxShrinkValue + + ((standardizedYPosition / boardHeight) * (1 - maxShrinkValue)); + + parent.scale.setValues( + scaleFactor, + scaleFactor, + ); + } +} diff --git a/packages/pinball_components/lib/src/components/score_component.dart b/packages/pinball_components/lib/src/components/score_component/score_component.dart similarity index 77% rename from packages/pinball_components/lib/src/components/score_component.dart rename to packages/pinball_components/lib/src/components/score_component/score_component.dart index 0b9940aa..4908c337 100644 --- a/packages/pinball_components/lib/src/components/score_component.dart +++ b/packages/pinball_components/lib/src/components/score_component/score_component.dart @@ -2,7 +2,9 @@ import 'dart:async'; import 'package:flame/components.dart'; import 'package:flame/effects.dart'; +import 'package:flutter/material.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/score_component/behaviors/score_component_scaling_behavior.dart'; import 'package:pinball_flame/pinball_flame.dart'; enum Points { @@ -26,10 +28,25 @@ class ScoreComponent extends SpriteComponent with HasGameRef, ZIndex { super( position: position, anchor: Anchor.center, + children: [ScoreComponentScalingBehavior()], ) { zIndex = ZIndexes.score; } + /// Creates a [ScoreComponent] without any children. + /// + /// This can be used for testing [ScoreComponent]'s behaviors in isolation. + @visibleForTesting + ScoreComponent.test({ + required this.points, + required Vector2 position, + required EffectController effectController, + }) : _effectController = effectController, + super( + position: position, + anchor: Anchor.center, + ); + late Points points; late final Effect _effect; diff --git a/packages/pinball_components/lib/src/components/signpost/signpost.dart b/packages/pinball_components/lib/src/components/signpost/signpost.dart index 115f1845..3ba486c1 100644 --- a/packages/pinball_components/lib/src/components/signpost/signpost.dart +++ b/packages/pinball_components/lib/src/components/signpost/signpost.dart @@ -9,7 +9,7 @@ export 'cubit/signpost_cubit.dart'; /// {@template signpost} /// A sign, found in the Flutter Forest. /// -/// Lights up a new sign whenever all three [DashNestBumper]s are hit. +/// Lights up a new sign whenever all three [DashBumper]s are hit. /// {@endtemplate} class Signpost extends BodyComponent with InitialPosition { /// {@macro signpost} diff --git a/packages/pinball_components/lib/src/components/slingshot.dart b/packages/pinball_components/lib/src/components/slingshot.dart index 5d9e7849..2ebaff9b 100644 --- a/packages/pinball_components/lib/src/components/slingshot.dart +++ b/packages/pinball_components/lib/src/components/slingshot.dart @@ -37,7 +37,7 @@ class Slingshot extends BodyComponent with InitialPosition { }) : _angle = angle, super( children: [ - _SlinghsotSpriteComponent(spritePath, angle: angle), + _SlingshotSpriteComponent(spritePath, angle: angle), BumpingBehavior(strength: 20), ], renderBody: false, @@ -90,8 +90,8 @@ class Slingshot extends BodyComponent with InitialPosition { } } -class _SlinghsotSpriteComponent extends SpriteComponent with HasGameRef { - _SlinghsotSpriteComponent( +class _SlingshotSpriteComponent extends SpriteComponent with HasGameRef { + _SlingshotSpriteComponent( String path, { required double angle, }) : _path = path, diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart b/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart index 57895c45..db98a30a 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior.dart @@ -9,7 +9,7 @@ import 'package:pinball_flame/pinball_flame.dart'; /// the [SpaceshipRamp]. /// {@endtemplate} class RampBallAscendingContactBehavior - extends ContactBehavior { + extends ContactBehavior { @override void beginContact(Object other, Contact contact) { super.beginContact(other, contact); diff --git a/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart b/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart index ea7ed2e7..07a5e79b 100644 --- a/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart +++ b/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart @@ -27,11 +27,6 @@ class SpaceshipRamp extends Component { required this.bloc, }) : super( children: [ - RampScoringSensor( - children: [ - RampBallAscendingContactBehavior(), - ], - )..initialPosition = Vector2(1.7, -20.4), _SpaceshipRampOpening( outsideLayer: Layer.spaceship, outsidePriority: ZIndexes.ballOnSpaceship, @@ -40,7 +35,7 @@ class SpaceshipRamp extends Component { ..initialPosition = Vector2(-13.7, -18.6) ..layer = Layer.spaceshipEntranceRamp, _SpaceshipRampBackground(), - _SpaceshipRampBoardOpening()..initialPosition = Vector2(3.4, -39.5), + SpaceshipRampBoardOpening()..initialPosition = Vector2(3.4, -39.5), _SpaceshipRampForegroundRailing(), SpaceshipRampBase()..initialPosition = Vector2(3.4, -42.5), _SpaceshipRampBackgroundRailingSpriteComponent(), @@ -246,13 +241,14 @@ extension on SpaceshipRampArrowSpriteState { } } -class _SpaceshipRampBoardOpening extends BodyComponent - with Layered, ZIndex, InitialPosition { - _SpaceshipRampBoardOpening() +class SpaceshipRampBoardOpening extends BodyComponent + with Layered, ZIndex, InitialPosition, ParentIsA { + SpaceshipRampBoardOpening() : super( renderBody: false, children: [ _SpaceshipRampBoardOpeningSpriteComponent(), + RampBallAscendingContactBehavior()..applyTo(['inside']), LayerContactBehavior(layer: Layer.spaceshipEntranceRamp) ..applyTo(['inside']), LayerContactBehavior( @@ -271,6 +267,13 @@ class _SpaceshipRampBoardOpening extends BodyComponent layer = Layer.opening; } + /// Creates a [SpaceshipRampBoardOpening] without any children. + /// + /// This can be used for testing [SpaceshipRampBoardOpening]'s behaviors in + /// isolation. + @visibleForTesting + SpaceshipRampBoardOpening.test(); + List _createFixtureDefs() { final topEdge = EdgeShape() ..set( @@ -495,46 +498,3 @@ class _SpaceshipRampOpening extends LayerSensor { ); } } - -/// {@template ramp_scoring_sensor} -/// Small sensor body used to detect when a ball has entered the -/// [SpaceshipRamp]. -/// {@endtemplate} -class RampScoringSensor extends BodyComponent - with ParentIsA, InitialPosition, Layered { - /// {@macro ramp_scoring_sensor} - RampScoringSensor({ - Iterable? children, - }) : super( - children: children, - renderBody: false, - ) { - layer = Layer.spaceshipEntranceRamp; - } - - /// Creates a [RampScoringSensor] without any children. - @visibleForTesting - RampScoringSensor.test(); - - @override - Body createBody() { - final shape = PolygonShape() - ..setAsBox( - 2.6, - .5, - initialPosition, - -5 * math.pi / 180, - ); - - final fixtureDef = FixtureDef( - shape, - isSensor: true, - ); - final bodyDef = BodyDef( - position: initialPosition, - userData: this, - ); - - return world.createBody(bodyDef)..createFixture(fixtureDef); - } -} diff --git a/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart b/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart index b0e1b0c8..ed000201 100644 --- a/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart +++ b/packages/pinball_components/lib/src/components/sparky_bumper/sparky_bumper.dart @@ -11,7 +11,7 @@ import 'package:pinball_flame/pinball_flame.dart'; export 'cubit/sparky_bumper_cubit.dart'; /// {@template sparky_bumper} -/// Bumper for Sparky area. +/// Bumper for the Sparky Scorch. /// {@endtemplate} class SparkyBumper extends BodyComponent with InitialPosition, ZIndex { /// {@macro sparky_bumper} diff --git a/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart b/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart index c96c5007..966eff02 100644 --- a/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart +++ b/packages/pinball_components/lib/src/components/sparky_computer/sparky_computer.dart @@ -65,7 +65,7 @@ class SparkyComputer extends BodyComponent { ..setAsBox( 1, 0.1, - Vector2(-13.2, -49.9), + Vector2(-13.1, -49.7), -0.18, ); diff --git a/packages/pinball_components/lib/src/components/z_indexes.dart b/packages/pinball_components/lib/src/components/z_indexes.dart index 2fbcc3af..0d0fab98 100644 --- a/packages/pinball_components/lib/src/components/z_indexes.dart +++ b/packages/pinball_components/lib/src/components/z_indexes.dart @@ -106,7 +106,7 @@ abstract class ZIndexes { // Score - static const score = _above + spaceshipRampForegroundRailing; + static const score = _above + sparkyAnimatronic; // Debug information diff --git a/packages/pinball_components/sandbox/README.md b/packages/pinball_components/sandbox/README.md index 08509a8b..f0ff7f74 100644 --- a/packages/pinball_components/sandbox/README.md +++ b/packages/pinball_components/sandbox/README.md @@ -1,4 +1,4 @@ -# Sandbox +# Pinball Components Sandbox ![coverage][coverage_badge] [![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link] @@ -6,7 +6,7 @@ Generated by the [Very Good CLI][very_good_cli_link] ๐Ÿค– -A sanbox application where components are showcased and developed in an isolated way +A sandbox application where components are showcased and developed in an isolated way --- diff --git a/packages/pinball_components/sandbox/lib/stories/effects/fire_effect_game.dart b/packages/pinball_components/sandbox/lib/stories/effects/fire_effect_game.dart deleted file mode 100644 index 3ca8ec1a..00000000 --- a/packages/pinball_components/sandbox/lib/stories/effects/fire_effect_game.dart +++ /dev/null @@ -1,48 +0,0 @@ -import 'package:flame/components.dart'; -import 'package:pinball_components/pinball_components.dart'; -import 'package:sandbox/common/common.dart'; - -class FireEffectGame extends LineGame { - static const description = ''' - Shows how the FireEffect renders. - - - Drag a line to define the trail direction. -'''; - - @override - void onLine(Vector2 line) { - add(_EffectEmitter(line)); - } -} - -class _EffectEmitter extends Component { - _EffectEmitter(this.line) { - _direction = line.normalized(); - _force = line.length; - } - - static const _timerLimit = 2.0; - var _timer = _timerLimit; - - final Vector2 line; - - late Vector2 _direction; - late double _force; - - @override - void update(double dt) { - super.update(dt); - - if (_timer > 0) { - add( - FireEffect( - burstPower: (_timer / _timerLimit) * _force, - direction: _direction, - ), - ); - _timer -= dt; - } else { - removeFromParent(); - } - } -} diff --git a/packages/pinball_components/sandbox/lib/stories/effects/stories.dart b/packages/pinball_components/sandbox/lib/stories/effects/stories.dart index 9b022987..3ea8e06a 100644 --- a/packages/pinball_components/sandbox/lib/stories/effects/stories.dart +++ b/packages/pinball_components/sandbox/lib/stories/effects/stories.dart @@ -1,18 +1,11 @@ import 'package:dashbook/dashbook.dart'; import 'package:sandbox/common/common.dart'; import 'package:sandbox/stories/effects/camera_zoom_game.dart'; -import 'package:sandbox/stories/effects/fire_effect_game.dart'; void addEffectsStories(Dashbook dashbook) { - dashbook.storiesOf('Effects') - ..addGame( - title: 'Fire', - description: FireEffectGame.description, - gameBuilder: (_) => FireEffectGame(), - ) - ..addGame( - title: 'CameraZoom', - description: CameraZoomGame.description, - gameBuilder: (_) => CameraZoomGame(), - ); + dashbook.storiesOf('Effects').addGame( + title: 'CameraZoom', + description: CameraZoomGame.description, + gameBuilder: (_) => CameraZoomGame(), + ); } diff --git a/packages/pinball_components/sandbox/lib/stories/flutter_forest/small_dash_nest_bumper_a_game.dart b/packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_a_game.dart similarity index 77% rename from packages/pinball_components/sandbox/lib/stories/flutter_forest/small_dash_nest_bumper_a_game.dart rename to packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_a_game.dart index 071f6aa1..d81540b0 100644 --- a/packages/pinball_components/sandbox/lib/stories/flutter_forest/small_dash_nest_bumper_a_game.dart +++ b/packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_a_game.dart @@ -4,8 +4,8 @@ import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:sandbox/stories/ball/basic_ball_game.dart'; -class SmallDashNestBumperAGame extends BallGame { - SmallDashNestBumperAGame() +class DashBumperAGame extends BallGame { + DashBumperAGame() : super( imagesFileNames: [ Assets.images.dash.bumper.a.active.keyName, @@ -14,7 +14,7 @@ class SmallDashNestBumperAGame extends BallGame { ); static const description = ''' - Shows how a SmallDashNestBumper ("a") is rendered. + Shows how the "a" DashBumper is rendered. - Activate the "trace" parameter to overlay the body. '''; @@ -24,7 +24,7 @@ class SmallDashNestBumperAGame extends BallGame { await super.onLoad(); camera.followVector2(Vector2.zero()); - await add(DashNestBumper.a()..priority = 1); + await add(DashBumper.a()..priority = 1); await traceAllBodies(); } } diff --git a/packages/pinball_components/sandbox/lib/stories/flutter_forest/small_dash_nest_bumper_b_game.dart b/packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_b_game.dart similarity index 77% rename from packages/pinball_components/sandbox/lib/stories/flutter_forest/small_dash_nest_bumper_b_game.dart rename to packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_b_game.dart index a47b9962..05664a3a 100644 --- a/packages/pinball_components/sandbox/lib/stories/flutter_forest/small_dash_nest_bumper_b_game.dart +++ b/packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_b_game.dart @@ -4,8 +4,8 @@ import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:sandbox/stories/ball/basic_ball_game.dart'; -class SmallDashNestBumperBGame extends BallGame { - SmallDashNestBumperBGame() +class DashBumperBGame extends BallGame { + DashBumperBGame() : super( imagesFileNames: [ Assets.images.dash.bumper.b.active.keyName, @@ -14,7 +14,7 @@ class SmallDashNestBumperBGame extends BallGame { ); static const description = ''' - Shows how a SmallDashNestBumper ("b") is rendered. + Shows how the "b" DashBumper is rendered. - Activate the "trace" parameter to overlay the body. '''; @@ -24,7 +24,7 @@ class SmallDashNestBumperBGame extends BallGame { await super.onLoad(); camera.followVector2(Vector2.zero()); - await add(DashNestBumper.b()..priority = 1); + await add(DashBumper.b()..priority = 1); await traceAllBodies(); } } diff --git a/packages/pinball_components/sandbox/lib/stories/flutter_forest/big_dash_nest_bumper_game.dart b/packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_main_game.dart similarity index 79% rename from packages/pinball_components/sandbox/lib/stories/flutter_forest/big_dash_nest_bumper_game.dart rename to packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_main_game.dart index 3580a175..6a927eb9 100644 --- a/packages/pinball_components/sandbox/lib/stories/flutter_forest/big_dash_nest_bumper_game.dart +++ b/packages/pinball_components/sandbox/lib/stories/flutter_forest/dash_bumper_main_game.dart @@ -4,8 +4,8 @@ import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:sandbox/stories/ball/basic_ball_game.dart'; -class BigDashNestBumperGame extends BallGame { - BigDashNestBumperGame() +class DashBumperMainGame extends BallGame { + DashBumperMainGame() : super( imagesFileNames: [ Assets.images.dash.bumper.main.active.keyName, @@ -14,7 +14,7 @@ class BigDashNestBumperGame extends BallGame { ); static const description = ''' - Shows how a BigDashNestBumper is rendered. + Shows how the "main" DashBumper is rendered. - Activate the "trace" parameter to overlay the body. '''; @@ -25,7 +25,7 @@ class BigDashNestBumperGame extends BallGame { camera.followVector2(Vector2.zero()); await add( - DashNestBumper.main()..priority = 1, + DashBumper.main()..priority = 1, ); await traceAllBodies(); } diff --git a/packages/pinball_components/sandbox/lib/stories/flutter_forest/stories.dart b/packages/pinball_components/sandbox/lib/stories/flutter_forest/stories.dart index dd557a27..fcd64f79 100644 --- a/packages/pinball_components/sandbox/lib/stories/flutter_forest/stories.dart +++ b/packages/pinball_components/sandbox/lib/stories/flutter_forest/stories.dart @@ -1,9 +1,9 @@ import 'package:dashbook/dashbook.dart'; import 'package:sandbox/common/common.dart'; -import 'package:sandbox/stories/flutter_forest/big_dash_nest_bumper_game.dart'; +import 'package:sandbox/stories/flutter_forest/dash_bumper_a_game.dart'; +import 'package:sandbox/stories/flutter_forest/dash_bumper_b_game.dart'; +import 'package:sandbox/stories/flutter_forest/dash_bumper_main_game.dart'; import 'package:sandbox/stories/flutter_forest/signpost_game.dart'; -import 'package:sandbox/stories/flutter_forest/small_dash_nest_bumper_a_game.dart'; -import 'package:sandbox/stories/flutter_forest/small_dash_nest_bumper_b_game.dart'; void addFlutterForestStories(Dashbook dashbook) { dashbook.storiesOf('Flutter Forest') @@ -13,18 +13,18 @@ void addFlutterForestStories(Dashbook dashbook) { gameBuilder: (_) => SignpostGame(), ) ..addGame( - title: 'Big Dash Nest Bumper', - description: BigDashNestBumperGame.description, - gameBuilder: (_) => BigDashNestBumperGame(), + title: 'Main Dash Bumper', + description: DashBumperMainGame.description, + gameBuilder: (_) => DashBumperMainGame(), ) ..addGame( - title: 'Small Dash Nest Bumper A', - description: SmallDashNestBumperAGame.description, - gameBuilder: (_) => SmallDashNestBumperAGame(), + title: 'Dash Bumper A', + description: DashBumperAGame.description, + gameBuilder: (_) => DashBumperAGame(), ) ..addGame( - title: 'Small Dash Nest Bumper B', - description: SmallDashNestBumperBGame.description, - gameBuilder: (_) => SmallDashNestBumperBGame(), + title: 'Dash Bumper B', + description: DashBumperBGame.description, + gameBuilder: (_) => DashBumperBGame(), ); } diff --git a/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart b/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart index fff69b0a..70edd32e 100644 --- a/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart +++ b/packages/pinball_components/test/src/components/android_spaceship/android_spaceship_test.dart @@ -1,7 +1,7 @@ // ignore_for_file: cascade_invocations -import 'package:bloc_test/bloc_test.dart'; import 'package:flame/components.dart'; +import 'package:flame_bloc/flame_bloc.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mocktail/mocktail.dart'; @@ -21,9 +21,18 @@ void main() { Assets.images.android.spaceship.lightBeam.keyName, ]; final flameTester = FlameTester(() => TestGame(assets)); + late AndroidSpaceshipCubit bloc; + + setUp(() { + bloc = _MockAndroidSpaceshipCubit(); + }); flameTester.test('loads correctly', (game) async { - final component = AndroidSpaceship(position: Vector2.zero()); + final component = + FlameBlocProvider.value( + value: bloc, + children: [AndroidSpaceship(position: Vector2.zero())], + ); await game.ensureAdd(component); expect(game.contains(component), isTrue); }); @@ -33,7 +42,13 @@ void main() { setUp: (game, tester) async { await game.images.loadAll(assets); final canvas = ZCanvasComponent( - children: [AndroidSpaceship(position: Vector2.zero())], + children: [ + FlameBlocProvider.value( + value: bloc, + children: [AndroidSpaceship(position: Vector2.zero())], + ), + ], ); await game.ensureAdd(canvas); game.camera.followVector2(Vector2.zero()); @@ -70,28 +85,16 @@ void main() { }, ); - flameTester.test('closes bloc when removed', (game) async { - final bloc = _MockAndroidSpaceshipCubit(); - whenListen( - bloc, - const Stream.empty(), - initialState: AndroidSpaceshipState.withoutBonus, - ); - when(bloc.close).thenAnswer((_) async {}); - final androidSpaceship = AndroidSpaceship.test(bloc: bloc); - - await game.ensureAdd(androidSpaceship); - game.remove(androidSpaceship); - await game.ready(); - - verify(bloc.close).called(1); - }); - flameTester.test( 'AndroidSpaceshipEntrance has an ' 'AndroidSpaceshipEntranceBallContactBehavior', (game) async { final androidSpaceship = AndroidSpaceship(position: Vector2.zero()); - await game.ensureAdd(androidSpaceship); + final provider = + FlameBlocProvider.value( + value: bloc, + children: [androidSpaceship], + ); + await game.ensureAdd(provider); final androidSpaceshipEntrance = androidSpaceship.firstChild(); diff --git a/packages/pinball_components/test/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior_test.dart b/packages/pinball_components/test/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior_test.dart index d6056beb..4b0f16ea 100644 --- a/packages/pinball_components/test/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior_test.dart +++ b/packages/pinball_components/test/src/components/android_spaceship/behaviors/android_spaceship_entrance_ball_contact_behavior_test.dart @@ -1,6 +1,7 @@ // ignore_for_file: cascade_invocations import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_bloc/flame_bloc.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -43,16 +44,19 @@ void main() { ); final entrance = AndroidSpaceshipEntrance(); - final androidSpaceship = AndroidSpaceship.test( - bloc: bloc, - children: [entrance], + final androidSpaceship = FlameBlocProvider.value( + value: bloc, + children: [ + AndroidSpaceship.test(children: [entrance]) + ], ); await entrance.add(behavior); await game.ensureAdd(androidSpaceship); behavior.beginContact(_MockBall(), _MockContact()); - verify(androidSpaceship.bloc.onBallEntered).called(1); + verify(bloc.onBallEntered).called(1); }, ); }, diff --git a/packages/pinball_components/test/src/components/ball/behaviors/ball_scaling_behavior_test.dart b/packages/pinball_components/test/src/components/ball/behaviors/ball_scaling_behavior_test.dart index c4c66d4a..1fe84ae4 100644 --- a/packages/pinball_components/test/src/components/ball/behaviors/ball_scaling_behavior_test.dart +++ b/packages/pinball_components/test/src/components/ball/behaviors/ball_scaling_behavior_test.dart @@ -10,8 +10,9 @@ import '../../../../helpers/helpers.dart'; void main() { TestWidgetsFlutterBinding.ensureInitialized(); - final asset = theme.Assets.images.dash.ball.keyName; - final flameTester = FlameTester(() => TestGame([asset])); + final flameTester = FlameTester( + () => TestGame([theme.Assets.images.dash.ball.keyName]), + ); group('BallScalingBehavior', () { test('can be instantiated', () { diff --git a/packages/pinball_components/test/src/components/bumping_behavior_test.dart b/packages/pinball_components/test/src/components/bumping_behavior_test.dart index dd0493f7..07e35cca 100644 --- a/packages/pinball_components/test/src/components/bumping_behavior_test.dart +++ b/packages/pinball_components/test/src/components/bumping_behavior_test.dart @@ -32,7 +32,7 @@ void main() { }); flameTester.testGameWidget( - 'the bump is greater when the strengh is greater', + 'the bump is greater when the strength is greater', setUp: (game, tester) async { final component1 = _TestBodyComponent(); final behavior1 = BumpingBehavior(strength: 1) 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_bumper_ball_contact_behavior_test.dart similarity index 55% rename from packages/pinball_components/test/src/components/dash_nest_bumper/behaviors/dash_nest_bumper_ball_contact_behavior_test.dart rename to packages/pinball_components/test/src/components/dash_nest_bumper/behaviors/dash_bumper_ball_contact_behavior_test.dart index 10627df6..3c8f51db 100644 --- 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_bumper_ball_contact_behavior_test.dart @@ -6,11 +6,11 @@ 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 'package:pinball_components/src/components/dash_bumper/behaviors/behaviors.dart'; import '../../../../helpers/helpers.dart'; -class _MockDashNestBumperCubit extends Mock implements DashNestBumperCubit {} +class _MockDashBumperCubit extends Mock implements DashBumperCubit {} class _MockBall extends Mock implements Ball {} @@ -21,33 +21,33 @@ void main() { final flameTester = FlameTester(TestGame.new); group( - 'DashNestBumperBallContactBehavior', + 'DashBumperBallContactBehavior', () { test('can be instantiated', () { expect( - DashNestBumperBallContactBehavior(), - isA(), + DashBumperBallContactBehavior(), + isA(), ); }); flameTester.test( 'beginContact emits onBallContacted when contacts with a ball', (game) async { - final behavior = DashNestBumperBallContactBehavior(); - final bloc = _MockDashNestBumperCubit(); + final behavior = DashBumperBallContactBehavior(); + final bloc = _MockDashBumperCubit(); whenListen( bloc, - const Stream.empty(), - initialState: DashNestBumperState.active, + const Stream.empty(), + initialState: DashBumperState.active, ); - final dashNestBumper = DashNestBumper.test(bloc: bloc); - await dashNestBumper.add(behavior); - await game.ensureAdd(dashNestBumper); + final bumper = DashBumper.test(bloc: bloc); + await bumper.add(behavior); + await game.ensureAdd(bumper); behavior.beginContact(_MockBall(), _MockContact()); - verify(dashNestBumper.bloc.onBallContacted).called(1); + verify(bumper.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_bumper_cubit_test.dart similarity index 53% rename from packages/pinball_components/test/src/components/dash_nest_bumper/cubit/dash_nest_bumper_cubit_test.dart rename to packages/pinball_components/test/src/components/dash_nest_bumper/cubit/dash_bumper_cubit_test.dart index 7e26bbf3..1b255cd5 100644 --- 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_bumper_cubit_test.dart @@ -4,20 +4,20 @@ import 'package:pinball_components/pinball_components.dart'; void main() { group( - 'DashNestBumperCubit', + 'DashBumperCubit', () { - blocTest( + blocTest( 'onBallContacted emits active', - build: DashNestBumperCubit.new, + build: DashBumperCubit.new, act: (bloc) => bloc.onBallContacted(), - expect: () => [DashNestBumperState.active], + expect: () => [DashBumperState.active], ); - blocTest( + blocTest( 'onReset emits inactive', - build: DashNestBumperCubit.new, + build: DashBumperCubit.new, act: (bloc) => bloc.onReset(), - expect: () => [DashNestBumperState.inactive], + expect: () => [DashBumperState.inactive], ); }, ); diff --git a/packages/pinball_components/test/src/components/dash_nest_bumper/dash_bumper_test.dart b/packages/pinball_components/test/src/components/dash_nest_bumper/dash_bumper_test.dart new file mode 100644 index 00000000..a8ad8410 --- /dev/null +++ b/packages/pinball_components/test/src/components/dash_nest_bumper/dash_bumper_test.dart @@ -0,0 +1,139 @@ +// 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/bumping_behavior.dart'; +import 'package:pinball_components/src/components/dash_bumper/behaviors/behaviors.dart'; + +import '../../../helpers/helpers.dart'; + +class _MockDashBumperCubit extends Mock implements DashBumperCubit {} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('DashBumper', () { + final flameTester = FlameTester( + () => TestGame( + [ + 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, + ], + ), + ); + + flameTester.test('"main" loads correctly', (game) async { + final bumper = DashBumper.main(); + await game.ensureAdd(bumper); + expect(game.contains(bumper), isTrue); + }); + + flameTester.test('"a" loads correctly', (game) async { + final bumper = DashBumper.a(); + await game.ensureAdd(bumper); + + expect(game.contains(bumper), isTrue); + }); + + flameTester.test('"b" loads correctly', (game) async { + final bumper = DashBumper.b(); + await game.ensureAdd(bumper); + expect(game.contains(bumper), isTrue); + }); + + // ignore: public_member_api_docs + flameTester.test('closes bloc when removed', (game) async { + final bloc = _MockDashBumperCubit(); + whenListen( + bloc, + const Stream.empty(), + initialState: DashBumperState.inactive, + ); + when(bloc.close).thenAnswer((_) async {}); + final bumper = DashBumper.test(bloc: bloc); + + await game.ensureAdd(bumper); + game.remove(bumper); + await game.ready(); + + verify(bloc.close).called(1); + }); + + flameTester.test('adds a bumperBallContactBehavior', (game) async { + final bumper = DashBumper.a(); + await game.ensureAdd(bumper); + expect( + bumper.children.whereType().single, + isNotNull, + ); + }); + + group("'main' adds", () { + flameTester.test('new children', (game) async { + final component = Component(); + final bumper = DashBumper.main( + children: [component], + ); + await game.ensureAdd(bumper); + expect(bumper.children, contains(component)); + }); + + flameTester.test('a BumpingBehavior', (game) async { + final bumper = DashBumper.main(); + await game.ensureAdd(bumper); + expect( + bumper.children.whereType().single, + isNotNull, + ); + }); + }); + + group("'a' adds", () { + flameTester.test('new children', (game) async { + final component = Component(); + final bumper = DashBumper.a( + children: [component], + ); + await game.ensureAdd(bumper); + expect(bumper.children, contains(component)); + }); + + flameTester.test('a BumpingBehavior', (game) async { + final bumper = DashBumper.a(); + await game.ensureAdd(bumper); + expect( + bumper.children.whereType().single, + isNotNull, + ); + }); + }); + + group("'b' adds", () { + flameTester.test('new children', (game) async { + final component = Component(); + final bumper = DashBumper.b( + children: [component], + ); + await game.ensureAdd(bumper); + expect(bumper.children, contains(component)); + }); + + flameTester.test('a BumpingBehavior', (game) async { + final bumper = DashBumper.b(); + await game.ensureAdd(bumper); + expect( + bumper.children.whereType().single, + isNotNull, + ); + }); + }); + }); +} 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 deleted file mode 100644 index baf2132f..00000000 --- a/packages/pinball_components/test/src/components/dash_nest_bumper/dash_nest_bumper_test.dart +++ /dev/null @@ -1,137 +0,0 @@ -// 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/bumping_behavior.dart'; -import 'package:pinball_components/src/components/dash_nest_bumper/behaviors/behaviors.dart'; - -import '../../../helpers/helpers.dart'; - -class _MockDashNestBumperCubit extends Mock implements DashNestBumperCubit {} - -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('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); - }); - - flameTester.test('adds a DashNestBumperBallContactBehavior', (game) async { - final dashNestBumper = DashNestBumper.a(); - await game.ensureAdd(dashNestBumper); - expect( - dashNestBumper.children - .whereType() - .single, - isNotNull, - ); - }); - - group("'main' adds", () { - flameTester.test('new children', (game) async { - final component = Component(); - final dashNestBumper = DashNestBumper.main( - children: [component], - ); - await game.ensureAdd(dashNestBumper); - expect(dashNestBumper.children, contains(component)); - }); - - flameTester.test('a BumpingBehavior', (game) async { - final dashNestBumper = DashNestBumper.main(); - await game.ensureAdd(dashNestBumper); - expect( - dashNestBumper.children.whereType().single, - isNotNull, - ); - }); - }); - - group("'a' adds", () { - flameTester.test('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 BumpingBehavior', (game) async { - final dashNestBumper = DashNestBumper.a(); - await game.ensureAdd(dashNestBumper); - expect( - dashNestBumper.children.whereType().single, - isNotNull, - ); - }); - }); - - group("'b' adds", () { - flameTester.test('new children', (game) async { - final component = Component(); - final dashNestBumper = DashNestBumper.b( - children: [component], - ); - await game.ensureAdd(dashNestBumper); - expect(dashNestBumper.children, contains(component)); - }); - - flameTester.test('a BumpingBehavior', (game) async { - final dashNestBumper = DashNestBumper.b(); - await game.ensureAdd(dashNestBumper); - expect( - dashNestBumper.children.whereType().single, - isNotNull, - ); - }); - }); - }); -} diff --git a/packages/pinball_components/test/src/components/fire_effect_test.dart b/packages/pinball_components/test/src/components/fire_effect_test.dart deleted file mode 100644 index 2c404747..00000000 --- a/packages/pinball_components/test/src/components/fire_effect_test.dart +++ /dev/null @@ -1,26 +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 flameTester = FlameTester(TestGame.new); - - flameTester.test( - 'loads correctly', - (game) async { - final fireEffect = FireEffect( - burstPower: 1, - direction: Vector2.zero(), - ); - await game.ensureAdd(fireEffect); - - expect(game.contains(fireEffect), isTrue); - }, - ); -} diff --git a/packages/pinball_components/test/src/components/flapper/flapper_test.dart b/packages/pinball_components/test/src/components/flapper/flapper_test.dart index 497bb5f6..c9be94f9 100644 --- a/packages/pinball_components/test/src/components/flapper/flapper_test.dart +++ b/packages/pinball_components/test/src/components/flapper/flapper_test.dart @@ -67,7 +67,7 @@ void main() { }, ); - flameTester.test('adds a FlapperSpiningBehavior to FlapperEntrance', + flameTester.test('adds a FlapperSpinningBehavior to FlapperEntrance', (game) async { final flapper = Flapper(); await game.ensureAdd(flapper); diff --git a/packages/pinball_components/test/src/components/golden/dino-walls.png b/packages/pinball_components/test/src/components/golden/dino-walls.png index 31b317c1..1a50449d 100644 Binary files a/packages/pinball_components/test/src/components/golden/dino-walls.png and b/packages/pinball_components/test/src/components/golden/dino-walls.png differ diff --git a/packages/pinball_components/test/src/components/initial_position_test.dart b/packages/pinball_components/test/src/components/initial_position_test.dart index 9f015150..b7495181 100644 --- a/packages/pinball_components/test/src/components/initial_position_test.dart +++ b/packages/pinball_components/test/src/components/initial_position_test.dart @@ -54,7 +54,7 @@ void main() { ); flameTester.test( - 'deafaults to zero ' + 'defaults to zero ' 'when no initialPosition is given', (game) async { final component = TestBodyComponent(); diff --git a/packages/pinball_components/test/src/components/plunger_test.dart b/packages/pinball_components/test/src/components/plunger_test.dart index ea1ba826..e28bdaed 100644 --- a/packages/pinball_components/test/src/components/plunger_test.dart +++ b/packages/pinball_components/test/src/components/plunger_test.dart @@ -329,7 +329,7 @@ void main() { ); flameTester.test( - 'connected body collison enabled', + 'connected body collision enabled', (game) async { await game.ensureAdd(plunger); await game.ensureAdd(anchor); diff --git a/packages/pinball_components/test/src/components/score_component/behaviors/score_component_scaling_behavior_test.dart b/packages/pinball_components/test/src/components/score_component/behaviors/score_component_scaling_behavior_test.dart new file mode 100644 index 00000000..9bf0db2f --- /dev/null +++ b/packages/pinball_components/test/src/components/score_component/behaviors/score_component_scaling_behavior_test.dart @@ -0,0 +1,74 @@ +// ignore_for_file: cascade_invocations + +import 'package:flame/components.dart'; +import 'package:flame/effects.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/score_component/behaviors/behaviors.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + group('ScoreComponentScalingBehavior', () { + TestWidgetsFlutterBinding.ensureInitialized(); + final flameTester = FlameTester( + () => TestGame([ + Assets.images.score.fiveThousand.keyName, + Assets.images.score.twentyThousand.keyName, + Assets.images.score.twoHundredThousand.keyName, + Assets.images.score.oneMillion.keyName, + ]), + ); + + test('can be instantiated', () { + expect( + ScoreComponentScalingBehavior(), + isA(), + ); + }); + + flameTester.test('can be loaded', (game) async { + final parent = ScoreComponent.test( + points: Points.fiveThousand, + position: Vector2.zero(), + effectController: EffectController(duration: 1), + ); + final behavior = ScoreComponentScalingBehavior(); + await game.ensureAdd(parent); + await parent.ensureAdd(behavior); + + expect(parent.children, contains(behavior)); + }); + + flameTester.test( + 'scales the sprite', + (game) async { + final parent1 = ScoreComponent.test( + points: Points.fiveThousand, + position: Vector2(0, 10), + effectController: EffectController(duration: 1), + ); + final parent2 = ScoreComponent.test( + points: Points.fiveThousand, + position: Vector2(0, -10), + effectController: EffectController(duration: 1), + ); + await game.ensureAddAll([parent1, parent2]); + + await parent1.ensureAdd(ScoreComponentScalingBehavior()); + await parent2.ensureAdd(ScoreComponentScalingBehavior()); + game.update(1); + + expect( + parent1.scale.x, + greaterThan(parent2.scale.x), + ); + expect( + parent1.scale.y, + greaterThan(parent2.scale.y), + ); + }, + ); + }); +} diff --git a/packages/pinball_components/test/src/components/score_component_test.dart b/packages/pinball_components/test/src/components/score_component/score_component_test.dart similarity index 72% rename from packages/pinball_components/test/src/components/score_component_test.dart rename to packages/pinball_components/test/src/components/score_component/score_component_test.dart index f2bd52e3..00c08d5c 100644 --- a/packages/pinball_components/test/src/components/score_component_test.dart +++ b/packages/pinball_components/test/src/components/score_component/score_component_test.dart @@ -5,24 +5,37 @@ import 'package:flame/effects.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_components/src/components/score_component/behaviors/behaviors.dart'; -import '../../helpers/helpers.dart'; +import '../../../helpers/helpers.dart'; void main() { TestWidgetsFlutterBinding.ensureInitialized(); - final assets = [ - Assets.images.score.fiveThousand.keyName, - Assets.images.score.twentyThousand.keyName, - Assets.images.score.twoHundredThousand.keyName, - Assets.images.score.oneMillion.keyName, - ]; - final flameTester = FlameTester(() => TestGame(assets)); + final flameTester = FlameTester( + () => TestGame([ + Assets.images.score.fiveThousand.keyName, + Assets.images.score.twentyThousand.keyName, + Assets.images.score.twoHundredThousand.keyName, + Assets.images.score.oneMillion.keyName, + ]), + ); group('ScoreComponent', () { + test('can be instantiated', () { + expect( + ScoreComponent( + points: Points.fiveThousand, + position: Vector2.zero(), + effectController: EffectController(duration: 1), + ), + isA(), + ); + }); + flameTester.testGameWidget( 'loads correctly', setUp: (game, tester) async { - await game.images.loadAll(assets); + await game.onLoad(); game.camera.followVector2(Vector2.zero()); await game.ensureAdd( ScoreComponent( @@ -38,13 +51,32 @@ void main() { }, ); + flameTester.test( + 'adds a ScoreComponentScalingBehavior', + (game) async { + await game.onLoad(); + game.camera.followVector2(Vector2.zero()); + final component = ScoreComponent( + points: Points.oneMillion, + position: Vector2.zero(), + effectController: EffectController(duration: 1), + ); + await game.ensureAdd(component); + + expect( + component.children.whereType().length, + equals(1), + ); + }, + ); + flameTester.testGameWidget( 'has a movement effect', setUp: (game, tester) async { - await game.images.loadAll(assets); + await game.onLoad(); game.camera.followVector2(Vector2.zero()); await game.ensureAdd( - ScoreComponent( + ScoreComponent.test( points: Points.oneMillion, position: Vector2.zero(), effectController: EffectController(duration: 1), @@ -63,10 +95,10 @@ void main() { flameTester.testGameWidget( 'is removed once finished', setUp: (game, tester) async { - await game.images.loadAll(assets); + await game.onLoad(); game.camera.followVector2(Vector2.zero()); await game.ensureAdd( - ScoreComponent( + ScoreComponent.test( points: Points.oneMillion, position: Vector2.zero(), effectController: EffectController(duration: 1), @@ -83,12 +115,14 @@ void main() { ); group('renders correctly', () { + const goldensPath = '../golden/score/'; + flameTester.testGameWidget( '5000 points', setUp: (game, tester) async { - await game.images.loadAll(assets); + await game.onLoad(); await game.ensureAdd( - ScoreComponent( + ScoreComponent.test( points: Points.fiveThousand, position: Vector2.zero(), effectController: EffectController(duration: 1), @@ -104,7 +138,7 @@ void main() { verify: (game, tester) async { await expectLater( find.byGame(), - matchesGoldenFile('golden/score/5k.png'), + matchesGoldenFile('${goldensPath}5k.png'), ); }, ); @@ -112,9 +146,9 @@ void main() { flameTester.testGameWidget( '20000 points', setUp: (game, tester) async { - await game.images.loadAll(assets); + await game.onLoad(); await game.ensureAdd( - ScoreComponent( + ScoreComponent.test( points: Points.twentyThousand, position: Vector2.zero(), effectController: EffectController(duration: 1), @@ -130,7 +164,7 @@ void main() { verify: (game, tester) async { await expectLater( find.byGame(), - matchesGoldenFile('golden/score/20k.png'), + matchesGoldenFile('${goldensPath}20k.png'), ); }, ); @@ -138,9 +172,9 @@ void main() { flameTester.testGameWidget( '200000 points', setUp: (game, tester) async { - await game.images.loadAll(assets); + await game.onLoad(); await game.ensureAdd( - ScoreComponent( + ScoreComponent.test( points: Points.twoHundredThousand, position: Vector2.zero(), effectController: EffectController(duration: 1), @@ -156,7 +190,7 @@ void main() { verify: (game, tester) async { await expectLater( find.byGame(), - matchesGoldenFile('golden/score/200k.png'), + matchesGoldenFile('${goldensPath}200k.png'), ); }, ); @@ -164,9 +198,9 @@ void main() { flameTester.testGameWidget( '1000000 points', setUp: (game, tester) async { - await game.images.loadAll(assets); + await game.onLoad(); await game.ensureAdd( - ScoreComponent( + ScoreComponent.test( points: Points.oneMillion, position: Vector2.zero(), effectController: EffectController(duration: 1), @@ -182,7 +216,7 @@ void main() { verify: (game, tester) async { await expectLater( find.byGame(), - matchesGoldenFile('golden/score/1m.png'), + matchesGoldenFile('${goldensPath}1m.png'), ); }, ); diff --git a/packages/pinball_components/test/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior_test.dart b/packages/pinball_components/test/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior_test.dart index ea37550a..d1f03ce7 100644 --- a/packages/pinball_components/test/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior_test.dart +++ b/packages/pinball_components/test/src/components/spaceship_ramp/behavior/ramp_ball_ascending_contact_behavior_test.dart @@ -67,16 +67,16 @@ void main() { initialState: const SpaceshipRampState.initial(), ); - final rampSensor = RampScoringSensor.test(); + final parent = SpaceshipRampBoardOpening.test(); final spaceshipRamp = SpaceshipRamp.test( bloc: bloc, ); when(() => body.linearVelocity).thenReturn(Vector2(0, -1)); - await spaceshipRamp.add(rampSensor); + await spaceshipRamp.add(parent); await game.ensureAddAll([spaceshipRamp, ball]); - await rampSensor.add(behavior); + await parent.add(behavior); behavior.beginContact(ball, _MockContact()); @@ -95,16 +95,16 @@ void main() { initialState: const SpaceshipRampState.initial(), ); - final rampSensor = RampScoringSensor.test(); + final parent = SpaceshipRampBoardOpening.test(); final spaceshipRamp = SpaceshipRamp.test( bloc: bloc, ); when(() => body.linearVelocity).thenReturn(Vector2(0, 1)); - await spaceshipRamp.add(rampSensor); + await spaceshipRamp.add(parent); await game.ensureAddAll([spaceshipRamp, ball]); - await rampSensor.add(behavior); + await parent.add(behavior); behavior.beginContact(ball, _MockContact()); diff --git a/packages/pinball_components/test/src/components/spaceship_ramp/spaceship_ramp_test.dart b/packages/pinball_components/test/src/components/spaceship_ramp/spaceship_ramp_test.dart index 7bd18aeb..1c9c968d 100644 --- a/packages/pinball_components/test/src/components/spaceship_ramp/spaceship_ramp_test.dart +++ b/packages/pinball_components/test/src/components/spaceship_ramp/spaceship_ramp_test.dart @@ -7,6 +7,7 @@ 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/spaceship_ramp/behavior/behavior.dart'; import 'package:pinball_flame/pinball_flame.dart'; import '../../../helpers/helpers.dart'; @@ -324,4 +325,29 @@ void main() { }, ); }); + + group('SpaceshipRampBoardOpening', () { + test('can be instantiated', () { + expect(SpaceshipRampBoardOpening(), isA()); + }); + + flameTester.test('can be loaded', (game) async { + final parent = SpaceshipRamp.test(bloc: _MockSpaceshipRampCubit()); + final component = SpaceshipRampBoardOpening(); + await game.ensureAdd(parent); + await parent.ensureAdd(component); + expect(parent.children, contains(component)); + }); + + flameTester.test('adds a RampBallAscendingContactBehavior', (game) async { + final parent = SpaceshipRamp.test(bloc: _MockSpaceshipRampCubit()); + final component = SpaceshipRampBoardOpening(); + await game.ensureAdd(parent); + await parent.ensureAdd(component); + expect( + component.children.whereType().length, + equals(1), + ); + }); + }); } diff --git a/packages/pinball_flame/lib/src/canvas/canvas_component.dart b/packages/pinball_flame/lib/src/canvas/canvas_component.dart index ca6e64d0..394b0852 100644 --- a/packages/pinball_flame/lib/src/canvas/canvas_component.dart +++ b/packages/pinball_flame/lib/src/canvas/canvas_component.dart @@ -12,7 +12,7 @@ typedef PaintFunction = void Function(Paint); /// {@template canvas_component} /// Allows listening before the rendering of [Sprite]s. /// -/// The existance of this class is to hack around the fact that Flame doesn't +/// The existence of this class is to hack around the fact that Flame doesn't /// provide a global way to modify the default [Paint] before rendering a /// [Sprite]. /// {@endtemplate} diff --git a/packages/pinball_flame/lib/src/keyboard_input_controller.dart b/packages/pinball_flame/lib/src/keyboard_input_controller.dart index 8249e599..b0d64ee6 100644 --- a/packages/pinball_flame/lib/src/keyboard_input_controller.dart +++ b/packages/pinball_flame/lib/src/keyboard_input_controller.dart @@ -1,4 +1,5 @@ import 'package:flame/components.dart'; +import 'package:flame/game.dart'; import 'package:flutter/services.dart'; /// The signature for a key handle function @@ -18,6 +19,17 @@ class KeyboardInputController extends Component with KeyboardHandler { final Map _keyUp; final Map _keyDown; + /// Trigger a virtual key up event. + bool onVirtualKeyUp(LogicalKeyboardKey key) { + final handler = _keyUp[key]; + + if (handler != null) { + return handler(); + } + + return true; + } + @override bool onKeyEvent(RawKeyEvent event, Set keysPressed) { final isUp = event is RawKeyUpEvent; @@ -32,3 +44,18 @@ class KeyboardInputController extends Component with KeyboardHandler { return true; } } + +/// Add the ability to virtually trigger key events to a [FlameGame]'s +/// [KeyboardInputController]. +extension VirtualKeyEvents on FlameGame { + /// Trigger a key up + void triggerVirtualKeyUp(LogicalKeyboardKey key) { + final keyControllers = descendants().whereType(); + + for (final controller in keyControllers) { + if (!controller.onVirtualKeyUp(key)) { + break; + } + } + } +} diff --git a/packages/pinball_flame/lib/src/pinball_forge2d_game.dart b/packages/pinball_flame/lib/src/pinball_forge2d_game.dart index 0013dd26..b98e78ae 100644 --- a/packages/pinball_flame/lib/src/pinball_forge2d_game.dart +++ b/packages/pinball_flame/lib/src/pinball_forge2d_game.dart @@ -4,7 +4,7 @@ import 'package:flame/game.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_forge2d/world_contact_listener.dart'; -// NOTE(wolfen): This should be removed when https://github.com/flame-engine/flame/pull/1597 is solved. +// NOTE: This should be removed when https://github.com/flame-engine/flame/pull/1597 is solved. /// {@template pinball_forge2d_game} /// A [Game] that uses the Forge2D physics engine. /// {@endtemplate} diff --git a/packages/pinball_flame/test/src/canvas/canvas_component_test.dart b/packages/pinball_flame/test/src/canvas/canvas_component_test.dart index 7bf7fd88..2ad45b6c 100644 --- a/packages/pinball_flame/test/src/canvas/canvas_component_test.dart +++ b/packages/pinball_flame/test/src/canvas/canvas_component_test.dart @@ -50,7 +50,7 @@ void main() { ); flameTester.testGameWidget( - 'calls onSpritePainted when paiting a sprite', + 'calls onSpritePainted when painting a sprite', setUp: (game, tester) async { final spriteComponent = _TestSpriteComponent(); diff --git a/packages/pinball_flame/test/src/component_controller_test.dart b/packages/pinball_flame/test/src/component_controller_test.dart index 0e08be92..addcf2b0 100644 --- a/packages/pinball_flame/test/src/component_controller_test.dart +++ b/packages/pinball_flame/test/src/component_controller_test.dart @@ -38,9 +38,9 @@ void main() { final component = Component(); final controller = TestComponentController(component); - final anotherComponet = Component(); + final anotherComponent = Component(); await expectLater( - () async => await anotherComponet.add(controller), + () async => await anotherComponent.add(controller), throwsAssertionError, ); }, diff --git a/packages/pinball_flame/test/src/keyboard_input_controller_test.dart b/packages/pinball_flame/test/src/keyboard_input_controller_test.dart index 7b554e8c..f3c783ad 100644 --- a/packages/pinball_flame/test/src/keyboard_input_controller_test.dart +++ b/packages/pinball_flame/test/src/keyboard_input_controller_test.dart @@ -1,11 +1,36 @@ // ignore_for_file: cascade_invocations, one_member_abstracts +import 'package:flame/game.dart'; +import 'package:flame_test/flame_test.dart'; import 'package:flutter/material.dart'; import 'package:flutter/services.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mocktail/mocktail.dart'; import 'package:pinball_flame/pinball_flame.dart'; +class _TestGame extends FlameGame { + bool pressed = false; + + @override + Future? onLoad() async { + await super.onLoad(); + + await add( + KeyboardInputController( + keyUp: { + LogicalKeyboardKey.enter: () { + pressed = true; + return true; + }, + LogicalKeyboardKey.escape: () { + return false; + }, + }, + ), + ); + } +} + abstract class _KeyCall { bool onCall(); } @@ -75,4 +100,15 @@ void main() { }, ); }); + group('VirtualKeyEvents', () { + final flameTester = FlameTester(_TestGame.new); + + group('onVirtualKeyUp', () { + flameTester.test('triggers the event', (game) async { + await game.ready(); + game.triggerVirtualKeyUp(LogicalKeyboardKey.enter); + expect(game.pressed, isTrue); + }); + }); + }); } diff --git a/packages/pinball_flame/test/src/pinball_forge2d_game_test.dart b/packages/pinball_flame/test/src/pinball_forge2d_game_test.dart index b8dc9fcc..2da32f0e 100644 --- a/packages/pinball_flame/test/src/pinball_forge2d_game_test.dart +++ b/packages/pinball_flame/test/src/pinball_forge2d_game_test.dart @@ -19,7 +19,7 @@ void main() { }); flameTester.test( - 'screenToFlameWorld throws UnimpelementedError', + 'screenToFlameWorld throws UnimplementedError', (game) async { expect( () => game.screenToFlameWorld(Vector2.zero()), @@ -29,7 +29,7 @@ void main() { ); flameTester.test( - 'screenToWorld throws UnimpelementedError', + 'screenToWorld throws UnimplementedError', (game) async { expect( () => game.screenToWorld(Vector2.zero()), @@ -39,7 +39,7 @@ void main() { ); flameTester.test( - 'worldToScreen throws UnimpelementedError', + 'worldToScreen throws UnimplementedError', (game) async { expect( () => game.worldToScreen(Vector2.zero()), diff --git a/packages/pinball_ui/assets/images/button/dpad_down.png b/packages/pinball_ui/assets/images/button/dpad_down.png new file mode 100644 index 00000000..11bbb26f Binary files /dev/null and b/packages/pinball_ui/assets/images/button/dpad_down.png differ diff --git a/packages/pinball_ui/assets/images/button/dpad_left.png b/packages/pinball_ui/assets/images/button/dpad_left.png new file mode 100644 index 00000000..943cacc4 Binary files /dev/null and b/packages/pinball_ui/assets/images/button/dpad_left.png differ diff --git a/packages/pinball_ui/assets/images/button/dpad_right.png b/packages/pinball_ui/assets/images/button/dpad_right.png new file mode 100644 index 00000000..724b9f3e Binary files /dev/null and b/packages/pinball_ui/assets/images/button/dpad_right.png differ diff --git a/packages/pinball_ui/assets/images/button/dpad_up.png b/packages/pinball_ui/assets/images/button/dpad_up.png new file mode 100644 index 00000000..d1175d57 Binary files /dev/null and b/packages/pinball_ui/assets/images/button/dpad_up.png differ diff --git a/packages/pinball_ui/lib/gen/assets.gen.dart b/packages/pinball_ui/lib/gen/assets.gen.dart index 8972e8e0..9b09b254 100644 --- a/packages/pinball_ui/lib/gen/assets.gen.dart +++ b/packages/pinball_ui/lib/gen/assets.gen.dart @@ -3,8 +3,6 @@ /// FlutterGen /// ***************************************************** -// ignore_for_file: directives_ordering,unnecessary_import - import 'package:flutter/widgets.dart'; class $AssetsImagesGen { @@ -17,7 +15,14 @@ class $AssetsImagesGen { class $AssetsImagesButtonGen { const $AssetsImagesButtonGen(); - /// File path: assets/images/button/pinball_button.png + AssetGenImage get dpadDown => + const AssetGenImage('assets/images/button/dpad_down.png'); + AssetGenImage get dpadLeft => + const AssetGenImage('assets/images/button/dpad_left.png'); + AssetGenImage get dpadRight => + const AssetGenImage('assets/images/button/dpad_right.png'); + AssetGenImage get dpadUp => + const AssetGenImage('assets/images/button/dpad_up.png'); AssetGenImage get pinballButton => const AssetGenImage('assets/images/button/pinball_button.png'); } @@ -25,7 +30,6 @@ class $AssetsImagesButtonGen { class $AssetsImagesDialogGen { const $AssetsImagesDialogGen(); - /// File path: assets/images/dialog/background.png AssetGenImage get background => const AssetGenImage('assets/images/dialog/background.png'); } diff --git a/packages/pinball_ui/lib/gen/fonts.gen.dart b/packages/pinball_ui/lib/gen/fonts.gen.dart index 5f77da16..b15f2dd0 100644 --- a/packages/pinball_ui/lib/gen/fonts.gen.dart +++ b/packages/pinball_ui/lib/gen/fonts.gen.dart @@ -3,14 +3,9 @@ /// FlutterGen /// ***************************************************** -// ignore_for_file: directives_ordering,unnecessary_import - class FontFamily { FontFamily._(); - /// Font family: PixeloidMono static const String pixeloidMono = 'PixeloidMono'; - - /// Font family: PixeloidSans static const String pixeloidSans = 'PixeloidSans'; } diff --git a/packages/pinball_ui/lib/src/widgets/animated_ellipsis_text.dart b/packages/pinball_ui/lib/src/widgets/animated_ellipsis_text.dart index 9b52d604..1c94cad7 100644 --- a/packages/pinball_ui/lib/src/widgets/animated_ellipsis_text.dart +++ b/packages/pinball_ui/lib/src/widgets/animated_ellipsis_text.dart @@ -2,7 +2,7 @@ import 'dart:async'; import 'package:flutter/material.dart'; -/// {@tempalte animated_ellipsis_text} +/// {@template animated_ellipsis_text} /// Every 500 milliseconds, it will add a new `.` at the end of the given /// [text]. Once 3 `.` have been added (e.g. `Loading...`), it will reset to /// zero ellipsis and start over again. diff --git a/packages/pinball_ui/lib/src/widgets/crt_background.dart b/packages/pinball_ui/lib/src/widgets/crt_background.dart index 202af1d3..6fcc22ee 100644 --- a/packages/pinball_ui/lib/src/widgets/crt_background.dart +++ b/packages/pinball_ui/lib/src/widgets/crt_background.dart @@ -2,7 +2,7 @@ import 'package:flutter/material.dart'; import 'package:pinball_ui/pinball_ui.dart'; /// {@template crt_background} -/// [BoxDecoration] that provides a CRT-like background efffect. +/// [BoxDecoration] that provides a CRT-like background effect. /// {@endtemplate} class CrtBackground extends BoxDecoration { /// {@macro crt_background} diff --git a/packages/pinball_ui/lib/src/widgets/pinball_dpad_button.dart b/packages/pinball_ui/lib/src/widgets/pinball_dpad_button.dart new file mode 100644 index 00000000..a0c3e653 --- /dev/null +++ b/packages/pinball_ui/lib/src/widgets/pinball_dpad_button.dart @@ -0,0 +1,66 @@ +import 'package:flutter/material.dart'; +import 'package:pinball_ui/gen/gen.dart'; +import 'package:pinball_ui/pinball_ui.dart'; + +/// Enum with all possible directions of a [PinballDpadButton]. +enum PinballDpadDirection { + /// Up + up, + + /// Down + down, + + /// Left + left, + + /// Right + right, +} + +extension _PinballDpadDirectionX on PinballDpadDirection { + String toAsset() { + switch (this) { + case PinballDpadDirection.up: + return Assets.images.button.dpadUp.keyName; + case PinballDpadDirection.down: + return Assets.images.button.dpadDown.keyName; + case PinballDpadDirection.left: + return Assets.images.button.dpadLeft.keyName; + case PinballDpadDirection.right: + return Assets.images.button.dpadRight.keyName; + } + } +} + +/// {@template pinball_dpad_button} +/// Widget that renders a Dpad button with a given direction. +/// {@endtemplate} +class PinballDpadButton extends StatelessWidget { + /// {@macro pinball_dpad_button} + const PinballDpadButton({ + Key? key, + required this.direction, + required this.onTap, + }) : super(key: key); + + /// Which [PinballDpadDirection] this button is. + final PinballDpadDirection direction; + + /// The function executed when the button is pressed. + final VoidCallback onTap; + + @override + Widget build(BuildContext context) { + return Material( + color: PinballColors.transparent, + child: InkWell( + onTap: onTap, + child: Image.asset( + direction.toAsset(), + width: 60, + height: 60, + ), + ), + ); + } +} diff --git a/packages/pinball_ui/lib/src/widgets/widgets.dart b/packages/pinball_ui/lib/src/widgets/widgets.dart index 3aa96c3e..45a6daad 100644 --- a/packages/pinball_ui/lib/src/widgets/widgets.dart +++ b/packages/pinball_ui/lib/src/widgets/widgets.dart @@ -1,4 +1,5 @@ export 'animated_ellipsis_text.dart'; export 'crt_background.dart'; export 'pinball_button.dart'; +export 'pinball_dpad_button.dart'; export 'pinball_loading_indicator.dart'; diff --git a/packages/pinball_ui/test/src/widgets/pinball_dpad_button_test.dart b/packages/pinball_ui/test/src/widgets/pinball_dpad_button_test.dart new file mode 100644 index 00000000..a7e89534 --- /dev/null +++ b/packages/pinball_ui/test/src/widgets/pinball_dpad_button_test.dart @@ -0,0 +1,122 @@ +// ignore_for_file: one_member_abstracts + +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_ui/gen/gen.dart'; +import 'package:pinball_ui/pinball_ui.dart'; + +extension _WidgetTesterX on WidgetTester { + Future pumpButton({ + required PinballDpadDirection direction, + required VoidCallback onTap, + }) async { + await pumpWidget( + MaterialApp( + home: Scaffold( + body: PinballDpadButton( + direction: direction, + onTap: onTap, + ), + ), + ), + ); + } +} + +extension _CommonFindersX on CommonFinders { + Finder byImagePath(String path) { + return find.byWidgetPredicate( + (widget) { + if (widget is Image) { + final image = widget.image; + + if (image is AssetImage) { + return image.keyName == path; + } + return false; + } + + return false; + }, + ); + } +} + +abstract class _VoidCallbackStubBase { + void onCall(); +} + +class _VoidCallbackStub extends Mock implements _VoidCallbackStubBase {} + +void main() { + group('PinballDpadButton', () { + testWidgets('can be tapped', (tester) async { + final stub = _VoidCallbackStub(); + await tester.pumpButton( + direction: PinballDpadDirection.up, + onTap: stub.onCall, + ); + + await tester.tap(find.byType(Image)); + + verify(stub.onCall).called(1); + }); + + group('up', () { + testWidgets('renders the correct image', (tester) async { + await tester.pumpButton( + direction: PinballDpadDirection.up, + onTap: () {}, + ); + + expect( + find.byImagePath(Assets.images.button.dpadUp.keyName), + findsOneWidget, + ); + }); + }); + + group('down', () { + testWidgets('renders the correct image', (tester) async { + await tester.pumpButton( + direction: PinballDpadDirection.down, + onTap: () {}, + ); + + expect( + find.byImagePath(Assets.images.button.dpadDown.keyName), + findsOneWidget, + ); + }); + }); + + group('left', () { + testWidgets('renders the correct image', (tester) async { + await tester.pumpButton( + direction: PinballDpadDirection.left, + onTap: () {}, + ); + + expect( + find.byImagePath(Assets.images.button.dpadLeft.keyName), + findsOneWidget, + ); + }); + }); + + group('right', () { + testWidgets('renders the correct image', (tester) async { + await tester.pumpButton( + direction: PinballDpadDirection.right, + onTap: () {}, + ); + + expect( + find.byImagePath(Assets.images.button.dpadRight.keyName), + findsOneWidget, + ); + }); + }); + }); +} diff --git a/packages/platform_helper/test/src/platform_helper_test.dart b/packages/platform_helper/test/src/platform_helper_test.dart index 69bec3a8..935bf082 100644 --- a/packages/platform_helper/test/src/platform_helper_test.dart +++ b/packages/platform_helper/test/src/platform_helper_test.dart @@ -27,7 +27,7 @@ void main() { }); test( - 'returns false when defaultTargetPlatform is niether iOS nor android', + 'returns false when defaultTargetPlatform is neither iOS nor android', () async { debugDefaultTargetPlatformOverride = TargetPlatform.macOS; expect(PlatformHelper().isMobile, isFalse); diff --git a/packages/share_repository/lib/src/share_repository.dart b/packages/share_repository/lib/src/share_repository.dart index 6e6679c2..e01f5746 100644 --- a/packages/share_repository/lib/src/share_repository.dart +++ b/packages/share_repository/lib/src/share_repository.dart @@ -11,6 +11,12 @@ class ShareRepository { final String _appUrl; + /// Url to the Github Open Source Pinball project. + static const openSourceCode = 'https://github.com/VGVentures/pinball'; + + /// Url to the Google IO Event. + static const googleIOEvent = 'https://events.google.com/io/'; + /// Returns a url to share the [value] on the given [platform]. /// /// The returned url can be opened using the [url_launcher](https://pub.dev/packages/url_launcher) package. diff --git a/pubspec.lock b/pubspec.lock index 83de1390..7199435a 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -576,6 +576,13 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "2.1.1" + share_repository: + dependency: "direct main" + description: + path: "packages/share_repository" + relative: true + source: path + version: "1.0.0+1" shelf: dependency: transitive description: @@ -694,7 +701,7 @@ packages: source: hosted version: "1.3.0" url_launcher: - dependency: transitive + dependency: "direct main" description: name: url_launcher url: "https://pub.dartlang.org" diff --git a/pubspec.yaml b/pubspec.yaml index 1a025d4a..1b71a25f 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -44,6 +44,9 @@ dependencies: path: packages/pinball_ui platform_helper: path: packages/platform_helper + share_repository: + path: packages/share_repository + url_launcher: ^6.1.0 dev_dependencies: bloc_test: ^9.0.2 @@ -62,6 +65,7 @@ flutter: - assets/images/bonus_animation/ - assets/images/score/ - assets/images/link_box/ + - assets/images/loading_game/ flutter_gen: line_length: 80 diff --git a/test/app/view/app_test.dart b/test/app/view/app_test.dart index 4f04a89d..4612641d 100644 --- a/test/app/view/app_test.dart +++ b/test/app/view/app_test.dart @@ -9,7 +9,7 @@ import 'package:pinball_audio/pinball_audio.dart'; class _MockAuthenticationRepository extends Mock implements AuthenticationRepository {} -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} class _MockLeaderboardRepository extends Mock implements LeaderboardRepository { } @@ -18,13 +18,13 @@ void main() { group('App', () { late AuthenticationRepository authenticationRepository; late LeaderboardRepository leaderboardRepository; - late PinballPlayer pinballPlayer; + late PinballAudioPlayer pinballAudioPlayer; setUp(() { authenticationRepository = _MockAuthenticationRepository(); leaderboardRepository = _MockLeaderboardRepository(); - pinballPlayer = _MockPinballPlayer(); - when(pinballPlayer.load).thenAnswer((_) => [Future.value()]); + pinballAudioPlayer = _MockPinballAudioPlayer(); + when(pinballAudioPlayer.load).thenAnswer((_) => [Future.value()]); }); testWidgets('renders PinballGamePage', (tester) async { @@ -32,9 +32,10 @@ void main() { App( authenticationRepository: authenticationRepository, leaderboardRepository: leaderboardRepository, - pinballPlayer: pinballPlayer, + pinballAudioPlayer: pinballAudioPlayer, ), ); + await tester.pump(const Duration(milliseconds: 400)); expect(find.byType(PinballGamePage), findsOneWidget); }); }); diff --git a/test/assets_manager/cubit/assets_manager_cubit_test.dart b/test/assets_manager/cubit/assets_manager_cubit_test.dart deleted file mode 100644 index 27d9cedb..00000000 --- a/test/assets_manager/cubit/assets_manager_cubit_test.dart +++ /dev/null @@ -1,35 +0,0 @@ -import 'dart:async'; - -import 'package:bloc_test/bloc_test.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:pinball/assets_manager/assets_manager.dart'; - -void main() { - group('AssetsManagerCubit', () { - final completer1 = Completer(); - final completer2 = Completer(); - - final future1 = completer1.future; - final future2 = completer2.future; - - blocTest( - 'emits the loaded on the order that they load', - build: () => AssetsManagerCubit([future1, future2]), - act: (cubit) { - cubit.load(); - completer2.complete(); - completer1.complete(); - }, - expect: () => [ - AssetsManagerState( - loadables: [future1, future2], - loaded: [future2], - ), - AssetsManagerState( - loadables: [future1, future2], - loaded: [future2, future1], - ), - ], - ); - }); -} diff --git a/test/assets_manager/cubit/assets_manager_state_test.dart b/test/assets_manager/cubit/assets_manager_state_test.dart index 4882f880..41e94add 100644 --- a/test/assets_manager/cubit/assets_manager_state_test.dart +++ b/test/assets_manager/cubit/assets_manager_state_test.dart @@ -13,12 +13,11 @@ void main() { }); test('has the correct initial state', () { - final future = Future.value(); expect( - AssetsManagerState.initial(loadables: [future]), + AssetsManagerState.initial(), equals( AssetsManagerState( - loadables: [future], + loadables: const [], loaded: const [], ), ), diff --git a/test/game/behaviors/bonus_noise_behavior_test.dart b/test/game/behaviors/bonus_noise_behavior_test.dart index 12f62545..b67659c0 100644 --- a/test/game/behaviors/bonus_noise_behavior_test.dart +++ b/test/game/behaviors/bonus_noise_behavior_test.dart @@ -14,15 +14,15 @@ import 'package:pinball_flame/pinball_flame.dart'; class _TestGame extends Forge2DGame { Future pump( BonusNoiseBehavior child, { - required PinballPlayer player, + required PinballAudioPlayer audioPlayer, required GameBloc bloc, }) { return ensureAdd( FlameBlocProvider.value( value: bloc, children: [ - FlameProvider.value( - player, + FlameProvider.value( + audioPlayer, children: [ child, ], @@ -33,7 +33,7 @@ class _TestGame extends Forge2DGame { } } -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} class _MockGameBloc extends Mock implements GameBloc {} @@ -41,7 +41,7 @@ void main() { TestWidgetsFlutterBinding.ensureInitialized(); group('BonusNoiseBehavior', () { - late PinballPlayer player; + late PinballAudioPlayer audioPlayer; late GameBloc bloc; final flameTester = FlameTester(_TestGame.new); @@ -50,8 +50,8 @@ void main() { }); setUp(() { - player = _MockPinballPlayer(); - when(() => player.play(any())).thenAnswer((_) {}); + audioPlayer = _MockPinballAudioPlayer(); + when(() => audioPlayer.play(any())).thenAnswer((_) {}); bloc = _MockGameBloc(); }); @@ -73,10 +73,10 @@ void main() { initialState: initialState, ); final behavior = BonusNoiseBehavior(); - await game.pump(behavior, player: player, bloc: bloc); + await game.pump(behavior, audioPlayer: audioPlayer, bloc: bloc); }, verify: (_, __) async { - verify(() => player.play(PinballAudio.google)).called(1); + verify(() => audioPlayer.play(PinballAudio.google)).called(1); }, ); @@ -98,10 +98,10 @@ void main() { initialState: initialState, ); final behavior = BonusNoiseBehavior(); - await game.pump(behavior, player: player, bloc: bloc); + await game.pump(behavior, audioPlayer: audioPlayer, bloc: bloc); }, verify: (_, __) async { - verify(() => player.play(PinballAudio.sparky)).called(1); + verify(() => audioPlayer.play(PinballAudio.sparky)).called(1); }, ); @@ -123,10 +123,10 @@ void main() { initialState: initialState, ); final behavior = BonusNoiseBehavior(); - await game.pump(behavior, player: player, bloc: bloc); + await game.pump(behavior, audioPlayer: audioPlayer, bloc: bloc); }, verify: (_, __) async { - verifyNever(() => player.play(any())); + verify(() => audioPlayer.play(PinballAudio.dino)).called(1); }, ); @@ -148,10 +148,10 @@ void main() { initialState: initialState, ); final behavior = BonusNoiseBehavior(); - await game.pump(behavior, player: player, bloc: bloc); + await game.pump(behavior, audioPlayer: audioPlayer, bloc: bloc); }, verify: (_, __) async { - verifyNever(() => player.play(any())); + verify(() => audioPlayer.play(PinballAudio.android)).called(1); }, ); @@ -173,10 +173,10 @@ void main() { initialState: initialState, ); final behavior = BonusNoiseBehavior(); - await game.pump(behavior, player: player, bloc: bloc); + await game.pump(behavior, audioPlayer: audioPlayer, bloc: bloc); }, verify: (_, __) async { - verifyNever(() => player.play(any())); + verify(() => audioPlayer.play(PinballAudio.dash)).called(1); }, ); }); diff --git a/test/game/behaviors/bumper_noise_behavior_test.dart b/test/game/behaviors/bumper_noise_behavior_test.dart index d8075726..636da6ad 100644 --- a/test/game/behaviors/bumper_noise_behavior_test.dart +++ b/test/game/behaviors/bumper_noise_behavior_test.dart @@ -9,10 +9,13 @@ import 'package:pinball_audio/pinball_audio.dart'; import 'package:pinball_flame/pinball_flame.dart'; class _TestGame extends Forge2DGame { - Future pump(_TestBodyComponent child, {required PinballPlayer player}) { + Future pump( + _TestBodyComponent child, { + required PinballAudioPlayer audioPlayer, + }) { return ensureAdd( - FlameProvider.value( - player, + FlameProvider.value( + audioPlayer, children: [ child, ], @@ -26,7 +29,7 @@ class _TestBodyComponent extends BodyComponent { Body createBody() => world.createBody(BodyDef()); } -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} class _MockContact extends Mock implements Contact {} @@ -35,11 +38,11 @@ void main() { group('BumperNoiseBehavior', () {}); - late PinballPlayer player; + late PinballAudioPlayer audioPlayer; final flameTester = FlameTester(_TestGame.new); setUp(() { - player = _MockPinballPlayer(); + audioPlayer = _MockPinballAudioPlayer(); }); flameTester.testGameWidget( @@ -47,12 +50,12 @@ void main() { setUp: (game, _) async { final behavior = BumperNoiseBehavior(); final parent = _TestBodyComponent(); - await game.pump(parent, player: player); + await game.pump(parent, audioPlayer: audioPlayer); await parent.ensureAdd(behavior); behavior.beginContact(Object(), _MockContact()); }, verify: (_, __) async { - verify(() => player.play(PinballAudio.bumper)).called(1); + verify(() => audioPlayer.play(PinballAudio.bumper)).called(1); }, ); } diff --git a/test/game/bloc/game_bloc_test.dart b/test/game/bloc/game_bloc_test.dart index 3e5abb74..9e8c6354 100644 --- a/test/game/bloc/game_bloc_test.dart +++ b/test/game/bloc/game_bloc_test.dart @@ -279,21 +279,5 @@ void main() { ); }, ); - - group('SparkyTurboChargeActivated', () { - blocTest( - 'adds game bonus', - build: GameBloc.new, - act: (bloc) => bloc..add(const SparkyTurboChargeActivated()), - expect: () => [ - isA() - ..having( - (state) => state.bonusHistory, - 'bonusHistory', - [GameBonus.sparkyTurboCharge], - ), - ], - ); - }); }); } diff --git a/test/game/bloc/game_event_test.dart b/test/game/bloc/game_event_test.dart index c4de5792..68e6a2e7 100644 --- a/test/game/bloc/game_event_test.dart +++ b/test/game/bloc/game_event_test.dart @@ -97,17 +97,4 @@ void main() { ); }); }); - - group('SparkyTurboChargeActivated', () { - test('can be instantiated', () { - expect(const SparkyTurboChargeActivated(), isNotNull); - }); - - test('supports value equality', () { - expect( - SparkyTurboChargeActivated(), - equals(SparkyTurboChargeActivated()), - ); - }); - }); } diff --git a/test/game/components/android_acres/android_acres_test.dart b/test/game/components/android_acres/android_acres_test.dart index a38dce64..cbb21f33 100644 --- a/test/game/components/android_acres/android_acres_test.dart +++ b/test/game/components/android_acres/android_acres_test.dart @@ -131,11 +131,28 @@ void main() { ); }); + flameTester.test('adds a FlameBlocProvider', (game) async { + final androidAcres = AndroidAcres(); + await game.pump(androidAcres); + expect( + androidAcres.children + .whereType< + FlameBlocProvider>() + .single, + isNotNull, + ); + }); + flameTester.test('adds an AndroidSpaceshipBonusBehavior', (game) async { final androidAcres = AndroidAcres(); await game.pump(androidAcres); + final provider = androidAcres.children + .whereType< + FlameBlocProvider>() + .single; expect( - androidAcres.children.whereType().single, + provider.children.whereType().single, isNotNull, ); }); diff --git a/test/game/components/android_acres/behaviors/android_spaceship_bonus_behavior_test.dart b/test/game/components/android_acres/behaviors/android_spaceship_bonus_behavior_test.dart index e6b03c5f..e8ef68f8 100644 --- a/test/game/components/android_acres/behaviors/android_spaceship_bonus_behavior_test.dart +++ b/test/game/components/android_acres/behaviors/android_spaceship_bonus_behavior_test.dart @@ -1,5 +1,8 @@ // ignore_for_file: cascade_invocations +import 'dart:async'; + +import 'package:bloc_test/bloc_test.dart'; import 'package:flame_bloc/flame_bloc.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_test/flame_test.dart'; @@ -41,13 +44,21 @@ class _TestGame extends Forge2DGame { Future pump( AndroidAcres child, { required GameBloc gameBloc, + required AndroidSpaceshipCubit androidSpaceshipCubit, }) async { // Not needed once https://github.com/flame-engine/flame/issues/1607 // is fixed await onLoad(); await ensureAdd( - FlameBlocProvider.value( - value: gameBloc, + FlameMultiBlocProvider( + providers: [ + FlameBlocProvider.value( + value: gameBloc, + ), + FlameBlocProvider.value( + value: androidSpaceshipCubit, + ), + ], children: [child], ), ); @@ -56,6 +67,9 @@ class _TestGame extends Forge2DGame { class _MockGameBloc extends Mock implements GameBloc {} +class _MockAndroidSpaceshipCubit extends Mock implements AndroidSpaceshipCubit { +} + void main() { TestWidgetsFlutterBinding.ensureInitialized(); @@ -70,20 +84,30 @@ void main() { flameTester.testGameWidget( 'adds GameBonus.androidSpaceship to the game ' - 'when android spacehship has a bonus', + 'when android spaceship has a bonus', setUp: (game, tester) async { final behavior = AndroidSpaceshipBonusBehavior(); final parent = AndroidAcres.test(); final androidSpaceship = AndroidSpaceship(position: Vector2.zero()); + final androidSpaceshipCubit = _MockAndroidSpaceshipCubit(); + final streamController = StreamController(); + + whenListen( + androidSpaceshipCubit, + streamController.stream, + initialState: AndroidSpaceshipState.withoutBonus, + ); await parent.add(androidSpaceship); await game.pump( parent, + androidSpaceshipCubit: androidSpaceshipCubit, gameBloc: gameBloc, ); await parent.ensureAdd(behavior); - androidSpaceship.bloc.onBallEntered(); + streamController.add(AndroidSpaceshipState.withBonus); + await tester.pump(); verify( diff --git a/test/game/components/backbox/backbox_test.dart b/test/game/components/backbox/backbox_test.dart index d61bd83a..65474cd2 100644 --- a/test/game/components/backbox/backbox_test.dart +++ b/test/game/components/backbox/backbox_test.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:bloc_test/bloc_test.dart'; +import 'package:flame/game.dart'; import 'package:flame/input.dart'; import 'package:flame_bloc/flame_bloc.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; @@ -19,8 +20,10 @@ import 'package:pinball/l10n/l10n.dart'; import 'package:pinball_components/pinball_components.dart'; import 'package:pinball_flame/pinball_flame.dart'; import 'package:pinball_theme/pinball_theme.dart' as theme; +import 'package:platform_helper/platform_helper.dart'; -class _TestGame extends Forge2DGame with HasKeyboardHandlerComponents { +class _TestGame extends Forge2DGame + with HasKeyboardHandlerComponents, HasTappables { final character = theme.DashTheme(); @override @@ -33,6 +36,7 @@ class _TestGame extends Forge2DGame with HasKeyboardHandlerComponents { character.leaderboardIcon.keyName, Assets.images.backbox.marquee.keyName, Assets.images.backbox.displayDivider.keyName, + Assets.images.backbox.displayTitleDecoration.keyName, ]); } @@ -64,11 +68,15 @@ RawKeyUpEvent _mockKeyUp(LogicalKeyboardKey key) { return event; } +class _MockPlatformHelper extends Mock implements PlatformHelper {} + class _MockBackboxBloc extends Mock implements BackboxBloc {} class _MockLeaderboardRepository extends Mock implements LeaderboardRepository { } +class _MockTapDownInfo extends Mock implements TapDownInfo {} + class _MockAppLocalizations extends Mock implements AppLocalizations { @override String get score => ''; @@ -96,6 +104,36 @@ class _MockAppLocalizations extends Mock implements AppLocalizations { @override String get loading => ''; + + @override + String get shareYourScore => ''; + + @override + String get andChallengeYourFriends => ''; + + @override + String get share => ''; + + @override + String get gotoIO => ''; + + @override + String get learnMore => ''; + + @override + String get firebaseOr => ''; + + @override + String get openSourceCode => ''; + + @override + String get initialsErrorTitle => ''; + + @override + String get initialsErrorMessage => ''; + + @override + String get leaderboardErrorMessage => ''; } void main() { @@ -104,36 +142,32 @@ void main() { final flameTester = FlameTester(_TestGame.new); late BackboxBloc bloc; + late PlatformHelper platformHelper; setUp(() { bloc = _MockBackboxBloc(); + platformHelper = _MockPlatformHelper(); whenListen( bloc, Stream.empty(), initialState: LoadingState(), ); + when(() => platformHelper.isMobile).thenReturn(false); }); group('Backbox', () { flameTester.test( 'loads correctly', (game) async { - final backbox = Backbox.test(bloc: bloc); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); await game.pump(backbox); expect(game.descendants(), contains(backbox)); }, ); - flameTester.test( - 'adds LeaderboardRequested when loaded', - (game) async { - final backbox = Backbox.test(bloc: bloc); - await game.pump(backbox); - - verify(() => bloc.add(LeaderboardRequested())).called(1); - }, - ); - flameTester.testGameWidget( 'renders correctly', setUp: (game, tester) async { @@ -142,7 +176,10 @@ void main() { ..followVector2(Vector2(0, -130)) ..zoom = 6; await game.pump( - Backbox.test(bloc: bloc), + Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ), ); await tester.pump(); }, @@ -160,7 +197,9 @@ void main() { final backbox = Backbox.test( bloc: BackboxBloc( leaderboardRepository: _MockLeaderboardRepository(), + initialEntries: [LeaderboardEntryData.empty], ), + platformHelper: platformHelper, ); await game.pump(backbox); backbox.requestInitials( @@ -189,7 +228,10 @@ void main() { Stream.empty(), initialState: state, ); - final backbox = Backbox.test(bloc: bloc); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); await game.pump(backbox); game.onKeyEvent(_mockKeyUp(LogicalKeyboardKey.enter), {}); @@ -206,35 +248,119 @@ void main() { ); flameTester.test( - 'adds InitialsSubmissionSuccessDisplay on InitialsSuccessState', + 'adds GameOverInfoDisplay when InitialsSuccessState', + (game) async { + final state = InitialsSuccessState(score: 100); + whenListen( + bloc, + const Stream.empty(), + initialState: state, + ); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); + await game.pump(backbox); + + expect( + game.descendants().whereType().length, + equals(1), + ); + }, + ); + + flameTester.test( + 'adds the mobile controls overlay when platform is mobile', (game) async { + final bloc = _MockBackboxBloc(); + final platformHelper = _MockPlatformHelper(); + final state = InitialsFormState( + score: 10, + character: game.character, + ); whenListen( bloc, Stream.empty(), - initialState: InitialsSuccessState(), + initialState: state, + ); + when(() => platformHelper.isMobile).thenReturn(true); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, ); - final backbox = Backbox.test(bloc: bloc); await game.pump(backbox); expect( - game - .descendants() - .whereType() - .length, + game.overlays.value, + contains(PinballGame.mobileControlsOverlay), + ); + }, + ); + + flameTester.test( + 'adds InitialsSubmissionSuccessDisplay on InitialsSuccessState', + (game) async { + final state = InitialsSuccessState(score: 100); + whenListen( + bloc, + const Stream.empty(), + initialState: state, + ); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); + await game.pump(backbox); + + expect( + game.descendants().whereType().length, equals(1), ); }, ); + flameTester.test( + 'adds ShareScoreRequested event when sharing', + (game) async { + final state = InitialsSuccessState(score: 100); + whenListen( + bloc, + Stream.value(state), + initialState: state, + ); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); + await game.pump(backbox); + + final shareLink = + game.descendants().whereType().first; + shareLink.onTapDown(_MockTapDownInfo()); + + verify( + () => bloc.add( + ShareScoreRequested(score: state.score), + ), + ).called(1); + }, + ); + flameTester.test( 'adds InitialsSubmissionFailureDisplay on InitialsFailureState', (game) async { whenListen( bloc, Stream.empty(), - initialState: InitialsFailureState(), + initialState: InitialsFailureState( + score: 0, + character: theme.DashTheme(), + ), + ); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, ); - final backbox = Backbox.test(bloc: bloc); await game.pump(backbox); expect( @@ -256,7 +382,10 @@ void main() { initialState: LeaderboardSuccessState(entries: const []), ); - final backbox = Backbox.test(bloc: bloc); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); await game.pump(backbox); expect( @@ -266,6 +395,28 @@ void main() { }, ); + flameTester.test( + 'adds LeaderboardFailureDisplay on LeaderboardFailureState', + (game) async { + whenListen( + bloc, + Stream.empty(), + initialState: LeaderboardFailureState(), + ); + + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); + await game.pump(backbox); + + expect( + game.descendants().whereType().length, + equals(1), + ); + }, + ); + flameTester.test( 'closes the subscription when it is removed', (game) async { @@ -276,13 +427,21 @@ void main() { initialState: LoadingState(), ); - final backbox = Backbox.test(bloc: bloc); + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); await game.pump(backbox); backbox.removeFromParent(); await game.ready(); - streamController.add(InitialsFailureState()); + streamController.add( + InitialsFailureState( + score: 10, + character: theme.DashTheme(), + ), + ); await game.ready(); expect( @@ -294,5 +453,36 @@ void main() { ); }, ); + + flameTester.test( + 'adds PlayerInitialsSubmitted when the timer is finished', + (game) async { + final initialState = InitialsFailureState( + score: 10, + character: theme.DashTheme(), + ); + whenListen( + bloc, + Stream.fromIterable([]), + initialState: initialState, + ); + + final backbox = Backbox.test( + bloc: bloc, + platformHelper: platformHelper, + ); + await game.pump(backbox); + game.update(4); + + verify( + () => bloc.add( + PlayerInitialsRequested( + score: 10, + character: theme.DashTheme(), + ), + ), + ).called(1); + }, + ); }); } diff --git a/test/game/components/backbox/bloc/backbox_bloc_test.dart b/test/game/components/backbox/bloc/backbox_bloc_test.dart index 3958adb5..aec46186 100644 --- a/test/game/components/backbox/bloc/backbox_bloc_test.dart +++ b/test/game/components/backbox/bloc/backbox_bloc_test.dart @@ -12,14 +12,37 @@ class _MockLeaderboardRepository extends Mock implements LeaderboardRepository { void main() { late LeaderboardRepository leaderboardRepository; + const emptyEntries = []; + const filledEntries = [LeaderboardEntryData.empty]; group('BackboxBloc', () { + test('inits state with LeaderboardSuccessState when has entries', () { + leaderboardRepository = _MockLeaderboardRepository(); + final bloc = BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: filledEntries, + ); + expect(bloc.state, isA()); + }); + + test('inits state with LeaderboardFailureState when has no entries', () { + leaderboardRepository = _MockLeaderboardRepository(); + final bloc = BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: null, + ); + expect(bloc.state, isA()); + }); + blocTest( 'adds InitialsFormState on PlayerInitialsRequested', setUp: () { leaderboardRepository = _MockLeaderboardRepository(); }, - build: () => BackboxBloc(leaderboardRepository: leaderboardRepository), + build: () => BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: emptyEntries, + ), act: (bloc) => bloc.add( PlayerInitialsRequested( score: 100, @@ -46,7 +69,10 @@ void main() { ), ).thenAnswer((_) async {}); }, - build: () => BackboxBloc(leaderboardRepository: leaderboardRepository), + build: () => BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: emptyEntries, + ), act: (bloc) => bloc.add( PlayerInitialsSubmitted( score: 10, @@ -56,7 +82,7 @@ void main() { ), expect: () => [ LoadingState(), - InitialsSuccessState(), + InitialsSuccessState(score: 10), ], ); @@ -74,7 +100,10 @@ void main() { ), ).thenThrow(Exception('Error')); }, - build: () => BackboxBloc(leaderboardRepository: leaderboardRepository), + build: () => BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: emptyEntries, + ), act: (bloc) => bloc.add( PlayerInitialsSubmitted( score: 10, @@ -84,7 +113,26 @@ void main() { ), expect: () => [ LoadingState(), - InitialsFailureState(), + InitialsFailureState(score: 10, character: DashTheme()), + ], + ); + }); + + group('ShareScoreRequested', () { + blocTest( + 'emits ShareState', + setUp: () { + leaderboardRepository = _MockLeaderboardRepository(); + }, + build: () => BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: emptyEntries, + ), + act: (bloc) => bloc.add( + ShareScoreRequested(score: 100), + ), + expect: () => [ + ShareState(score: 100), ], ); }); @@ -100,7 +148,10 @@ void main() { (_) async => [LeaderboardEntryData.empty], ); }, - build: () => BackboxBloc(leaderboardRepository: leaderboardRepository), + build: () => BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: emptyEntries, + ), act: (bloc) => bloc.add(LeaderboardRequested()), expect: () => [ LoadingState(), @@ -116,7 +167,10 @@ void main() { () => leaderboardRepository.fetchTop10Leaderboard(), ).thenThrow(Exception('Error')); }, - build: () => BackboxBloc(leaderboardRepository: leaderboardRepository), + build: () => BackboxBloc( + leaderboardRepository: leaderboardRepository, + initialEntries: emptyEntries, + ), act: (bloc) => bloc.add(LeaderboardRequested()), expect: () => [ LoadingState(), diff --git a/test/game/components/backbox/bloc/backbox_event_test.dart b/test/game/components/backbox/bloc/backbox_event_test.dart index 80f7fbb1..35f74ab5 100644 --- a/test/game/components/backbox/bloc/backbox_event_test.dart +++ b/test/game/components/backbox/bloc/backbox_event_test.dart @@ -123,6 +123,33 @@ void main() { }); }); + group('ScoreShareRequested', () { + test('can be instantiated', () { + expect( + ShareScoreRequested(score: 0), + isNotNull, + ); + }); + + test('supports value comparison', () { + expect( + ShareScoreRequested(score: 0), + equals( + ShareScoreRequested(score: 0), + ), + ); + + expect( + ShareScoreRequested(score: 0), + isNot( + equals( + ShareScoreRequested(score: 1), + ), + ), + ); + }); + }); + group('LeaderboardRequested', () { test('can be instantiated', () { expect(LeaderboardRequested(), isNotNull); diff --git a/test/game/components/backbox/bloc/backbox_state_test.dart b/test/game/components/backbox/bloc/backbox_state_test.dart index dd262408..c41562b0 100644 --- a/test/game/components/backbox/bloc/backbox_state_test.dart +++ b/test/game/components/backbox/bloc/backbox_state_test.dart @@ -115,20 +115,91 @@ void main() { group('InitialsSuccessState', () { test('can be instantiated', () { - expect(InitialsSuccessState(), isNotNull); + expect( + InitialsSuccessState(score: 0), + isNotNull, + ); }); test('supports value comparison', () { - expect(InitialsSuccessState(), equals(InitialsSuccessState())); + expect( + InitialsSuccessState(score: 0), + equals( + InitialsSuccessState(score: 0), + ), + ); }); group('InitialsFailureState', () { test('can be instantiated', () { - expect(InitialsFailureState(), isNotNull); + expect( + InitialsFailureState( + score: 10, + character: AndroidTheme(), + ), + isNotNull, + ); + }); + + test('supports value comparison', () { + expect( + InitialsFailureState( + score: 10, + character: AndroidTheme(), + ), + equals( + InitialsFailureState( + score: 10, + character: AndroidTheme(), + ), + ), + ); + expect( + InitialsFailureState( + score: 10, + character: AndroidTheme(), + ), + isNot( + equals( + InitialsFailureState( + score: 12, + character: AndroidTheme(), + ), + ), + ), + ); + expect( + InitialsFailureState( + score: 10, + character: AndroidTheme(), + ), + isNot( + equals( + InitialsFailureState( + score: 10, + character: DashTheme(), + ), + ), + ), + ); + }); + }); + + group('ShareState', () { + test('can be instantiated', () { + expect( + ShareState(score: 0), + isNotNull, + ); }); test('supports value comparison', () { - expect(InitialsFailureState(), equals(InitialsFailureState())); + expect( + ShareState(score: 0), + equals( + ShareState(score: 0), + ), + ); }); }); }); diff --git a/test/game/components/backbox/displays/game_over_info_display_test.dart b/test/game/components/backbox/displays/game_over_info_display_test.dart new file mode 100644 index 00000000..6b79d9fd --- /dev/null +++ b/test/game/components/backbox/displays/game_over_info_display_test.dart @@ -0,0 +1,195 @@ +// ignore_for_file: cascade_invocations + +import 'package:flame/game.dart'; +import 'package:flame/input.dart'; +import 'package:flame_bloc/flame_bloc.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/bloc/game_bloc.dart'; +import 'package:pinball/game/components/backbox/displays/game_over_info_display.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; +import 'package:pinball_ui/pinball_ui.dart'; +import 'package:plugin_platform_interface/plugin_platform_interface.dart'; +import 'package:share_repository/share_repository.dart'; + +class _TestGame extends Forge2DGame with HasTappables { + @override + Future onLoad() async { + await super.onLoad(); + images.prefix = ''; + await images.loadAll( + [ + Assets.images.backbox.displayTitleDecoration.keyName, + ], + ); + } + + Future pump(GameOverInfoDisplay component) { + return ensureAdd( + FlameBlocProvider.value( + value: GameBloc(), + children: [ + FlameProvider.value( + _MockAppLocalizations(), + children: [component], + ), + ], + ), + ); + } +} + +class _MockAppLocalizations extends Mock implements AppLocalizations { + @override + String get shareYourScore => ''; + + @override + String get andChallengeYourFriends => ''; + + @override + String get share => ''; + + @override + String get gotoIO => ''; + + @override + String get learnMore => ''; + + @override + String get firebaseOr => ''; + + @override + String get openSourceCode => ''; +} + +class _MockTapDownInfo extends Mock implements TapDownInfo {} + +class _MockUrlLauncher extends Mock + with MockPlatformInterfaceMixin + implements UrlLauncherPlatform {} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + final flameTester = FlameTester(_TestGame.new); + + late UrlLauncherPlatform urlLauncher; + + setUp(() async { + urlLauncher = _MockUrlLauncher(); + UrlLauncherPlatform.instance = urlLauncher; + }); + + group('InfoDisplay', () { + flameTester.test( + 'loads correctly', + (game) async { + final component = GameOverInfoDisplay(); + await game.pump(component); + expect(game.descendants(), contains(component)); + }, + ); + + flameTester.test( + 'calls onShare when Share link is tapped', + (game) async { + var tapped = false; + + final tapDownInfo = _MockTapDownInfo(); + final component = GameOverInfoDisplay( + onShare: () => tapped = true, + ); + await game.pump(component); + + final shareLink = + component.descendants().whereType().first; + + shareLink.onTapDown(tapDownInfo); + + expect(tapped, isTrue); + }, + ); + + flameTester.test( + 'open Google IO Event url when navigating', + (game) async { + when(() => urlLauncher.canLaunch(any())).thenAnswer((_) async => true); + when( + () => urlLauncher.launch( + any(), + useSafariVC: any(named: 'useSafariVC'), + useWebView: any(named: 'useWebView'), + enableJavaScript: any(named: 'enableJavaScript'), + enableDomStorage: any(named: 'enableDomStorage'), + universalLinksOnly: any(named: 'universalLinksOnly'), + headers: any(named: 'headers'), + ), + ).thenAnswer((_) async => true); + + final component = GameOverInfoDisplay(); + await game.pump(component); + + final googleLink = + component.descendants().whereType().first; + googleLink.onTapDown(_MockTapDownInfo()); + + await game.ready(); + + verify( + () => urlLauncher.launch( + ShareRepository.googleIOEvent, + useSafariVC: any(named: 'useSafariVC'), + useWebView: any(named: 'useWebView'), + enableJavaScript: any(named: 'enableJavaScript'), + enableDomStorage: any(named: 'enableDomStorage'), + universalLinksOnly: any(named: 'universalLinksOnly'), + headers: any(named: 'headers'), + ), + ); + }, + ); + + flameTester.test( + 'open OpenSource url when navigating', + (game) async { + when(() => urlLauncher.canLaunch(any())).thenAnswer((_) async => true); + when( + () => urlLauncher.launch( + any(), + useSafariVC: any(named: 'useSafariVC'), + useWebView: any(named: 'useWebView'), + enableJavaScript: any(named: 'enableJavaScript'), + enableDomStorage: any(named: 'enableDomStorage'), + universalLinksOnly: any(named: 'universalLinksOnly'), + headers: any(named: 'headers'), + ), + ).thenAnswer((_) async => true); + + final component = GameOverInfoDisplay(); + await game.pump(component); + + final openSourceLink = + component.descendants().whereType().first; + openSourceLink.onTapDown(_MockTapDownInfo()); + + await game.ready(); + + verify( + () => urlLauncher.launch( + ShareRepository.openSourceCode, + useSafariVC: any(named: 'useSafariVC'), + useWebView: any(named: 'useWebView'), + enableJavaScript: any(named: 'enableJavaScript'), + enableDomStorage: any(named: 'enableDomStorage'), + universalLinksOnly: any(named: 'universalLinksOnly'), + headers: any(named: 'headers'), + ), + ); + }, + ); + }); +} diff --git a/test/game/components/backbox/displays/initials_input_display_test.dart b/test/game/components/backbox/displays/initials_input_display_test.dart index 1b92aedd..fd61c2c2 100644 --- a/test/game/components/backbox/displays/initials_input_display_test.dart +++ b/test/game/components/backbox/displays/initials_input_display_test.dart @@ -129,7 +129,7 @@ void main() { }, ); - String? submitedInitials; + String? submittedInitials; flameTester.testGameWidget( 'submits the initials', setUp: (game, tester) async { @@ -138,7 +138,7 @@ void main() { score: 1000, characterIconPath: game.characterIconPath, onSubmit: (value) { - submitedInitials = value; + submittedInitials = value; }, ); await game.pump(component); @@ -147,7 +147,7 @@ void main() { await tester.pump(); }, verify: (game, tester) async { - expect(submitedInitials, equals('AAA')); + expect(submittedInitials, equals('AAA')); }, ); diff --git a/test/game/components/backbox/displays/initials_submission_failure_display_test.dart b/test/game/components/backbox/displays/initials_submission_failure_display_test.dart index b37b41e7..f0eb03c6 100644 --- a/test/game/components/backbox/displays/initials_submission_failure_display_test.dart +++ b/test/game/components/backbox/displays/initials_submission_failure_display_test.dart @@ -4,18 +4,74 @@ import 'package:flame/components.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/components/backbox/displays/initials_submission_failure_display.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball_components/gen/assets.gen.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +class _TestGame extends Forge2DGame { + @override + Future onLoad() async { + await super.onLoad(); + images.prefix = ''; + await images.loadAll( + [ + Assets.images.errorBackground.keyName, + ], + ); + } + + Future pump(InitialsSubmissionFailureDisplay component) { + return ensureAdd( + FlameProvider.value( + _MockAppLocalizations(), + children: [component], + ), + ); + } +} + +class _MockAppLocalizations extends Mock implements AppLocalizations { + @override + String get initialsErrorTitle => 'Title'; + + @override + String get initialsErrorMessage => 'Message'; +} void main() { + TestWidgetsFlutterBinding.ensureInitialized(); group('InitialsSubmissionFailureDisplay', () { - final flameTester = FlameTester(Forge2DGame.new); + final flameTester = FlameTester(_TestGame.new); flameTester.test('renders correctly', (game) async { - await game.ensureAdd(InitialsSubmissionFailureDisplay()); + await game.pump( + InitialsSubmissionFailureDisplay( + onDismissed: () {}, + ), + ); - final component = game.firstChild(); - expect(component, isNotNull); - expect(component?.text, equals('Failure!')); + expect( + game + .descendants() + .where( + (component) => + component is TextComponent && component.text == 'Title', + ) + .length, + equals(1), + ); + expect( + game + .descendants() + .where( + (component) => + component is TextComponent && component.text == 'Message', + ) + .length, + equals(1), + ); }); }); } diff --git a/test/game/components/backbox/displays/leaderboard_failure_display_test.dart b/test/game/components/backbox/displays/leaderboard_failure_display_test.dart new file mode 100644 index 00000000..8ce4c839 --- /dev/null +++ b/test/game/components/backbox/displays/leaderboard_failure_display_test.dart @@ -0,0 +1,60 @@ +// ignore_for_file: cascade_invocations + +import 'package:flame/components.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/components/backbox/displays/displays.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball_components/gen/assets.gen.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +class _TestGame extends Forge2DGame { + @override + Future onLoad() async { + await super.onLoad(); + images.prefix = ''; + await images.loadAll( + [ + Assets.images.errorBackground.keyName, + ], + ); + } + + Future pump(LeaderboardFailureDisplay component) { + return ensureAdd( + FlameProvider.value( + _MockAppLocalizations(), + children: [component], + ), + ); + } +} + +class _MockAppLocalizations extends Mock implements AppLocalizations { + @override + String get leaderboardErrorMessage => 'Message'; +} + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + group('LeaderboardFailureDisplay', () { + final flameTester = FlameTester(_TestGame.new); + + flameTester.test('renders correctly', (game) async { + await game.pump(LeaderboardFailureDisplay()); + + expect( + game + .descendants() + .where( + (component) => + component is TextComponent && component.text == 'Message', + ) + .length, + equals(1), + ); + }); + }); +} diff --git a/test/game/components/bottom_group_test.dart b/test/game/components/bottom_group_test.dart index fab8dfaf..832d96d6 100644 --- a/test/game/components/bottom_group_test.dart +++ b/test/game/components/bottom_group_test.dart @@ -95,9 +95,9 @@ void main() { ), ); - final basebottomGroups = + final baseBottomGroups = bottomGroup.descendants().whereType(); - expect(basebottomGroups.length, equals(2)); + expect(baseBottomGroups.length, equals(2)); }, ); diff --git a/test/game/components/controlled_plunger_test.dart b/test/game/components/controlled_plunger_test.dart index 25b1f739..68bde767 100644 --- a/test/game/components/controlled_plunger_test.dart +++ b/test/game/components/controlled_plunger_test.dart @@ -28,15 +28,15 @@ class _TestGame extends Forge2DGame with HasKeyboardHandlerComponents { Future pump( Plunger child, { GameBloc? gameBloc, - PinballPlayer? pinballPlayer, + PinballAudioPlayer? pinballAudioPlayer, }) { return ensureAdd( FlameBlocProvider.value( value: gameBloc ?? GameBloc() ..add(const GameStarted()), children: [ - FlameProvider.value( - pinballPlayer ?? _MockPinballPlayer(), + FlameProvider.value( + pinballAudioPlayer ?? _MockPinballAudioPlayer(), children: [child], ) ], @@ -47,7 +47,7 @@ class _TestGame extends Forge2DGame with HasKeyboardHandlerComponents { class _MockGameBloc extends Mock implements GameBloc {} -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} void main() { TestWidgetsFlutterBinding.ensureInitialized(); @@ -158,17 +158,17 @@ void main() { }); group('PlungerNoiseBehavior', () { - late PinballPlayer player; + late PinballAudioPlayer audioPlayer; setUp(() { - player = _MockPinballPlayer(); + audioPlayer = _MockPinballAudioPlayer(); }); flameTester.test('plays the correct sound on load', (game) async { final parent = ControlledPlunger(compressionDistance: 10); - await game.pump(parent, pinballPlayer: player); + await game.pump(parent, pinballAudioPlayer: audioPlayer); await parent.ensureAdd(PlungerNoiseBehavior()); - verify(() => player.play(PinballAudio.launcher)).called(1); + verify(() => audioPlayer.play(PinballAudio.launcher)).called(1); }); test('is removed on the first update', () { 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 index 0b75a61e..7fc1946b 100644 --- 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 @@ -53,8 +53,7 @@ void main() { final flameTester = FlameTester(_TestGame.new); - void _contactedBumper(DashNestBumper bumper) => - bumper.bloc.onBallContacted(); + void _contactedBumper(DashBumper bumper) => bumper.bloc.onBallContacted(); flameTester.testGameWidget( 'adds GameBonus.dashNest to the game ' @@ -64,9 +63,9 @@ void main() { final behavior = FlutterForestBonusBehavior(); final parent = FlutterForest.test(); final bumpers = [ - DashNestBumper.test(bloc: DashNestBumperCubit()), - DashNestBumper.test(bloc: DashNestBumperCubit()), - DashNestBumper.test(bloc: DashNestBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), ]; final animatronic = DashAnimatronic(); final signpost = Signpost.test(bloc: SignpostCubit()); @@ -74,7 +73,7 @@ void main() { await parent.ensureAddAll([...bumpers, animatronic, signpost]); await parent.ensureAdd(behavior); - expect(game.descendants().whereType(), equals(bumpers)); + expect(game.descendants().whereType(), equals(bumpers)); bumpers.forEach(_contactedBumper); await tester.pump(); bumpers.forEach(_contactedBumper); @@ -96,9 +95,9 @@ void main() { final behavior = FlutterForestBonusBehavior(); final parent = FlutterForest.test(); final bumpers = [ - DashNestBumper.test(bloc: DashNestBumperCubit()), - DashNestBumper.test(bloc: DashNestBumperCubit()), - DashNestBumper.test(bloc: DashNestBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), ]; final animatronic = DashAnimatronic(); final signpost = Signpost.test(bloc: SignpostCubit()); @@ -106,7 +105,7 @@ void main() { await parent.ensureAddAll([...bumpers, animatronic, signpost]); await parent.ensureAdd(behavior); - expect(game.descendants().whereType(), equals(bumpers)); + expect(game.descendants().whereType(), equals(bumpers)); bumpers.forEach(_contactedBumper); await tester.pump(); bumpers.forEach(_contactedBumper); @@ -130,9 +129,9 @@ void main() { final behavior = FlutterForestBonusBehavior(); final parent = FlutterForest.test(); final bumpers = [ - DashNestBumper.test(bloc: DashNestBumperCubit()), - DashNestBumper.test(bloc: DashNestBumperCubit()), - DashNestBumper.test(bloc: DashNestBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), + DashBumper.test(bloc: DashBumperCubit()), ]; final animatronic = DashAnimatronic(); final signpost = Signpost.test(bloc: SignpostCubit()); @@ -140,7 +139,7 @@ void main() { await parent.ensureAddAll([...bumpers, animatronic, signpost]); await parent.ensureAdd(behavior); - expect(game.descendants().whereType(), equals(bumpers)); + expect(game.descendants().whereType(), equals(bumpers)); bumpers.forEach(_contactedBumper); await tester.pump(); diff --git a/test/game/components/flutter_forest/flutter_forest_test.dart b/test/game/components/flutter_forest/flutter_forest_test.dart index 470719d8..ae5d86ee 100644 --- a/test/game/components/flutter_forest/flutter_forest_test.dart +++ b/test/game/components/flutter_forest/flutter_forest_test.dart @@ -36,7 +36,7 @@ class _TestGame extends Forge2DGame { value: _MockGameBloc(), children: [ FlameProvider.value( - _MockPinballPlayer(), + _MockPinballAudioPlayer(), children: [ ZCanvasComponent(children: [child]), ], @@ -47,7 +47,7 @@ class _TestGame extends Forge2DGame { } } -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} class _MockGameBloc extends Mock implements GameBloc {} @@ -91,23 +91,23 @@ void main() { ); flameTester.test( - 'three DashNestBumper', + 'three DashBumper', (game) async { final component = FlutterForest(); await game.pump(component); expect( - game.descendants().whereType().length, + game.descendants().whereType().length, equals(3), ); }, ); flameTester.test( - 'three DashNestBumpers with BumperNoiseBehavior', + 'three DashBumpers with BumperNoiseBehavior', (game) async { final component = FlutterForest(); await game.pump(component); - final bumpers = game.descendants().whereType(); + final bumpers = game.descendants().whereType(); for (final bumper in bumpers) { expect( bumper.firstChild(), diff --git a/test/game/components/game_bloc_status_listener_test.dart b/test/game/components/game_bloc_status_listener_test.dart index 36e496f3..3151e70b 100644 --- a/test/game/components/game_bloc_status_listener_test.dart +++ b/test/game/components/game_bloc_status_listener_test.dart @@ -30,7 +30,7 @@ class _TestGame extends Forge2DGame { Future pump( Iterable children, { - PinballPlayer? pinballPlayer, + PinballAudioPlayer? pinballAudioPlayer, }) async { return ensureAdd( FlameMultiBlocProvider( @@ -45,8 +45,8 @@ class _TestGame extends Forge2DGame { children: [ MultiFlameProvider( providers: [ - FlameProvider.value( - pinballPlayer ?? _MockPinballPlayer(), + FlameProvider.value( + pinballAudioPlayer ?? _MockPinballAudioPlayer(), ), FlameProvider.value( _MockAppLocalizations(), @@ -60,7 +60,7 @@ class _TestGame extends Forge2DGame { } } -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} class _MockLeaderboardRepository extends Mock implements LeaderboardRepository { } @@ -150,7 +150,10 @@ void main() { (game) async { final component = GameBlocStatusListener(); final repository = _MockLeaderboardRepository(); - final backbox = Backbox(leaderboardRepository: repository); + final backbox = Backbox( + leaderboardRepository: repository, + entries: const [], + ); await game.pump([component, backbox]); @@ -159,11 +162,14 @@ void main() { ); flameTester.test( - 'removes FlipperKeyControllingBehavior from Fipper', + 'removes FlipperKeyControllingBehavior from Flipper', (game) async { final component = GameBlocStatusListener(); final repository = _MockLeaderboardRepository(); - final backbox = Backbox(leaderboardRepository: repository); + final backbox = Backbox( + leaderboardRepository: repository, + entries: const [], + ); final flipper = Flipper.test(side: BoardSide.left); final behavior = FlipperKeyControllingBehavior(); @@ -185,15 +191,25 @@ void main() { flameTester.test( 'plays the game over voice over', (game) async { - final player = _MockPinballPlayer(); + final audioPlayer = _MockPinballAudioPlayer(); final component = GameBlocStatusListener(); final repository = _MockLeaderboardRepository(); - final backbox = Backbox(leaderboardRepository: repository); - await game.pump([component, backbox], pinballPlayer: player); + final backbox = Backbox( + leaderboardRepository: repository, + entries: const [], + ); + await game.pump( + [component, backbox], + pinballAudioPlayer: audioPlayer, + ); component.onNewState(state); - verify(() => player.play(PinballAudio.gameOverVoiceOver)).called(1); + verify( + () => audioPlayer.play( + PinballAudio.gameOverVoiceOver, + ), + ).called(1); }, ); }); @@ -210,23 +226,30 @@ void main() { flameTester.test( 'plays the background music on start', (game) async { - final player = _MockPinballPlayer(); + final audioPlayer = _MockPinballAudioPlayer(); final component = GameBlocStatusListener(); - await game.pump([component], pinballPlayer: player); + await game.pump([component], pinballAudioPlayer: audioPlayer); expect(state.status, equals(GameStatus.playing)); component.onNewState(state); - verify(() => player.play(PinballAudio.backgroundMusic)).called(1); + verify( + () => audioPlayer.play( + PinballAudio.backgroundMusic, + ), + ).called(1); }, ); flameTester.test( - 'adds key controlling behavior to Fippers when the game is started', + 'adds key controlling behavior to Flippers when the game is started', (game) async { final component = GameBlocStatusListener(); final repository = _MockLeaderboardRepository(); - final backbox = Backbox(leaderboardRepository: repository); + final backbox = Backbox( + leaderboardRepository: repository, + entries: const [], + ); final flipper = Flipper.test(side: BoardSide.left); await game.pump([component, backbox, flipper]); diff --git a/test/game/pinball_game_test.dart b/test/game/pinball_game_test.dart index e96b6c60..5aee66fd 100644 --- a/test/game/pinball_game_test.dart +++ b/test/game/pinball_game_test.dart @@ -24,7 +24,7 @@ class _TestPinballGame extends PinballGame { leaderboardRepository: _MockLeaderboardRepository(), gameBloc: GameBloc(), l10n: _MockAppLocalizations(), - player: _MockPinballPlayer(), + audioPlayer: _MockPinballAudioPlayer(), ); @override @@ -43,7 +43,7 @@ class _TestDebugPinballGame extends DebugPinballGame { leaderboardRepository: _MockLeaderboardRepository(), gameBloc: GameBloc(), l10n: _MockAppLocalizations(), - player: _MockPinballPlayer(), + audioPlayer: _MockPinballAudioPlayer(), ); @override @@ -57,7 +57,10 @@ class _TestDebugPinballGame extends DebugPinballGame { class _MockGameBloc extends Mock implements GameBloc {} -class _MockAppLocalizations extends Mock implements AppLocalizations {} +class _MockAppLocalizations extends Mock implements AppLocalizations { + @override + String get leaderboardErrorMessage => ''; +} class _MockEventPosition extends Mock implements EventPosition {} @@ -78,7 +81,7 @@ class _MockDragEndInfo extends Mock implements DragEndInfo {} class _MockLeaderboardRepository extends Mock implements LeaderboardRepository { } -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} void main() { TestWidgetsFlutterBinding.ensureInitialized(); diff --git a/test/game/view/pinball_game_page_test.dart b/test/game/view/pinball_game_page_test.dart index 0e23e54d..b2cde26e 100644 --- a/test/game/view/pinball_game_page_test.dart +++ b/test/game/view/pinball_game_page_test.dart @@ -26,13 +26,16 @@ class _TestPinballGame extends PinballGame { leaderboardRepository: _MockLeaderboardRepository(), gameBloc: GameBloc(), l10n: _MockAppLocalizations(), - player: _MockPinballPlayer(), + audioPlayer: _MockPinballAudioPlayer(), ); @override Future onLoad() async { images.prefix = ''; - final futures = preLoadAssets(); + final futures = [ + ...preLoadAssets(), + preFetchLeaderboard(), + ]; await Future.wait(futures); return super.onLoad(); @@ -47,9 +50,12 @@ class _MockAssetsManagerCubit extends Mock implements AssetsManagerCubit {} class _MockStartGameBloc extends Mock implements StartGameBloc {} -class _MockAppLocalizations extends Mock implements AppLocalizations {} +class _MockAppLocalizations extends Mock implements AppLocalizations { + @override + String get leaderboardErrorMessage => ''; +} -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} class _MockLeaderboardRepository extends Mock implements LeaderboardRepository { } @@ -79,14 +85,26 @@ void main() { ); }); - testWidgets('renders PinballGameView', (tester) async { - await tester.pumpApp( - PinballGamePage(), - characterThemeCubit: characterThemeCubit, - gameBloc: gameBloc, - ); + group('renders PinballGameView', () { + testWidgets('with debug mode turned on', (tester) async { + await tester.pumpApp( + PinballGamePage(), + characterThemeCubit: characterThemeCubit, + gameBloc: gameBloc, + ); + + expect(find.byType(PinballGameView), findsOneWidget); + }); - expect(find.byType(PinballGameView), findsOneWidget); + testWidgets('with debug mode turned off', (tester) async { + await tester.pumpApp( + PinballGamePage(isDebugMode: false), + characterThemeCubit: characterThemeCubit, + gameBloc: gameBloc, + ); + + expect(find.byType(PinballGameView), findsOneWidget); + }); }); testWidgets( @@ -103,9 +121,7 @@ void main() { initialState: initialAssetsState, ); await tester.pumpApp( - PinballGameView( - game: game, - ), + PinballGameView(game), assetsManagerCubit: assetsManagerCubit, characterThemeCubit: characterThemeCubit, ); @@ -135,9 +151,7 @@ void main() { ); await tester.pumpApp( - PinballGameView( - game: game, - ), + PinballGameView(game), assetsManagerCubit: assetsManagerCubit, characterThemeCubit: characterThemeCubit, gameBloc: gameBloc, @@ -148,61 +162,6 @@ void main() { expect(find.byType(PinballGameLoadedView), findsOneWidget); }); - - group('route', () { - Future pumpRoute({ - required WidgetTester tester, - required bool isDebugMode, - }) async { - await tester.pumpApp( - Scaffold( - body: Builder( - builder: (context) { - return ElevatedButton( - onPressed: () { - Navigator.of(context).push( - PinballGamePage.route( - isDebugMode: isDebugMode, - ), - ); - }, - child: const Text('Tap me'), - ); - }, - ), - ), - characterThemeCubit: characterThemeCubit, - gameBloc: gameBloc, - ); - - await tester.tap(find.text('Tap me')); - - // We can't use pumpAndSettle here because the page renders a Flame game - // which is an infinity animation, so it will timeout - await tester.pump(); // Runs the button action - await tester.pump(); // Runs the navigation - } - - testWidgets('route creates the correct non debug game', (tester) async { - await pumpRoute(tester: tester, isDebugMode: false); - expect( - find.byWidgetPredicate( - (w) => w is PinballGameView && w.game is! DebugPinballGame, - ), - findsOneWidget, - ); - }); - - testWidgets('route creates the correct debug game', (tester) async { - await pumpRoute(tester: tester, isDebugMode: true); - expect( - find.byWidgetPredicate( - (w) => w is PinballGameView && w.game is DebugPinballGame, - ), - findsOneWidget, - ); - }); - }); }); group('PinballGameView', () { @@ -227,7 +186,7 @@ void main() { testWidgets('renders game', (tester) async { await tester.pumpApp( - PinballGameView(game: game), + PinballGameView(game), gameBloc: gameBloc, startGameBloc: startGameBloc, ); @@ -255,7 +214,7 @@ void main() { ); await tester.pumpApp( - PinballGameView(game: game), + PinballGameView(game), gameBloc: gameBloc, startGameBloc: startGameBloc, ); @@ -273,7 +232,6 @@ void main() { final gameState = GameState.initial().copyWith( status: GameStatus.gameOver, ); - whenListen( startGameBloc, Stream.value(startGameState), @@ -284,17 +242,12 @@ void main() { Stream.value(gameState), initialState: gameState, ); - await tester.pumpApp( - PinballGameView(game: game), + Material(child: PinballGameView(game)), gameBloc: gameBloc, startGameBloc: startGameBloc, ); - - expect( - find.byType(GameHud), - findsNothing, - ); + expect(find.byType(GameHud), findsNothing); }); testWidgets('keep focus on game when mouse hovers over it', (tester) async { @@ -304,7 +257,6 @@ void main() { final gameState = GameState.initial().copyWith( status: GameStatus.gameOver, ); - whenListen( startGameBloc, Stream.value(startGameState), @@ -316,47 +268,51 @@ void main() { initialState: gameState, ); await tester.pumpApp( - PinballGameView(game: game), + Material(child: PinballGameView(game)), gameBloc: gameBloc, startGameBloc: startGameBloc, ); - game.focusNode.unfocus(); await tester.pump(); - expect(game.focusNode.hasFocus, isFalse); - final gesture = await tester.createGesture(kind: PointerDeviceKind.mouse); await gesture.addPointer(location: Offset.zero); addTearDown(gesture.removePointer); await gesture.moveTo((game.size / 2).toOffset()); await tester.pump(); - expect(game.focusNode.hasFocus, isTrue); }); + testWidgets('mobile controls when the overlay is added', (tester) async { + await tester.pumpApp( + PinballGameView(game), + gameBloc: gameBloc, + startGameBloc: startGameBloc, + ); + + game.overlays.add(PinballGame.mobileControlsOverlay); + + await tester.pump(); + + expect(find.byType(MobileControls), findsOneWidget); + }); + group('info icon', () { testWidgets('renders on game over', (tester) async { final gameState = GameState.initial().copyWith( status: GameStatus.gameOver, ); - whenListen( gameBloc, Stream.value(gameState), initialState: gameState, ); - await tester.pumpApp( - PinballGameView(game: game), + Material(child: PinballGameView(game)), gameBloc: gameBloc, startGameBloc: startGameBloc, ); - - expect( - find.image(Assets.images.linkBox.infoIcon), - findsOneWidget, - ); + expect(find.image(Assets.images.linkBox.infoIcon), findsOneWidget); }); testWidgets('opens MoreInformationDialog when tapped', (tester) async { @@ -369,16 +325,13 @@ void main() { initialState: gameState, ); await tester.pumpApp( - PinballGameView(game: game), + Material(child: PinballGameView(game)), gameBloc: gameBloc, startGameBloc: startGameBloc, ); await tester.tap(find.byType(IconButton)); await tester.pump(); - expect( - find.byType(MoreInformationDialog), - findsOneWidget, - ); + expect(find.byType(MoreInformationDialog), findsOneWidget); }); }); }); diff --git a/test/game/view/widgets/mobile_controls_test.dart b/test/game/view/widgets/mobile_controls_test.dart new file mode 100644 index 00000000..ab9c0b76 --- /dev/null +++ b/test/game/view/widgets/mobile_controls_test.dart @@ -0,0 +1,131 @@ +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_localizations/flutter_localizations.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball_flame/pinball_flame.dart'; +import 'package:pinball_ui/pinball_ui.dart'; + +class _MockPinballGame extends Mock implements PinballGame {} + +extension _WidgetTesterX on WidgetTester { + Future pumpMobileControls(PinballGame game) async { + await pumpWidget( + MaterialApp( + localizationsDelegates: const [ + AppLocalizations.delegate, + GlobalMaterialLocalizations.delegate, + ], + home: Scaffold( + body: MobileControls(game: game), + ), + ), + ); + } +} + +extension _CommonFindersX on CommonFinders { + Finder byPinballDpadDirection(PinballDpadDirection direction) { + return byWidgetPredicate((widget) { + return widget is PinballDpadButton && widget.direction == direction; + }); + } +} + +void main() { + group('MobileControls', () { + testWidgets('renders', (tester) async { + await tester.pumpMobileControls(_MockPinballGame()); + + expect(find.byType(PinballButton), findsOneWidget); + expect(find.byType(MobileDpad), findsOneWidget); + }); + + testWidgets('correctly triggers the arrow up', (tester) async { + var pressed = false; + final component = KeyboardInputController( + keyUp: { + LogicalKeyboardKey.arrowUp: () => pressed = true, + }, + ); + final game = _MockPinballGame(); + when(game.descendants).thenReturn([component]); + + await tester.pumpMobileControls(game); + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.up)); + await tester.pump(); + + expect(pressed, isTrue); + }); + + testWidgets('correctly triggers the arrow down', (tester) async { + var pressed = false; + final component = KeyboardInputController( + keyUp: { + LogicalKeyboardKey.arrowDown: () => pressed = true, + }, + ); + final game = _MockPinballGame(); + when(game.descendants).thenReturn([component]); + + await tester.pumpMobileControls(game); + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.down)); + await tester.pump(); + + expect(pressed, isTrue); + }); + + testWidgets('correctly triggers the arrow right', (tester) async { + var pressed = false; + final component = KeyboardInputController( + keyUp: { + LogicalKeyboardKey.arrowRight: () => pressed = true, + }, + ); + final game = _MockPinballGame(); + when(game.descendants).thenReturn([component]); + + await tester.pumpMobileControls(game); + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.right)); + await tester.pump(); + + expect(pressed, isTrue); + }); + + testWidgets('correctly triggers the arrow left', (tester) async { + var pressed = false; + final component = KeyboardInputController( + keyUp: { + LogicalKeyboardKey.arrowLeft: () => pressed = true, + }, + ); + final game = _MockPinballGame(); + when(game.descendants).thenReturn([component]); + + await tester.pumpMobileControls(game); + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.left)); + await tester.pump(); + + expect(pressed, isTrue); + }); + + testWidgets('correctly triggers the enter', (tester) async { + var pressed = false; + final component = KeyboardInputController( + keyUp: { + LogicalKeyboardKey.enter: () => pressed = true, + }, + ); + final game = _MockPinballGame(); + when(game.descendants).thenReturn([component]); + + await tester.pumpMobileControls(game); + await tester.tap(find.byType(PinballButton)); + await tester.pump(); + + expect(pressed, isTrue); + }); + }); +} diff --git a/test/game/view/widgets/mobile_dpad_test.dart b/test/game/view/widgets/mobile_dpad_test.dart new file mode 100644 index 00000000..2a8d0b02 --- /dev/null +++ b/test/game/view/widgets/mobile_dpad_test.dart @@ -0,0 +1,113 @@ +// ignore_for_file: one_member_abstracts + +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_ui/pinball_ui.dart'; + +extension _WidgetTesterX on WidgetTester { + Future pumpDpad({ + required VoidCallback onTapUp, + required VoidCallback onTapDown, + required VoidCallback onTapLeft, + required VoidCallback onTapRight, + }) async { + await pumpWidget( + MaterialApp( + home: Scaffold( + body: MobileDpad( + onTapUp: onTapUp, + onTapDown: onTapDown, + onTapLeft: onTapLeft, + onTapRight: onTapRight, + ), + ), + ), + ); + } +} + +extension _CommonFindersX on CommonFinders { + Finder byPinballDpadDirection(PinballDpadDirection direction) { + return byWidgetPredicate((widget) { + return widget is PinballDpadButton && widget.direction == direction; + }); + } +} + +abstract class _VoidCallbackStubBase { + void onCall(); +} + +class _VoidCallbackStub extends Mock implements _VoidCallbackStubBase {} + +void main() { + group('MobileDpad', () { + testWidgets('renders correctly', (tester) async { + await tester.pumpDpad( + onTapUp: () {}, + onTapDown: () {}, + onTapLeft: () {}, + onTapRight: () {}, + ); + + expect( + find.byType(PinballDpadButton), + findsNWidgets(4), + ); + }); + + testWidgets('can tap up', (tester) async { + final stub = _VoidCallbackStub(); + await tester.pumpDpad( + onTapUp: stub.onCall, + onTapDown: () {}, + onTapLeft: () {}, + onTapRight: () {}, + ); + + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.up)); + verify(stub.onCall).called(1); + }); + + testWidgets('can tap down', (tester) async { + final stub = _VoidCallbackStub(); + await tester.pumpDpad( + onTapUp: () {}, + onTapDown: stub.onCall, + onTapLeft: () {}, + onTapRight: () {}, + ); + + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.down)); + verify(stub.onCall).called(1); + }); + + testWidgets('can tap left', (tester) async { + final stub = _VoidCallbackStub(); + await tester.pumpDpad( + onTapUp: () {}, + onTapDown: () {}, + onTapLeft: stub.onCall, + onTapRight: () {}, + ); + + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.left)); + verify(stub.onCall).called(1); + }); + + testWidgets('can tap left', (tester) async { + final stub = _VoidCallbackStub(); + await tester.pumpDpad( + onTapUp: () {}, + onTapDown: () {}, + onTapLeft: () {}, + onTapRight: stub.onCall, + ); + + await tester.tap(find.byPinballDpadDirection(PinballDpadDirection.right)); + verify(stub.onCall).called(1); + }); + }); +} diff --git a/test/game/view/widgets/replay_button_overlay_test.dart b/test/game/view/widgets/replay_button_overlay_test.dart new file mode 100644 index 00000000..1497031a --- /dev/null +++ b/test/game/view/widgets/replay_button_overlay_test.dart @@ -0,0 +1,45 @@ +import 'package:bloc_test/bloc_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball/start_game/bloc/start_game_bloc.dart'; + +import '../../../helpers/helpers.dart'; + +class _MockStartGameBloc extends Mock implements StartGameBloc {} + +void main() { + group('ReplayButtonOverlay', () { + late StartGameBloc startGameBloc; + + setUp(() async { + await mockFlameImages(); + startGameBloc = _MockStartGameBloc(); + + whenListen( + startGameBloc, + Stream.value(const StartGameState.initial()), + initialState: const StartGameState.initial(), + ); + }); + + testWidgets('renders correctly', (tester) async { + await tester.pumpApp(const ReplayButtonOverlay()); + + expect(find.text('Replay'), findsOneWidget); + }); + + testWidgets('adds ReplayTapped event to StartGameBloc when tapped', + (tester) async { + await tester.pumpApp( + const ReplayButtonOverlay(), + startGameBloc: startGameBloc, + ); + + await tester.tap(find.text('Replay')); + await tester.pump(); + + verify(() => startGameBloc.add(const ReplayTapped())).called(1); + }); + }); +} diff --git a/test/helpers/pump_app.dart b/test/helpers/pump_app.dart index 45929978..8be03f03 100644 --- a/test/helpers/pump_app.dart +++ b/test/helpers/pump_app.dart @@ -24,12 +24,12 @@ class _MockGameBloc extends Mock implements GameBloc {} class _MockStartGameBloc extends Mock implements StartGameBloc {} -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} -PinballPlayer _buildDefaultPinballPlayer() { - final player = _MockPinballPlayer(); - when(player.load).thenAnswer((_) => [Future.value()]); - return player; +PinballAudioPlayer _buildDefaultPinballAudioPlayer() { + final audioPlayer = _MockPinballAudioPlayer(); + when(audioPlayer.load).thenAnswer((_) => [Future.value()]); + return audioPlayer; } AssetsManagerCubit _buildDefaultAssetsManagerCubit() { @@ -55,7 +55,7 @@ extension PumpApp on WidgetTester { AssetsManagerCubit? assetsManagerCubit, CharacterThemeCubit? characterThemeCubit, LeaderboardRepository? leaderboardRepository, - PinballPlayer? pinballPlayer, + PinballAudioPlayer? pinballAudioPlayer, }) { return runAsync(() { return pumpWidget( @@ -65,7 +65,7 @@ extension PumpApp on WidgetTester { value: leaderboardRepository ?? _MockLeaderboardRepository(), ), RepositoryProvider.value( - value: pinballPlayer ?? _buildDefaultPinballPlayer(), + value: pinballAudioPlayer ?? _buildDefaultPinballAudioPlayer(), ), ], child: MultiBlocProvider( diff --git a/test/select_character/cubit/character_theme_cubit_test.dart b/test/select_character/cubit/character_theme_cubit_test.dart index 967eb1e1..a9d03d75 100644 --- a/test/select_character/cubit/character_theme_cubit_test.dart +++ b/test/select_character/cubit/character_theme_cubit_test.dart @@ -14,7 +14,7 @@ void main() { }); blocTest( - 'charcterSelected emits selected character theme', + 'characterSelected emits selected character theme', build: CharacterThemeCubit.new, act: (bloc) => bloc.characterSelected(const SparkyTheme()), expect: () => [ diff --git a/test/start_game/bloc/start_game_bloc_test.dart b/test/start_game/bloc/start_game_bloc_test.dart index 45460fe3..3b82e83d 100644 --- a/test/start_game/bloc/start_game_bloc_test.dart +++ b/test/start_game/bloc/start_game_bloc_test.dart @@ -15,6 +15,17 @@ void main() { ], ); + blocTest( + 'on ReplayTapped changes status to selectCharacter', + build: StartGameBloc.new, + act: (bloc) => bloc.add(const ReplayTapped()), + expect: () => [ + const StartGameState( + status: StartGameStatus.selectCharacter, + ) + ], + ); + blocTest( 'on CharacterSelected changes status to howToPlay', build: StartGameBloc.new, diff --git a/test/start_game/bloc/start_game_event_test.dart b/test/start_game/bloc/start_game_event_test.dart index cf481d9f..26f96160 100644 --- a/test/start_game/bloc/start_game_event_test.dart +++ b/test/start_game/bloc/start_game_event_test.dart @@ -12,6 +12,13 @@ void main() { ); }); + test('ReplayTapped supports value equality', () { + expect( + ReplayTapped(), + equals(ReplayTapped()), + ); + }); + test('CharacterSelected supports value equality', () { expect( CharacterSelected(), diff --git a/test/start_game/bloc/start_game_state_test.dart b/test/start_game/bloc/start_game_state_test.dart index 7ede696d..ad983417 100644 --- a/test/start_game/bloc/start_game_state_test.dart +++ b/test/start_game/bloc/start_game_state_test.dart @@ -25,10 +25,41 @@ void main() { expect(testState, secondState); }); - test('supports copyWith', () { - final secondState = testState.copyWith(); + group('copyWith', () { + test( + 'copies correctly ' + 'when no argument specified', + () { + const state = StartGameState( + status: StartGameStatus.initial, + ); + expect( + state.copyWith(), + equals(state), + ); + }, + ); - expect(testState, secondState); + test( + 'copies correctly ' + 'when all arguments specified', + () { + const state = StartGameState( + status: StartGameStatus.initial, + ); + final otherState = StartGameState( + status: StartGameStatus.play, + ); + expect(state, isNot(equals(otherState))); + + expect( + state.copyWith( + status: otherState.status, + ), + equals(otherState), + ); + }, + ); }); test('has correct props', () { diff --git a/test/start_game/widgets/start_game_listener_test.dart b/test/start_game/widgets/start_game_listener_test.dart index 4e25796b..d801864b 100644 --- a/test/start_game/widgets/start_game_listener_test.dart +++ b/test/start_game/widgets/start_game_listener_test.dart @@ -16,11 +16,11 @@ class _MockGameBloc extends Mock implements GameBloc {} class _MockCharacterThemeCubit extends Mock implements CharacterThemeCubit {} -class _MockPinballPlayer extends Mock implements PinballPlayer {} +class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {} void main() { late StartGameBloc startGameBloc; - late PinballPlayer pinballPlayer; + late PinballAudioPlayer pinballAudioPlayer; late CharacterThemeCubit characterThemeCubit; group('StartGameListener', () { @@ -28,7 +28,7 @@ void main() { await mockFlameImages(); startGameBloc = _MockStartGameBloc(); - pinballPlayer = _MockPinballPlayer(); + pinballAudioPlayer = _MockPinballAudioPlayer(); characterThemeCubit = _MockCharacterThemeCubit(); }); @@ -46,12 +46,14 @@ void main() { }); testWidgets( - 'calls onGameStarted event', + 'calls GameStarted event', (tester) async { whenListen( startGameBloc, Stream.value( - const StartGameState(status: StartGameStatus.selectCharacter), + const StartGameState( + status: StartGameStatus.selectCharacter, + ), ), initialState: const StartGameState.initial(), ); @@ -241,7 +243,7 @@ void main() { child: SizedBox.shrink(), ), startGameBloc: startGameBloc, - pinballPlayer: pinballPlayer, + pinballAudioPlayer: pinballAudioPlayer, ); await tester.pumpAndSettle(); @@ -258,7 +260,7 @@ void main() { ); await tester.pumpAndSettle(); - verify(() => pinballPlayer.play(PinballAudio.ioPinballVoiceOver)) + verify(() => pinballAudioPlayer.play(PinballAudio.ioPinballVoiceOver)) .called(1); }, ); diff --git a/web/index.html b/web/index.html index f60ae7ce..30eb9080 100644 --- a/web/index.html +++ b/web/index.html @@ -76,6 +76,10 @@ application. For more information, see: https://developers.google.com/web/fundamentals/primers/service-workers -->