make chest's gold depend on level

src/artifacts.rs

@@ -1,6 +1,7 @@
 use ratatui::style::Color;
-use crate::position::Position;
+
 use crate::player::Player;
+use crate::position::Position;
 
 pub trait Artifact {
     //! An artifact that can be collected by the player
@@ -9,6 +10,7 @@ pub trait Artifact {
     fn get_immutable_position(&self) -> &Position;
     /// call to apply the effects of the artifact to the player
     fn collect(&mut self, player: &mut Player);
+    /// returns if the artifact was collected and can be removed from the level
     fn was_collected(&self) -> bool;
 }
 
@@ -20,9 +22,11 @@ pub struct Chest {
 
 impl Chest {
     pub fn new(position: Position) -> Self {
+        let level = position.get_level();
         Self {
             position,
-            gold: 10,
+            // TODO maybe randomize this?
+            gold: (level + 1) * 10,
         }
     }
 }

src/game.rs

@@ -1,15 +1,28 @@
-use crate::artifacts::Artifact;
 use crate::level::{Level, StructureElement};
 use crate::level_generator::LevelGenerator;
-use crate::monster::Monster;
 use crate::player::Player;
 use crate::position::Position;
 
-pub const LEVELS: usize = 2;
+pub const LEVELS: usize = 10;
 
+#[derive(PartialEq)]
+/// represents a state of a game
+pub enum GameState {
+    /// the game is ongoing (neither won or lost)
+    RUNNING,
+    /// the player died
+    LOST,
+    /// the player reached the Ω
+    WON,
+}
+
+
+/// the main structure to hold all information about the ongoing game
 pub struct Game {
-    pub player: Player,
+    /// the player
-    pub levels: Vec<Level>,
+    player: Player,
+    /// the levels of the game
+    levels: Vec<Level>,
 }
 
 impl Game {
@@ -30,6 +43,31 @@ impl Game {
         g
     }
 
+    /// returns true if the player is dead (life <= 0)
+    fn player_is_dead(&self) -> bool { self.get_player().get_life() <= 0 }
+    /// returns true if the player is standing on the End element
+    fn player_reached_goal(&mut self) -> bool {
+        match self.next_element(0, 0) {
+            None => {}
+            Some(a) => {
+                match a {
+                    StructureElement::End => { return true; }
+                    _ => {}
+                }
+            }
+        };
+        false
+    }
+    /// returns the state of the game (depending on player's life and position)
+    pub fn get_game_state(&mut self) -> GameState {
+        if self.player_is_dead() {
+            return GameState::LOST;
+        }
+        if self.player_reached_goal() {
+            return GameState::WON;
+        }
+        GameState::RUNNING
+    }
     pub fn get_player(&self) -> &Player {
         &self.player
     }
@@ -38,6 +76,8 @@ impl Game {
     }
     pub fn get_level(&self, level: usize) -> &Level { &self.levels[level] }
     pub fn get_mutable_level(&mut self, level: usize) -> &mut Level { &mut self.levels[level] }
+    /// check if the player can move in the given direction. This only checks for structure element
+    /// limitation as walls.
     fn can_move(&mut self, dx: i16, dy: i16) -> bool {
         let player_pos = &self.player.get_position();
         let new_x: i16 = player_pos.get_x() as i16 + dx;
@@ -54,25 +94,32 @@ impl Game {
         };
         true
     }
+    /// returns the position (as tuple) of the next level's start point.
     fn next_start(&self) -> (usize, usize, usize) {
         let level = self.player.get_immutable_position().get_level() + 1;
         let (x, y) = self.levels[level].start;
         (level, x, y)
     }
+    /// returns the position (as tuple) of the previous level's end point.
     fn prev_end(&self) -> (usize, usize, usize) {
         let level = self.player.get_immutable_position().get_level() - 1;
         let (x, y) = self.levels[level].end;
         (level, x, y)
     }
-    fn next_element(&mut self, dx: i16, dy: i16) -> (Option<StructureElement>, Option<&mut Monster>, Option<&mut Box<(dyn Artifact + 'static)>>) {
+    /// get the next structure element sen from the player's position into the given direction.
+    fn next_element(&mut self, dx: i16, dy: i16) -> Option<StructureElement> {
         let player_pos = &self.player.get_position();
         let new_x: i16 = player_pos.get_x() as i16 + dx;
         let new_y: i16 = player_pos.get_y() as i16 + dy;
         let player_level = player_pos.get_level();
         let level = &mut self.levels[player_level];
-        level.get_element(new_x, new_y)
+        level.get_element(new_x, new_y).0
     }
 
+    /// move the game's player into the given direction. If on the target field there is a stair,
+    /// the player follows the stair up/down to the next level.
+    /// Discovery is performed on the new location of the player.
+    /// The returned value is the direction that will bring the player back to his original field.
     pub fn move_player(&mut self, mut dx: i16, mut dy: i16) -> (i16, i16) {
         // verify the player can do the move
         if !self.can_move(dx, dy) {
@@ -81,7 +128,7 @@ impl Game {
 
         let player_pos = &self.player.get_position();
         let mut player_level = player_pos.get_level();
-        let (structure, _, _) = self.next_element(dx, dy);
+        let structure = self.next_element(dx, dy);
 
         // use stairs if walked onto one
         match structure {
@@ -138,6 +185,7 @@ impl Game {
             }
         }
     }
+    /// updates the player's current level. This will remove collected artifacts and dead monsters.
     pub fn update_level(&mut self) {
         let player_pos = &self.player.get_immutable_position();
         let player_level = player_pos.get_level();

src/level.rs

@@ -1,8 +1,11 @@
 use std::cmp::{max, min};
-use crate::artifacts::Artifact;
+
 #[cfg(test)]
 use crate::artifacts::{Chest, Potion};
+use crate::artifacts::Artifact;
 use crate::monster::Monster;
+#[cfg(test)]
+use crate::monster::Rat;
 use crate::position::Position;
 
 pub const LEVEL_WIDTH: usize = 50;
@@ -23,7 +26,7 @@ pub struct Level {
     pub(crate) level: usize,
     pub(crate) structure: [[StructureElement; LEVEL_HEIGHT]; LEVEL_WIDTH],
     pub(crate) discovered: [[bool; LEVEL_HEIGHT]; LEVEL_WIDTH],
-    pub(crate) monsters: Vec<Monster>,
+    pub(crate) monsters: Vec<Box<dyn Monster>>,
     pub(crate) artifacts: Vec<Box<dyn Artifact>>,
     /// the position of the start in the level (either stair up or start point)
     pub(crate) start: (usize, usize),
@@ -50,7 +53,7 @@ impl Level {
             end: (0, 0),
         }
     }
-    pub fn get_element(&mut self, x: i16, y: i16) -> (Option<StructureElement>, Option<&mut Monster>, Option<&mut Box<(dyn Artifact + 'static)>>) {
+    pub fn get_element(&mut self, x: i16, y: i16) -> (Option<StructureElement>, Option<&mut Box<(dyn Monster + 'static)>>, Option<&mut Box<(dyn Artifact + 'static)>>) {
         if x < 0 || y < 0 {
             return (None, None, None);
         }
@@ -63,7 +66,7 @@ impl Level {
             return (Some(StructureElement::Unknown), None, None);
         }
         let search_pos = &Position::new(self.level, x, y);
-        let mut res_m: Option<&mut Monster> = None;
+        let mut res_m: Option<&mut Box<dyn Monster>> = None;
         for m in &mut self.monsters {
             if m.get_immutable_position() == search_pos {
                 res_m = Some(m);
@@ -78,7 +81,7 @@ impl Level {
         (Some(self.structure[x][y]), res_m, res_a)
     }
     #[cfg(test)]
-    pub fn add_monster(&mut self, mut monster: Monster) -> Result<(), String> {
+    pub fn add_monster(&mut self, mut monster: impl Monster + 'static) -> Result<(), String> {
         if self.level != monster.get_position().get_level() {
             return Err("Wrong Level".to_string());
         }
@@ -87,7 +90,7 @@ impl Level {
                 return Err("Position already used".to_string());
             }
         }
-        self.monsters.push(monster);
+        self.monsters.push(Box::new(monster));
         Ok(())
     }
 
@@ -190,19 +193,19 @@ fn test_discover_get_element() {
 #[test]
 fn test_discover_can_add_monster() {
     let mut l = Level::new(0);
-    let mut m = Monster::new(2);
+    let mut m = Rat::new(2);
     m.get_position().set(1, 2, 3);
     assert_eq!(l.add_monster(m), Err("Wrong Level".to_string()));
 
-    let mut m = Monster::new(2);
+    let mut m = Rat::new(2);
     m.get_position().set(0, 2, 3);
     assert_eq!(l.add_monster(m), Ok(()));
 
-    let mut m = Monster::new(2);
+    let mut m = Rat::new(2);
     m.get_position().set(0, 2, 3);
     assert_eq!(l.add_monster(m), Err("Position already used".to_string()));
 
-    let mut m = Monster::new(2);
+    let mut m = Rat::new(2);
     m.get_position().set(0, 2, 4);
     assert_eq!(l.add_monster(m), Ok(()));
 }
@@ -231,7 +234,7 @@ fn test_discover_get_monster() {
     assert_eq!(l.get_element(10, 10).0.unwrap(), StructureElement::Floor);
     assert!(l.get_element(10, 10).1.is_none());
 
-    let mut m = Monster::new(23);
+    let mut m = Rat::new(23);
     m.get_position().set(0, 10, 10);
     assert_eq!(l.add_monster(m), Ok(()));
 
@@ -267,7 +270,7 @@ fn test_discover_get_monster_can_move() {
     let p = Position::new(0, 10, 10);
     l.discover(&p);
 
-    let mut m = Monster::new(23);
+    let mut m = Rat::new(23);
     m.get_position().set(0, 10, 10);
     l.add_monster(m).expect("Panic because of");
 

src/level_generator.rs

@@ -9,9 +9,9 @@ use rand::prelude::SliceRandom;
 use rand::Rng;
 use rand::rngs::ThreadRng;
 
-use crate::level::{Level, StructureElement};
-use crate::monster::Monster;
 use crate::artifacts::{Artifact, Chest, Potion};
+use crate::level::{Level, StructureElement};
+use crate::monster::{Monster, Orc, Rat};
 use crate::position::Position;
 
 const ROOMS_VERTICAL: usize = 7;
@@ -246,7 +246,7 @@ impl LevelGenerator {
         let mut rng = rand::thread_rng();
         let mut structure = [[StructureElement::Wall; 1 + ROOMS_HORIZONTAL * ROOM_HEIGHT]; 1 + ROOMS_VERTICAL * ROOM_WIDTH];
         let mut artifacts: Vec<Box<dyn Artifact>> = Vec::with_capacity(10);
-        let mut enemies: Vec<Monster> = Vec::with_capacity(10);
+        let mut enemies: Vec<Box<dyn Monster>> = Vec::with_capacity(10);
         let mut start_x: usize = 0;
         let mut start_y: usize = 0;
         let mut end_x: usize = 0;
@@ -274,7 +274,14 @@ impl LevelGenerator {
                     let t_x = left + room.offset_x + rng.gen_range(0..room.width);
                     let t_y = top + room.offset_y + rng.gen_range(0..room.height);
                     // TODO randomize enemies here
-                    enemies.push(Monster::new_with_position(2, Position::new(self.level, t_x, t_y)));
+                    match rng.gen_range(1..=100) {
+                        1..=50 => {
+                            enemies.push(Box::new(Orc::new_with_position(Position::new(self.level, t_x, t_y))));
+                        }
+                        _ => {
+                            enemies.push(Box::new(Rat::new_with_position(Position::new(self.level, t_x, t_y))));
+                        }
+                    };
                 }
 
                 if room.kind == RoomType::End || room.kind == RoomType::StairDown {

src/level_widget.rs

@@ -65,8 +65,9 @@ impl StatefulWidget for LevelWidget {
                                 }
                             }
                         }
-                        (_, Some(_), _) => {
+                        (_, Some(m), _) => {
-                            self.set_cell(buf, x, y, "M", Color::Red, Color::Gray);
+                            let (s, c) = m.get_representation();
+                            self.set_cell(buf, x, y, s, c, Color::Gray);
                         }
                         (_, _, Some(t)) => {
                             let (s, c) = t.get_representation();

src/main.rs

@@ -11,10 +11,11 @@ use ratatui::{
     widgets::Paragraph,
 };
 use ratatui::prelude::*;
-use ratatui::widgets::Block;
+use ratatui::widgets::{Block, Borders, BorderType, Wrap};
+use ratatui::widgets::block::{Position, Title};
 use whoami::realname;
 
-use crate::game::Game;
+use crate::game::{Game, GameState};
 use crate::level_widget::LevelWidget;
 // use crate::level_widget::LevelWidget;
 use crate::player::Player;
@@ -96,6 +97,48 @@ fn main() -> Result<()> {
                     }
                     game.player_collects_artifact();
                     game.update_level();
+                    if game.get_game_state() != GameState::RUNNING {
+                        break;
+                    }
+                }
+            }
+        }
+    }
+    loop {
+        let _ = terminal.draw(|frame| {
+            let mut area = frame.size();
+            let w = area.width / 2;
+            let h = area.height / 2;
+            area.x += w - 20;
+            area.y += h - 10;
+            area.width = 40;
+            area.height = 20;
+            let block = Block::default()
+                .title("Game ended")
+                .title(Title::from("Press `q` to quit!").position(Position::Bottom))
+                .borders(Borders::ALL)
+                .border_style(Style::default().fg(Color::White))
+                .border_type(BorderType::Rounded)
+                .style(Style::default().bg(Color::Black));
+            let mut text = match game.get_game_state() {
+                GameState::RUNNING => {
+                    "Quitting is for cowards! You'll better try again!".to_string()
+                }
+                GameState::LOST => {
+                    "Sorry, you died in the dungeon. Better luck next time!".to_string()
+                }
+                GameState::WON => {
+                    "Congratulation! You mastered your way through the dungeon and won the game.".to_string()
+                }
+            };
+            text += format!("\nYou collected {} gold.", game.get_player().get_gold()).as_str();
+            let paragraph = Paragraph::new(text).block(block).wrap(Wrap { trim: true });
+            frame.render_widget(paragraph, area);
+        });
+        if event::poll(std::time::Duration::from_millis(16))? {
+            if let event::Event::Key(key) = event::read()? {
+                if key.kind == KeyEventKind::Press && key.code == KeyCode::Char('q') {
+                    break;
                 }
             }
         }

src/monster.rs

@@ -1,42 +1,104 @@
+use ratatui::prelude::Color;
+
 use crate::position::Position;
 
-pub struct Monster {
+pub trait Monster {
-    life: usize,
+    fn is_dead(&self) -> bool;
-    position: Position,
+    fn get_representation(&self) -> (&str, Color);
+    fn decrease_life(&mut self, by: usize);
+    fn get_immutable_position(&self) -> &Position;
+    #[cfg(test)]
+    fn get_position(&mut self) -> &mut Position;
+    #[cfg(test)]
+    fn get_life(&self) -> usize;
 }
 
-impl Monster {
+macro_rules! default_monster {
+    ($($t:ty),+ $(,)?) => ($(
+        impl Monster for $t {
+            fn is_dead(&self) -> bool { self.life <= 0 }
+            fn get_representation(&self) -> (&str, Color) { (&self.symbol, self.color) }
+            fn decrease_life(&mut self, by: usize) {
+                self.life = self.life.saturating_sub(by);
+            }
+            fn get_immutable_position(&self) -> &Position {
+                &self.position
+            }
+            #[cfg(test)]
+            fn get_position(&mut self) -> &mut Position {
+                &mut self.position
+            }
+            #[cfg(test)]
+            fn get_life(&self) -> usize { self.life }
+        }
+    )+)
+}
+
+pub struct Rat {
+    life: usize,
+    position: Position,
+    symbol: String,
+    color: Color,
+}
+
+impl Rat {
     #[cfg(test)]
     pub fn new(life: usize) -> Self {
-        Monster {
+        Self {
             life,
             position: Position::new(0, 0, 0),
+            symbol: String::from("R"),
+            color: Color::Black,
         }
     }
-    pub fn new_with_position(life: usize, position: Position) -> Self {
+    pub fn new_with_position(position: Position) -> Self {
-        Monster {
+        Self {
-            life,
+            life: 2,
             position,
+            symbol: String::from("R"),
+            color: Color::Black,
         }
     }
     #[cfg(test)]
     pub fn get_life(&self) -> usize { self.life }
-    pub fn is_dead(&self) -> bool { self.life <= 0 }
+}
-    pub fn decrease_life(&mut self, by: usize) {
+default_monster!(Rat);
-        self.life = self.life.saturating_sub(by);
+
+pub struct Orc {
+    life: usize,
+    position: Position,
+    symbol: String,
+    color: Color,
+}
+
+impl Orc {
+    #[cfg(test)]
+    pub fn new(life: usize) -> Self {
+        Self {
+            life,
+            position: Position::new(0, 0, 0),
+            symbol: String::from("O"),
+            color: Color::DarkGray,
+        }
+    }
+    pub fn new_with_position(position: Position) -> Self {
+        Self {
+            life: 4,
+            position,
+            symbol: String::from("O"),
+            color: Color::DarkGray,
+        }
     }
     #[cfg(test)]
-    pub fn get_position(&mut self) -> &mut Position {
+    pub fn get_life(&self) -> usize { self.life }
-        &mut self.position
-    }
-    pub fn get_immutable_position(&self) -> &Position {
-        &self.position
-    }
 }
 
+default_monster!(Orc);
+
+
 #[test]
 fn monsters_can_move() {
-    let mut m = Monster::new(2);
+    let mut m = Rat::new(2);
     assert_eq!(m.get_position(), &Position::new(0, 0, 0));
     m.get_position().change(1, 2);
     assert_eq!(m.get_position(), &Position::new(0, 1, 2));
@@ -49,7 +111,7 @@ fn monsters_can_move() {
 
 #[test]
 fn monsters_can_die() {
-    let mut m = Monster::new(2);
+    let mut m = Rat::new(2);
     assert_eq!(m.get_life(), 2);
     assert_eq!(m.is_dead(), false);
     m.decrease_life(1);

src/player.rs

@@ -1,4 +1,5 @@
 use std::cmp::{max, min};
+
 use crate::position::Position;
 
 pub struct Player {