refactor: flamebloclistenable

3 years ago · ada5ada264
parent 1a39737cf6
commit ada5ada264
11 changed files with 101 additions and 131 deletions
--- a/lib/game/components/android_acres/behaviors/ramp_bonus_behavior.dart
+++ b/lib/game/components/android_acres/behaviors/ramp_bonus_behavior.dart
@ -1,15 +1,15 @@
-import 'dart:async';
-
 import 'package:flame/components.dart';
 import 'package:flame_bloc/flame_bloc.dart';
 import 'package:pinball/game/behaviors/behaviors.dart';
 import 'package:pinball_components/pinball_components.dart';
-import 'package:pinball_flame/pinball_flame.dart';

 /// {@template ramp_bonus_behavior}
 /// Increases the score when a [Ball] is shot 10 times into the [SpaceshipRamp].
 /// {@endtemplate}
-class RampBonusBehavior extends Component with ParentIsA<FlameBlocProvider> {
+class RampBonusBehavior extends Component
+    with
+        HasGameRef,
+        FlameBlocListenable<SpaceshipRampCubit, SpaceshipRampState> {
  /// {@macro ramp_bonus_behavior}
  RampBonusBehavior({
    required Points points,
@ -19,27 +19,25 @@ class RampBonusBehavior extends Component with ParentIsA<FlameBlocProvider> {
  final Points _points;

  @override
-  Future<void> onLoad() async {
-    await super.onLoad();
-    await add(
-      FlameBlocListener<SpaceshipRampCubit, SpaceshipRampState>(
-        listenWhen: (previousState, newState) {
+  bool listenWhen(
+    SpaceshipRampState previousState,
+    SpaceshipRampState newState,
+  ) {
    final hasChanged = previousState.hits != newState.hits;
    final hasHit = newState.hits != 0;
    final achievedOneMillionPoints = newState.hits % 10 == 0;

    return hasChanged && hasHit && achievedOneMillionPoints;
-        },
-        onNewState: (state) {
-          parent.add(
+  }
+
+  @override
+  void onNewState(SpaceshipRampState state) {
+    gameRef.add(
      ScoringBehavior(
        points: _points,
        position: Vector2(0, -60),
        duration: 2,
      ),
    );
-        },
-      ),
-    );
  }
 }
--- a/lib/game/components/android_acres/behaviors/ramp_multiplier_behavior.dart
+++ b/lib/game/components/android_acres/behaviors/ramp_multiplier_behavior.dart
@ -1,36 +1,27 @@
-import 'dart:async';
-
 import 'package:flame/components.dart';
 import 'package:flame_bloc/flame_bloc.dart';
 import 'package:pinball/game/game.dart';
 import 'package:pinball_components/pinball_components.dart';
 import 'package:pinball_flame/pinball_flame.dart';

-/// {@template ramp_multiplier_behavior}
 /// Increases the multiplier when a [Ball] is shot 5 times into the
 /// [SpaceshipRamp].
-/// {@endtemplate}
-class RampMultiplierBehavior extends Component {
-  /// {@macro ramp_multiplier_behavior}
-  RampMultiplierBehavior() : super();
-
+class RampMultiplierBehavior extends Component
+    with FlameBlocListenable<SpaceshipRampCubit, SpaceshipRampState> {
  @override
-  Future<void> onLoad() async {
-    await super.onLoad();
-    await add(
-      FlameBlocListener<SpaceshipRampCubit, SpaceshipRampState>(
-        listenWhen: (previousState, newState) {
+  bool listenWhen(
+    SpaceshipRampState previousState,
+    SpaceshipRampState newState,
+  ) {
    final hasChanged =
        previousState.hits != newState.hits && newState.hits != 0;
    final achievedFiveShots = newState.hits % 5 == 0;
-          final canIncrease =
-              readBloc<GameBloc, GameState>().state.multiplier != 6;
+    final canIncrease = readBloc<GameBloc, GameState>().state.multiplier != 6;
    return hasChanged && achievedFiveShots && canIncrease;
-        },
-        onNewState: (state) {
+  }
+
+  @override
+  void onNewState(SpaceshipRampState state) {
    readBloc<GameBloc, GameState>().add(const MultiplierIncreased());
-        },
-      ),
-    );
  }
 }
--- a/lib/game/components/android_acres/behaviors/ramp_progress_behavior.dart
+++ b/lib/game/components/android_acres/behaviors/ramp_progress_behavior.dart
@ -1,29 +1,24 @@
-import 'dart:async';
-
 import 'package:flame/components.dart';
 import 'package:flame_bloc/flame_bloc.dart';
 import 'package:pinball/game/game.dart';
 import 'package:pinball_components/pinball_components.dart';
 import 'package:pinball_flame/pinball_flame.dart';

-/// {@template ramp_progress_behavior}
 /// Changes arrow lit when a [Ball] is shot into the [SpaceshipRamp].
-/// {@endtemplate}
-class RampProgressBehavior extends Component {
-  /// {@macro ramp_progress_behavior}
-  RampProgressBehavior() : super();
+class RampProgressBehavior extends Component
+    with FlameBlocListenable<SpaceshipRampCubit, SpaceshipRampState> {
+  @override
+  bool listenWhen(
+    SpaceshipRampState previousState,
+    SpaceshipRampState newState,
+  ) {
+    return previousState.hits != newState.hits && newState.hits != 0;
+  }

  @override
-  Future<void> onLoad() async {
-    await super.onLoad();
-    await add(
-      FlameBlocListener<SpaceshipRampCubit, SpaceshipRampState>(
-        listenWhen: (previousState, newState) =>
-            previousState.hits != newState.hits && newState.hits != 0,
-        onNewState: (state) {
+  void onNewState(SpaceshipRampState state) {
    final gameBloc = readBloc<GameBloc, GameState>();
-          final spaceshipCubit =
-              readBloc<SpaceshipRampCubit, SpaceshipRampState>();
+    final spaceshipCubit = readBloc<SpaceshipRampCubit, SpaceshipRampState>();

    final canProgress = !gameBloc.state.isMaxMultiplier ||
        (gameBloc.state.isMaxMultiplier && !state.fullArrowLit);
@ -32,12 +27,8 @@ class RampProgressBehavior extends Component {
      spaceshipCubit.onProgressed();
    }

-          if (spaceshipCubit.state.fullArrowLit &&
-              !gameBloc.state.isMaxMultiplier) {
+    if (spaceshipCubit.state.fullArrowLit && !gameBloc.state.isMaxMultiplier) {
      spaceshipCubit.onProgressed();
    }
-        },
-      ),
-    );
  }
 }
--- a/lib/game/components/android_acres/behaviors/ramp_reset_behavior.dart
+++ b/lib/game/components/android_acres/behaviors/ramp_reset_behavior.dart
@ -4,24 +4,16 @@ import 'package:pinball/game/game.dart';
 import 'package:pinball_components/pinball_components.dart';
 import 'package:pinball_flame/pinball_flame.dart';

-/// {@template ramp_reset_behavior}
 /// Reset [SpaceshipRamp] state when GameState.rounds changes.
-/// /// {@endtemplate}
-class RampResetBehavior extends Component {
-  /// {@macro ramp_reset_behavior}
-  RampResetBehavior() : super();
+class RampResetBehavior extends Component
+    with FlameBlocListenable<GameBloc, GameState> {
+  @override
+  bool listenWhen(GameState previousState, GameState newState) {
+    return previousState.rounds != newState.rounds;
+  }

  @override
-  Future<void> onLoad() async {
-    await super.onLoad();
-    await add(
-      FlameBlocListener<GameBloc, GameState>(
-        listenWhen: (previousState, newState) =>
-            previousState.rounds != newState.rounds,
-        onNewState: (state) {
+  void onNewState(GameState state) {
    readBloc<SpaceshipRampCubit, SpaceshipRampState>().onReset();
-        },
-      ),
-    );
  }
 }
--- a/lib/game/components/android_acres/behaviors/ramp_shot_behavior.dart
+++ b/lib/game/components/android_acres/behaviors/ramp_shot_behavior.dart
@ -1,15 +1,15 @@
-import 'dart:async';
-
 import 'package:flame/components.dart';
 import 'package:flame_bloc/flame_bloc.dart';
 import 'package:pinball/game/behaviors/behaviors.dart';
 import 'package:pinball_components/pinball_components.dart';
-import 'package:pinball_flame/pinball_flame.dart';

 /// {@template ramp_shot_behavior}
 /// Increases the score when a [Ball] is shot into the [SpaceshipRamp].
 /// {@endtemplate}
-class RampShotBehavior extends Component with ParentIsA<FlameBlocProvider> {
+class RampShotBehavior extends Component
+    with
+        HasGameRef,
+        FlameBlocListenable<SpaceshipRampCubit, SpaceshipRampState> {
  /// {@macro ramp_shot_behavior}
  RampShotBehavior({
    required Points points,
@ -19,21 +19,20 @@ class RampShotBehavior extends Component with ParentIsA<FlameBlocProvider> {
  final Points _points;

  @override
-  Future<void> onLoad() async {
-    await super.onLoad();
-    await add(
-      FlameBlocListener<SpaceshipRampCubit, SpaceshipRampState>(
-        listenWhen: (previousState, newState) =>
-            previousState.hits != newState.hits && newState.hits != 0,
-        onNewState: (state) {
-          parent.add(
+  bool listenWhen(
+    SpaceshipRampState previousState,
+    SpaceshipRampState newState,
+  ) {
+    return previousState.hits != newState.hits && newState.hits != 0;
+  }
+
+  @override
+  void onNewState(SpaceshipRampState state) {
+    gameRef.add(
      ScoringBehavior(
        points: _points,
        position: Vector2(0, -45),
      ),
    );
-        },
-      ),
-    );
  }
 }
--- a/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_cubit.dart
+++ b/packages/pinball_components/lib/src/components/spaceship_ramp/cubit/spaceship_ramp_cubit.dart
@ -25,10 +25,7 @@ class SpaceshipRampCubit extends Cubit<SpaceshipRampState> {

  void onReset() {
    emit(
-      const SpaceshipRampState(
-        hits: 0,
-        lightState: ArrowLightState.inactive,
-      ),
+      const SpaceshipRampState.initial(),
    );
  }
 }
--- a/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart
+++ b/packages/pinball_components/lib/src/components/spaceship_ramp/spaceship_ramp.dart
@ -171,7 +171,11 @@ class _SpaceshipRampBackgroundRampSpriteComponent extends SpriteComponent
 /// {@endtemplate}
@visibleForTesting
 class SpaceshipRampArrowSpriteComponent
-    extends SpriteGroupComponent<ArrowLightState> with HasGameRef, ZIndex {
+    extends SpriteGroupComponent<ArrowLightState>
+    with
+        HasGameRef,
+        ZIndex,
+        FlameBlocListenable<SpaceshipRampCubit, SpaceshipRampState> {
  /// {@macro spaceship_ramp_arrow_sprite_component}
  SpaceshipRampArrowSpriteComponent()
      : super(
@ -181,17 +185,22 @@ class SpaceshipRampArrowSpriteComponent
    zIndex = ZIndexes.spaceshipRampArrow;
  }

+  @override
+  bool listenWhen(
+    SpaceshipRampState previousState,
+    SpaceshipRampState newState,
+  ) {
+    return previousState.lightState != newState.lightState;
+  }
+
+  @override
+  void onNewState(SpaceshipRampState state) {
+    current = state.lightState;
+  }
+
  @override
  Future<void> onLoad() async {
    await super.onLoad();
-    await add(
-      FlameBlocListener<SpaceshipRampCubit, SpaceshipRampState>(
-        listenWhen: (previousState, newState) =>
-            previousState.lightState != newState.lightState,
-        onNewState: (state) => current = state.lightState,
-      ),
-    );
-
    final sprites = <ArrowLightState, Sprite>{};
    this.sprites = sprites;
    for (final spriteState in ArrowLightState.values) {
--- a/packages/pinball_components/sandbox/pubspec.lock
+++ b/packages/pinball_components/sandbox/pubspec.lock
@ -107,7 +107,7 @@ packages:
    source: hosted
    version: "1.1.1"
  flame_bloc:
-    dependency: "direct main"
+    dependency: transitive
    description:
      name: flame_bloc
      url: "https://pub.dartlang.org"
--- a/packages/pinball_components/sandbox/pubspec.yaml
+++ b/packages/pinball_components/sandbox/pubspec.yaml
@ -9,7 +9,6 @@ environment:
 dependencies:
  dashbook: ^0.1.7
  flame: ^1.1.1
-  flame_bloc: ^1.4.0
  flame_forge2d:
    git: 
      url: https://github.com/flame-engine/flame
--- a/test/game/components/android_acres/behaviors/ramp_multiplier_behavior_test.dart
+++ b/test/game/components/android_acres/behaviors/ramp_multiplier_behavior_test.dart
@ -28,9 +28,6 @@ class _TestGame extends Forge2DGame {
      Assets.images.android.ramp.arrow.active3.keyName,
      Assets.images.android.ramp.arrow.active4.keyName,
      Assets.images.android.ramp.arrow.active5.keyName,
-      Assets.images.android.rail.main.keyName,
-      Assets.images.android.rail.exit.keyName,
-      Assets.images.score.fiveThousand.keyName,
    ]);
  }

--- a/test/game/components/android_acres/behaviors/ramp_progress_behavior_test.dart
+++ b/test/game/components/android_acres/behaviors/ramp_progress_behavior_test.dart
@ -28,9 +28,6 @@ class _TestGame extends Forge2DGame {
      Assets.images.android.ramp.arrow.active3.keyName,
      Assets.images.android.ramp.arrow.active4.keyName,
      Assets.images.android.ramp.arrow.active5.keyName,
-      Assets.images.android.rail.main.keyName,
-      Assets.images.android.rail.exit.keyName,
-      Assets.images.score.fiveThousand.keyName,
    ]);
  }