Diff: Stats.h

Revision:

10:c5ef17e93872

Parent:

9:b9ad5e45aebf

Child:

11:deba1e6f8d78

diff -r b9ad5e45aebf -r c5ef17e93872 Stats.h
--- a/Stats.h	Mon May 01 13:02:42 2017 +0000
+++ b/Stats.h	Tue May 02 22:13:28 2017 +0000
@@ -10,17 +10,104 @@
 {
 
 public:
+    
+    /// Constructors and destructors:
     Stats();
     ~Stats();
     
-    void grid_draw(N5110 &lcd);
-    void wave_draw(N5110 &lcd, int wave_counter);
+    
+    ////////////////////////////////
+    //////// PUBLIC METHODS
+    ////////////////////////////////
+    
+    
+    /** Draw Grid
+    *   
+    *   Draws the outer rectangular border, health border, wave counter border, and weapon border onto the LCD.
+    */
+    void draw_grid(N5110 &lcd);
+    
+    
+    /** Draw Wave Counter
+    *   
+    *   Draws the wave counter onto the LCD.
+    *   @param wave_counter - counter that stores which wave the game is in
+    */
+    void draw_wave_counter(N5110 &lcd, int wave_counter);
+    
+    
+    /** Draw Health
+    *   
+    *   Draws the outside border of the health bar heart onto the LCD.
+    */
     void draw_health(N5110 &lcd);
+    
+    
+    /** Draw First Rocket
+    *   
+    *   Draws the first rocket from the left in the weapons bar onto the LCD. It is drawn full black or dotted
+    *   depending on the "state" variable. Further explained in the "check_rocket" method.
+    *   @param state - variable that determines if line is drawn full black (1) or dotted (2)
+    */
     void draw_rocket1(N5110 &lcd, int state);
+    
+    
+    /** Draw Second Rocket
+    *   
+    *   Draws the second rocket from the left in the weapons bar onto the LCD. It is drawn full black or dotted
+    *   depending on the "state" variable. Further explained in the "check_rocket" method.
+    *   @param state - variable that determines if line is drawn full black (1) or dotted (2)
+    */
     void draw_rocket2(N5110 &lcd, int state);
+    
+    
+    /** Draw Third Rocket
+    *   
+    *   Draws the third rocket from the left in the weapons bar onto the LCD. It is drawn full black or dotted
+    *   depending on the "state" variable. Further explained in the "check_rocket" method.
+    *   @param state - variable that determines if line is drawn full black (1) or dotted (2)
+    */
     void draw_rocket3(N5110 &lcd, int state);
+    
+    
+    /** Draw Star
+    *   
+    *   Draws the star onto the LCD. It is drawn full black or dotted depending on the "state" variable.
+    *   Further explained in the "check_rocket" method.
+    *   @param state - variable that determines if line is drawn full black (1) or dotted (2)
+    */
+    void draw_star (N5110 &lcd, int state);
+    
+    
+    /** Check Health
+    *   
+    *   Draws the health bars onto the LCD depending on how much health the player has (depending on the variable "collisons").
+    *   If zero collisions, health bar is full, i.e the heart is filled black. As collisions increase, the health bar
+    *   goes down, i.e less of the heart is filled black.
+    *   @param collisions - variable that stores how many collisions have been registered
+    */
+    void check_health(N5110 &lcd, int collisions);
+    
+    
+    /** Check Rocket
+    *   
+    *   Draws the rockets in the weapons bar onto the LCD depending on how many the player has (depending on the variable
+    *   "ammo"). If full ammo, all 3 rockets are drawn full black, i.e drawn with the state set to 1. After one shot (ammo = 2),
+    *   the first two are still drawn full black and the third one is drawn dotted, i.e the first two are drawn with a state of 1,
+    *   and the third one is drawn with a state of 2, etc.
+    *   @param ammo - variable that stores how many rockets are available
+    */
     void check_rocket(N5110 &lcd, int ammo);
-    void check_health(N5110 &lcd, int collisions);
+    
+    
+    /** Check Star
+    *
+    *   Draws the star in the weapons bar onto the LCD depending on if the player has one available (depending on the variable
+    *   "star"). If "star" is set to true, it is drawn full black, i.e drawn with the state set to 1, if it is set to false, it
+    *   is drawn dotted, i.e drawn with the state set to 2.
+    *   @param star - variable that stores whether a star is available or not
+    */
+    void check_star(N5110 &lcd, bool star);
     
 private: