Diff: Gameengine/Gameengine.h

Revision:

57:0f3bbbac72fd

Parent:

56:8c827d1cae3b

Child:

58:4a826093d9e9

--- a/Gameengine/Gameengine.h	Wed Apr 24 20:09:22 2019 +0000
+++ b/Gameengine/Gameengine.h	Wed Apr 24 20:56:36 2019 +0000
@@ -15,10 +15,9 @@
 
 @date April 2019
 */ 
-
 class Gameengine
 {
-    
+
 public:
     /** constructor
     */
@@ -84,10 +83,10 @@
     * @return Function returns true when the player is in contact with the level exit.
     */
     bool level_exit(N5110 &lcd);
-    /** Returns true when level complete conditions met.
-    * @details Function returns true when all 5 keys have been collected using _sprites.keys_collected()
+    /** Moves player to next level when level complete conditions met.
+    * @details When all 5 keys have been collected using _sprites.keys_collected()
     * and player is in contact with the level exit using level_exit() function.
-    * Calculates time reamining then resets, resets enemy and key flags
+    * Calculates time reamining (for score) then resets, resets enemy and key flags
     * so they can be initialised for the next level, increases _level by 1 so next
     * level will be drawn, keys needed increased by 5 and miner position reset.
     */
@@ -97,8 +96,8 @@
     * to select which level positions to use.
     */
     bool trap_death(N5110 &lcd);
-    /** Returns true if player in contact with trap.
-    * @details Function sets all trap positons and collision rules stated in
+    /** Draws keys for each level.
+    * @details Function sets key positions and collision rules stated in
     * Sprites class. Uses int i to select which level positions to use, these are
     * specified in Level class.
     */