rsnaker 0.2.1

A good old retro Snake in terminal UI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! # Game State Management
//!
//! This module defines a `GameState` struct that manages game-related flags
//! such as life, score, and game status.
//! It provides methods for initializing and resetting the game state.
//!
//! # Example
//! ```rust
//! use rsnaker::game_logic::state::{GameState, GameStatus};
//!
//! let mut state = GameState::new(3); // Initialize game_logic with 3 lives
//! assert_eq!(state.life, 3);
//! assert_eq!(state.score, 0);
//! assert_eq!(state.status, GameStatus::Playing);
//!
//! state.reset(); // Reset game_logic state
//! assert_eq!(state.life, 3);
//! assert_eq!(state.score, 0);
//! ```
//!

/// Represents the possible options in the Game Over menu.
#[derive(Debug, Clone, PartialEq, Copy, Default)]
pub enum GameOverMenu {
    #[default]
    // Because restart is the selected option by default after GameOver but will not restart
    // automatically unless pressing an entrance key or R
    Restart,
    Menu,
    Quit,
}

impl GameOverMenu {
    #[must_use]
    pub fn next(self) -> Self {
        match self {
            Self::Restart => Self::Menu,
            Self::Menu => Self::Quit,
            Self::Quit => Self::Restart,
        }
    }

    #[must_use]
    pub fn previous(self) -> Self {
        match self {
            Self::Restart => Self::Quit,
            Self::Menu => Self::Restart,
            Self::Quit => Self::Menu,
        }
    }
}

/// Represents the possible states of the game.
#[derive(Debug, Clone, PartialEq)]
pub enum GameStatus {
    Paused,                 // The game is currently paused
    GameOver(GameOverMenu), // The game has ended, default selected option in attribute
    ByeBye,                 // The game has exited
    Playing,                // The game is in progress
    Restarting,             // The game is restarting
    Menu,                   // The game is going or displaying the Main Menu
}

/// Manages the game state, including life count, score, and current status.
#[derive(Clone, Debug, PartialEq)]
pub struct GameState {
    pub life: u16,           // Current player life count
    pub score: u32,          // Current player score
    pub status: GameStatus,  // Current game status
    pub rank: Option<usize>, // Rank in high scores if game over
    life_ini: u16,           // Initial life count (used for reset)
}

impl GameState {
    /// Creates a new `GameState` with the specified initial life count.
    ///
    /// # Arguments
    /// * `life` - The initial number of lives the player starts with.
    ///
    /// # Returns
    /// A new instance of `GameState` with default values.
    #[must_use]
    pub fn new(life: u16) -> Self {
        Self {
            life,
            score: 0,
            status: GameStatus::Playing,
            rank: None,
            life_ini: life,
        }
    }

    /// Resets the game state to its initial values.
    pub fn reset(&mut self) {
        self.score = 0;
        self.status = GameStatus::Playing;
        self.rank = None;
        self.life = self.life_ini;
    }
}