Kern Fowler / Mbed 2 deprecated Donkey_Kong_Game

Dependencies:   mbed

Committer:
Kern_EL17KJTF
Date:
Wed May 08 23:47:18 2019 +0000
Revision:
21:1f44f5493c0d
Parent:
12:50a7abf21f18
Child:
22:d265f506446b
Child:
34:8dbf401b9906
Documentation - GameEngine Class Complete.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kern_EL17KJTF 10:28575a6eaa13 1 #ifndef GAMEENGINE_H
Kern_EL17KJTF 10:28575a6eaa13 2 #define GAMEENGINE_H
Kern_EL17KJTF 10:28575a6eaa13 3
Kern_EL17KJTF 10:28575a6eaa13 4 #include "mbed.h"
Kern_EL17KJTF 10:28575a6eaa13 5 #include "N5110.h"
Kern_EL17KJTF 10:28575a6eaa13 6 #include "Gamepad.h"
Kern_EL17KJTF 12:50a7abf21f18 7 #include "Donkey.h"
Kern_EL17KJTF 10:28575a6eaa13 8 #include "Barrel.h"
Kern_EL17KJTF 10:28575a6eaa13 9 #include "Banana.h"
Kern_EL17KJTF 12:50a7abf21f18 10
Kern_EL17KJTF 21:1f44f5493c0d 11 /** GameEngine Class
Kern_EL17KJTF 21:1f44f5493c0d 12 *@brief This class is running and contrling the main game functions.
Kern_EL17KJTF 21:1f44f5493c0d 13 *@author Kern Fowler
Kern_EL17KJTF 21:1f44f5493c0d 14 *@version 1.0
Kern_EL17KJTF 21:1f44f5493c0d 15 *@date May 2019
Kern_EL17KJTF 21:1f44f5493c0d 16 */
Kern_EL17KJTF 10:28575a6eaa13 17
Kern_EL17KJTF 21:1f44f5493c0d 18 class GameEngine {
Kern_EL17KJTF 10:28575a6eaa13 19
Kern_EL17KJTF 21:1f44f5493c0d 20 public:
Kern_EL17KJTF 21:1f44f5493c0d 21 /** GameEngine Constructor
Kern_EL17KJTF 21:1f44f5493c0d 22 @brief Builds my default GameEngine constructor.
Kern_EL17KJTF 21:1f44f5493c0d 23 @details This does not have any setup.
Kern_EL17KJTF 21:1f44f5493c0d 24 */
Kern_EL17KJTF 21:1f44f5493c0d 25 GameEngine();
Kern_EL17KJTF 21:1f44f5493c0d 26 /** GameEngine Destructor
Kern_EL17KJTF 21:1f44f5493c0d 27 @brief Builds my default GameEngine destructor.
Kern_EL17KJTF 21:1f44f5493c0d 28 @details This does not have any setup.
Kern_EL17KJTF 21:1f44f5493c0d 29 */
Kern_EL17KJTF 21:1f44f5493c0d 30 ~GameEngine();
Kern_EL17KJTF 21:1f44f5493c0d 31 // Mutators
Kern_EL17KJTF 10:28575a6eaa13 32
Kern_EL17KJTF 21:1f44f5493c0d 33 /**
Kern_EL17KJTF 21:1f44f5493c0d 34 *@brief Controls the main game.
Kern_EL17KJTF 21:1f44f5493c0d 35 *@param pad The Gamepad class is used.
Kern_EL17KJTF 21:1f44f5493c0d 36 *@param lcd The N5110 class is used.
Kern_EL17KJTF 21:1f44f5493c0d 37 *@param barrel The Barrel class is used.
Kern_EL17KJTF 21:1f44f5493c0d 38 *@param banana The Banana class is used.
Kern_EL17KJTF 21:1f44f5493c0d 39 *@param dky The Donkey class is used.
Kern_EL17KJTF 21:1f44f5493c0d 40 *@details Runs the main functions of the game in correct order.
Kern_EL17KJTF 21:1f44f5493c0d 41 */
Kern_EL17KJTF 21:1f44f5493c0d 42 void gameengine_run(Gamepad &pad, N5110 &lcd, Barrel &barrel, Banana &banana, Donkey &dky);
Kern_EL17KJTF 21:1f44f5493c0d 43 /**
Kern_EL17KJTF 21:1f44f5493c0d 44 *@brief Shows game over screen.
Kern_EL17KJTF 21:1f44f5493c0d 45 *@param pad The Gamepad class is used.
Kern_EL17KJTF 21:1f44f5493c0d 46 *@param lcd The N5110 class is used.
Kern_EL17KJTF 21:1f44f5493c0d 47 *@param banana The Banana class is used.
Kern_EL17KJTF 21:1f44f5493c0d 48 *@details Prints the gameover screen. Prints various text, including total player score.
Kern_EL17KJTF 21:1f44f5493c0d 49 */
Kern_EL17KJTF 21:1f44f5493c0d 50 void gameengine_score(Gamepad &pad, N5110 &lcd, Banana &banana);
Kern_EL17KJTF 10:28575a6eaa13 51 };
Kern_EL17KJTF 10:28575a6eaa13 52
Kern_EL17KJTF 10:28575a6eaa13 53 #endif