Diff: Health/Health.h

Revision:

51:2231e2e141b9

Parent:

47:5ae8668af63f

Child:

53:3fdc4486f672

diff -r 69fc9b5e3335 -r 2231e2e141b9 Health/Health.h
--- a/Health/Health.h	Thu May 09 06:02:20 2019 +0000
+++ b/Health/Health.h	Thu May 09 08:42:25 2019 +0000
@@ -25,17 +25,17 @@
     */
     void init(SHIP shipUsed);
     /** draws the health bar based on ship selected
-    *@param &lcd pointer to the N5110 library used for the lcd display
+    *@param &lcd address of the N5110 library used for the lcd display
     *@param shipUsed a variable of enum SHIP which contains the ship currently being used 
     */
     void draw_health(N5110 &lcd,SHIP shipUsed);
     /** draws the shield bar based on ship selected
-    *@param &lcd pointer to the N5110 library used for the lcd display
+    *@param &lcd address of the N5110 library used for the lcd display
     */
     void draw_shields(N5110 &lcd);
     /** A mutator method used to change the shield and health values when damahe is taken
     *@param bars a unit of health and damage. (e.g 3 bars of health)
-    *@param &pad pointer to the gamepad library used to read inputs and send outputs to the gamepad
+    *@param &pad address of the gamepad library used to read inputs and send outputs to the gamepad
     */
     void update(int bars,Gamepad &pad);
     /** An accessor method used to get the current health and shield level of a ship
@@ -78,12 +78,11 @@
     
 private:
 //_______________Private-Variables__________________________________________
-    int _ship_health;
-    int _ship_shields;
-    int _shipno;
-    int _health_unit;
-    int _seekerH[3];
-    int _shooterH[3];
+    int _ship_health;   // the ships health
+    int _ship_shields;  // the ships shield (sheilds differ from health as they recharge over time)
+    int _health_unit;   // 1 unit of health (differs from ship to ship)
+    int _seekerH[3];    // array of seeker health values
+    int _shooterH[3];   // array of shooter health values
 
 };