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,
}

enum GameStatus {
  waiting,
  playing,
  gameOver,
}

extension GameStatusX on GameStatus {
  bool get isPlaying => this == GameStatus.playing;
  bool get isGameOver => this == GameStatus.gameOver;
}

/// {@template game_state}
/// Represents the state of the pinball game.
/// {@endtemplate}
class GameState extends Equatable {
  /// {@macro game_state}
  const GameState({
    required this.totalScore,
    required this.roundScore,
    required this.multiplier,
    required this.rounds,
    required this.bonusHistory,
    required this.status,
  })  : assert(totalScore >= 0, "TotalScore can't be negative"),
        assert(roundScore >= 0, "Round 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()
      : status = GameStatus.waiting,
        totalScore = 0,
        roundScore = 0,
        multiplier = 1,
        rounds = 3,
        bonusHistory = const [];

  /// The score for the current round of the game.
  ///
  /// Multipliers are only applied to the score for the current round once is
  /// lost. Then the [roundScore] is added to the [totalScore] and reset to 0
  /// for the next round.
  final int roundScore;

  /// The total score of the game.
  final int totalScore;

  /// 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;

  final GameStatus status;

  /// The score displayed at the game.
  int get displayScore => roundScore + totalScore;

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

    return GameState(
      totalScore: totalScore ?? this.totalScore,
      roundScore: roundScore ?? this.roundScore,
      multiplier: multiplier ?? this.multiplier,
      rounds: rounds ?? this.rounds,
      bonusHistory: bonusHistory ?? this.bonusHistory,
      status: status ?? this.status,
    );
  }

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