Diff: Enemy/Enemy.h

Revision:

26:d16a5b1e0ace

Parent:

24:67dc71a8f009

Child:

29:15e9640646b7

--- a/Enemy/Enemy.h	Wed May 08 15:07:04 2019 +0000
+++ b/Enemy/Enemy.h	Wed May 08 17:24:35 2019 +0000
@@ -16,6 +16,16 @@
 public:
     Enemy();
     ~Enemy();
+    /** 
+    @brief Defines the initial position of the enemy
+    @param float position_x uses float since the velocity will be added, which is not an integer.
+    @param float position_y uses float since the velocity will be added, which is not an integer.
+    @param double velocity_y needs to be double in order for it to decelerate to a small value that 
+    approaches zero.
+    @details The intial position of the doodler is at the centre of the screen and the values are 
+    gotten from the Engine class. It also defines the gravity as a positive vale greater than 1 
+    and the up object as a negative vale less than 1.
+    */
     void init(float floor_pos_x, float floor_pos_y);
     void draw(N5110 &lcd);
     void update(float floor_pos_x, float floor_pos_y);