Diff: GameEngine.h

Revision:

13:63013a418903

Parent:

12:6eeb06ed7c6b

--- a/GameEngine.h	Thu May 04 09:54:21 2017 +0000
+++ b/GameEngine.h	Thu May 04 11:36:35 2017 +0000
@@ -12,45 +12,36 @@
 class GameEngine
 {
     public:
-    /** 
-    *
-    *   
-    */
     GameEngine();
-    
-    /** 
-    *
-    *   
-    */
     ~GameEngine();
     
     /** Initialise Game Engine
     *
-    *   This function 
+    *   This function initialises the game engine.
     */
     void init( );
     
     /** Read Input
     *
-    *   This function 
+    *   This function obtains numeric data from the gamepads joystick.
     */
     void read_input(Gamepad &pad);
     
     /** Update
     *
-    *   This function 
+    *   This function contains the update functions of the other libraries used in the game.
     */
     void update(Gamepad &pad);
     
     /** Draw 
     *
-    *   This function 
+    *   This function contains the draw functions of the other libraries used in the game.
     */
     void draw(N5110 &lcd, Gamepad &pad);
     
     /** Get Position
     *
-    *   This function 
+    *   This function contains the Get Position functions of the otehr libraries used in the game.
     */
     void get_pos();
     
@@ -70,8 +61,23 @@
     int _speed;
     Direction _d;
     float _mag;
+    
+    /** Check for Projectile and Target collision
+    *
+    *   This function checks if the projectile has come into contact with a target.
+    */
     void CheckProjTargetCollision(Gamepad &pad);
+    
+    /** Check for Player and Target collision
+    *
+    *   This function checks if the player has come into contact with a target.
+    */
     void CheckPlayerTargetCollision(Gamepad &pad);
+    
+    /** Check for Target and Floor collision
+    *
+    *   This function checks if the target sprite has reached the bottom of the screen.
+    */
     void CheckTargetFloorCollision(Gamepad &pad);
     int HP;
     int n;