Tempest Game

Diff: Alien/Alien.h

Revision:

10:2ae9d4145410

Parent:

9:759b419fec3b

--- a/Alien/Alien.h	Tue May 26 07:26:13 2020 +0000
+++ b/Alien/Alien.h	Tue May 26 16:31:22 2020 +0000
@@ -1,6 +1,7 @@
 #ifndef Alien_H
 #define Alien_H
 
+// Included Libraries
 #include "mbed.h"
 #include "N5110.h"
 #include "Gamepad.h"
@@ -9,27 +10,61 @@
 #include <cstdlib>
 #include <ctime>
 
-
+/** Alien Class
+ * @brief Draws and moves the aliens
+ * @author Matis Requis
+ * @date May, 2020
+ */
 class Alien {
 public:
+
+    /** Constructor */
     Alien();
+    
+    /** Destructor */
     ~Alien();
+    
+    /** Initialises the bullet
+     * @param column @details column the bullet spawns at
+     * @param speed @details speed at which the alien moves lower is faster
+     */
     void init(int column, int speed);
+    
+    
+    /** Draws the alien
+     * @param lcd @details N5110 object
+     */
     void draw(N5110 &lcd);
+    
+    /** Updates the aliens location */
     void update();
+    
+    /** checks if the alien needs to be deleted
+     * @return 1 or 0 @details returns 1 if alien needs to be deleted
+     */
     int checkdelete();
+    
+    /** checks if the alien need has reached the top of the board */
     int checkobjective();
+    
+    
+    /** returns a vector with the alien position
+     * @return alienxy @details Vector2D structure with the aliens xy coordinates
+     */
     Vector2D getxy();
     
+    /** returns a vector with the alien lane and position
+     * @return aliencolpos @details Vector2D structure with the aliens lane and position
+     */
+    Vector2D getcolumnpos();
+    
 private:
-    int _size;
     int _column;
     int _x;
     int _y;
     Board _board;
     int _currentpos;
     int _rand;
-    int _loss;
     int _movcount;
     int _alienspeed;
 };