pinball/lib/game/bloc/game_state.dart

// ignore_for_file: public_member_api_docs

part of 'game_bloc.dart';

/// Defines bonuses that a player can gain during a PinballGame.
enum GameBonus {
  /// Bonus achieved when the ball activates all Google letters.
  googleWord,

  /// Bonus achieved when the user activates all dash nest bumpers.
  dashNest,

  /// Bonus achieved when a ball enters Sparky's computer.
  sparkyTurboCharge,

  /// Bonus achieved when the ball goes in the dino mouth.
  dinoChomp,

  /// Bonus achieved when a ball enters the android spaceship.
  androidSpaceship,
}

/// {@template game_state}
/// Represents the state of the pinball game.
/// {@endtemplate}
class GameState extends Equatable {
  /// {@macro game_state}
  const GameState({
    required this.score,
    required this.multiplier,
    required this.rounds,
    required this.bonusHistory,
  })  : assert(score >= 0, "Score can't be negative"),
        assert(multiplier > 0, 'Multiplier must be greater than zero'),
        assert(rounds >= 0, "Number of rounds can't be negative");

  const GameState.initial()
      : score = 0,
        multiplier = 1,
        rounds = 3,
        bonusHistory = const [];

  /// The current score of the game.
  final int score;

  /// The current multiplier for the score.
  final int multiplier;

  /// The number of rounds left in the game.
  ///
  /// When the number of rounds is 0, the game is over.
  final int rounds;

  /// Holds the history of all the [GameBonus]es earned by the player during a
  /// PinballGame.
  final List<GameBonus> bonusHistory;

  /// Determines when the game is over.
  bool get isGameOver => rounds == 0;

  GameState copyWith({
    int? score,
    int? multiplier,
    int? balls,
    int? rounds,
    List<GameBonus>? bonusHistory,
  }) {
    assert(
      score == null || score >= this.score,
      "Score can't be decreased",
    );

    return GameState(
      score: score ?? this.score,
      multiplier: multiplier ?? this.multiplier,
      rounds: rounds ?? this.rounds,
      bonusHistory: bonusHistory ?? this.bonusHistory,
    );
  }

  @override
  List<Object?> get props => [
        score,
        multiplier,
        rounds,
        bonusHistory,
      ];
}