Diff: BreakoutEngine/BreakoutEngine.h

Revision:

135:888ae932cd70

Parent:

131:c227bbfb38b0

diff -r 48c4b408868c -r 888ae932cd70 BreakoutEngine/BreakoutEngine.h
--- a/BreakoutEngine/BreakoutEngine.h	Thu May 09 09:10:24 2019 +0000
+++ b/BreakoutEngine/BreakoutEngine.h	Thu May 09 09:45:37 2019 +0000
@@ -18,7 +18,7 @@
 #define GAP_TOP 10
 #define GAP 2
 
-/** BreajoutEngine Class
+/** BreakoutEngine Class
 @author James Heavey, University of Leeds
 @brief Controls the Breakout game
 @date May 2019
@@ -84,9 +84,9 @@
     void inc_mult();
     
     /** Resets the multiplier to 0
-    * @return returns _prev_score
+    * @returns _prev_score
     */
-    void set_mult_zero();
+    void reset_mult();
     
     /** Sets the paddle motion options for use in game
     * @param tilt @details a bool that sets tilt if true and joystick if false
@@ -104,32 +104,33 @@
     void dec_num_left();
     
     /** Returns the number of Bricks remaining on screen
-    * @return returns _number_left
+    * @returns _number_left
     */
     int get_num_left();
     
     /** Returns the score achieved on victory in the previous iteration of the game
-    * @return returns _prev_score
+    * @returns _prev_score
     */
     int get_prev_score();
     
     /** Returns the number of lives remaining 
-    * @return returns the paddle variable _lives
+    * @returns the paddle variable _lives
     */
-    int get_lives();
+    int get_paddle_lives();
     
     /** Returns the current multiplier value
-    * @return returns _multiplier
+    * @returns _multiplier
     */
     int get_mult();
     
     /** Checks if the ball goes past the screen y boundary
     * @param pad @details a Gamepad pointer
+    * @returns a bool; true if ball is off screen, false
     */
     bool check_loss(Gamepad &pad);
     
     /** Returns the current score to print to LCD in the game
-    * @return returns _score
+    * @returns _score
     */
     int get_score();