feat: adding FlameBloc mixin to allow its usage with enhanced FlameGa…

…me classes (#1399)

* feat: adding FlameBloc mixin to allow its usage with enhanced FlameGame classes

* fixing tests

* Apply suggestions from code review

Co-authored-by: Lukas Klingsbo <me@lukas.fyi>
Co-authored-by: Pasha Stetsenko <stpasha@google.com>
Co-authored-by: Luan Nico <luanpotter27@gmail.com>

Co-authored-by: Lukas Klingsbo <me@lukas.fyi>
Co-authored-by: Pasha Stetsenko <stpasha@google.com>
Co-authored-by: Luan Nico <luanpotter27@gmail.com>

packages/flame_bloc/README.md

@@ -15,6 +15,11 @@ BlocProvider<ExampleGame>(
 )
 ```
 
+To enable the features of `flame_bloc` in your game, you can make your game class inherit from
+`FlameBlocGame`, or if you are already using an enhanced `FlameGame` class (like for example a
+`Forge2DGame`), the `FlameBloc` mixin can be used instead.
+
+
 To access the bloc from inside your game, the `read` method can be used.
 
 ```dart

packages/flame_bloc/example/lib/src/game/game.dart

@@ -1,4 +1,5 @@
 import 'package:flame/components.dart';
+import 'package:flame/game.dart';
 import 'package:flame/input.dart';
 import 'package:flame_bloc/flame_bloc.dart';
 
@@ -23,8 +24,8 @@ class GameStatsController extends Component
  }
 }
 
-class SpaceShooterGame extends FlameBlocGame
- with PanDetector, HasCollidables, HasKeyboardHandlerComponents {
+class SpaceShooterGame extends FlameGame
+ with FlameBloc, PanDetector, HasCollidables, HasKeyboardHandlerComponents {
  late PlayerComponent player;
 
  @override

packages/flame_bloc/lib/src/flame_bloc_game.dart

@@ -20,7 +20,7 @@ mixin BlocComponent<B extends BlocBase<S>, S> on Component {
  /// Makes this component subscribe to the Bloc changes.
  /// Visible only for test purposes.
  @visibleForTesting
- void subscribe(FlameBlocGame game) {
+ void subscribe(FlameBloc game) {
  final _bloc = game.read<B>();
  _state = _bloc.state;
 
@@ -60,10 +60,10 @@ mixin BlocComponent<B extends BlocBase<S>, S> on Component {
  void onMount() {
  super.onMount();
  assert(
- findGame()! is FlameBlocGame,
- 'BlocComponent can only be added to a FlameBlocGame',
+ findGame()! is FlameBloc,
+ 'BlocComponent can only be added to a FlameBloc game',
  );
- final game = findGame()! as FlameBlocGame;
+ final game = findGame()! as FlameBloc;
  if (game.isAttached) {
  subscribe(game);
  } else {
@@ -79,13 +79,9 @@ mixin BlocComponent<B extends BlocBase<S>, S> on Component {
  }
 }
 
-/// An enhanced [FlameGame] that has the capability to listen
+/// A mixin that enhances a [FlameGame] enabling features to receive
 /// and emit changes to a [Bloc] state.
-class FlameBlocGame extends FlameGame {
- /// FlameBlocGame constructor with an optional [Camera] as a parameter to
- /// FlameGame.
- FlameBlocGame({Camera? camera}) : super(camera: camera);
-
+mixin FlameBloc on FlameGame {
  /// Contains a list of all of the [BlocComponent]s with an active
  /// subscription. Only visible for testing.
  @visibleForTesting
@@ -132,3 +128,10 @@ class FlameBlocGame extends FlameGame {
  });
  }
 }
+
+/// Provides a default, concrete implementation of a [FlameBloc] game.
+class FlameBlocGame extends FlameGame with FlameBloc {
+ /// FlameBlocGame constructor with an optional [Camera] as a parameter to
+ /// FlameGame.
+ FlameBlocGame({Camera? camera}) : super(camera: camera);
+}

packages/flame_bloc/test/flame_bloc_game_test.dart

@@ -31,7 +31,7 @@ class MockInventoryComponent extends Component
  int numSubscribeCalls = 0;
 
  @override
- void subscribe(FlameBlocGame game) {
+ void subscribe(FlameBloc game) {
  numSubscribeCalls++;
  }
 }