Diff: Engine/Engine.h

Revision:

14:9b4a219dd91e

Parent:

13:09bc615e6665

Child:

15:4ed54ff548cf

--- a/Engine/Engine.h	Fri May 29 01:14:23 2020 +0000
+++ b/Engine/Engine.h	Fri May 29 14:59:59 2020 +0000
@@ -1,3 +1,8 @@
+/** Engine Class
+* @brief Operates the game
+* @author Rosemary Gillman
+* @date April, 2020
+*/
 #ifndef ENGINE_H
 #define ENGINE_H
 
@@ -13,36 +18,77 @@
 class Engine
 {
 public:
+
+    /** Constructor */
     Engine();
+    
+    /** Destructor */
     ~Engine();
+    
+    /** Set initalisation 
+    * @param the value of the swatter width, swatter heigh and speed (int)
+    */
     void init(int swatter_width,int swatter_height,int speed);
+    
+    /** 
+    * @
+    */
     void read_input(Gamepad &pad);
+    
+    /** Update the engine
+    * @
+    */
     void update(N5110 & lcd, Gamepad & pad);
+    
+    /** 
+    * @
+    */
     void timer();
+    
+    /** Draw the game
+    * @return
+    */
     void draw(N5110 &lcd);
-    void check_wall_collision(Gamepad &pad);
+    
+    /** Check side collisions
+    * @
+    */
+    void check_side_collision(Gamepad &pad);
+    
+    /** Check swatter/bug collisions
+    * @
+    */
     void check_swatter_collisions(N5110 & lcd, Gamepad & pad);
+    
+    /** End the game
+    * @
+    */
     void ending(N5110 & lcd, Gamepad & pad);
 
 private:
-    void check_goal(Gamepad &pad);
-    void print_scores(N5110 &lcd);
-    int height;
-    int width;
-    int x;
-    int _speed;
-    Direction _d;
-    float _mag;
-    clock_t start;
-    clock_t end;
-    int random_collision;
-    clock_t clockTicksTaken;
-    double timeInSeconds;
-    double duration;
+
+    int height;                 //swatter height
+    int width;                  //swatter width
+    int x;                      //x-axis point
+    int _speed;                 //bug speed
+    int random_collision;       //sets the 
+    
+    float _mag;                 //magnitude
+
+    clock_t start;              //start time
+    clock_t end;                //end time
+    clock_t clockTicksTaken;    //time value
+    
+    double timeInSeconds;       //time in seconds of game
+    double duration;            //duration of game
+    
     Bug _bug;
     Splat _splat;
-    bool collisionX;
-    bool collisionY;
     Swatter _swatter;
+    Direction _d;
+    
+    bool collisionX;            //X-axis collision
+    bool collisionY;            //Y-axis collision
+    
 };
 #endif