Doxyjen of the Bird.h

Dependencies:   mbed N5110

Committer:
Wuuu
Date:
Sun May 05 17:46:26 2019 +0000
Revision:
6:0912dfea40f5
Parent:
5:abe12cabd0b7
Final Submission. I have read and agreed with Statement of Academic Integrity.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wuuu 0:0aea7b9ba421 1 #ifndef GAME1_H
Wuuu 0:0aea7b9ba421 2 #define GAME1_H
Wuuu 0:0aea7b9ba421 3
Wuuu 0:0aea7b9ba421 4 #include "mbed.h"
Wuuu 0:0aea7b9ba421 5 #include "N5110.h"
Wuuu 0:0aea7b9ba421 6 #include "Gamepad.h"
Wuuu 0:0aea7b9ba421 7 #include "Wall.h"
Wuuu 0:0aea7b9ba421 8 #include "Copter.h"
Wuuu 0:0aea7b9ba421 9
Wuuu 4:bf257e628311 10 /** Game1 class
Wuuu 4:bf257e628311 11
Wuuu 5:abe12cabd0b7 12 *@brief Library to combine the Copter and Wall
Wuuu 6:0912dfea40f5 13 *@author Wu Aiming
Wuuu 6:0912dfea40f5 14 *@date May 2019
Wuuu 4:bf257e628311 15 */
Wuuu 4:bf257e628311 16
Wuuu 0:0aea7b9ba421 17 class Game1
Wuuu 0:0aea7b9ba421 18 {
Wuuu 0:0aea7b9ba421 19 public:
Wuuu 4:bf257e628311 20
Wuuu 4:bf257e628311 21 /**Constructor*/
Wuuu 0:0aea7b9ba421 22 Game1();
Wuuu 4:bf257e628311 23 /**Destructor*/
Wuuu 0:0aea7b9ba421 24 ~Game1();
Wuuu 4:bf257e628311 25 /**
Wuuu 4:bf257e628311 26 *@brief Initialise all parameters of the Game1
Wuuu 4:bf257e628311 27 */
Wuuu 0:0aea7b9ba421 28 void init();
Wuuu 4:bf257e628311 29 /**
Wuuu 5:abe12cabd0b7 30 *@brief Draw the copter, wall and live scores
Wuuu 4:bf257e628311 31 *@param lcd, pad
Wuuu 4:bf257e628311 32 *@returns The number to test whether the copter crash the wall
Wuuu 4:bf257e628311 33 *@details Use the method to use function within N5110.h and Gamepad.h file
Wuuu 4:bf257e628311 34 */
Wuuu 0:0aea7b9ba421 35 int draw(N5110 &lcd, Gamepad &pad);
Wuuu 4:bf257e628311 36 /**
Wuuu 4:bf257e628311 37 *@brief Get the live score
Wuuu 4:bf257e628311 38 *@return The live score
Wuuu 4:bf257e628311 39 */
Wuuu 0:0aea7b9ba421 40 int get_score();
Wuuu 0:0aea7b9ba421 41
Wuuu 0:0aea7b9ba421 42 private:
Wuuu 0:0aea7b9ba421 43
Wuuu 0:0aea7b9ba421 44 int _m;
Wuuu 0:0aea7b9ba421 45 int _s;
Wuuu 0:0aea7b9ba421 46 int _a;
Wuuu 0:0aea7b9ba421 47 int _b;
Wuuu 0:0aea7b9ba421 48 int _c;
Wuuu 0:0aea7b9ba421 49 Copter _Copter;
Wuuu 0:0aea7b9ba421 50 Wall _Wall;
Wuuu 0:0aea7b9ba421 51 };
Wuuu 0:0aea7b9ba421 52
Wuuu 0:0aea7b9ba421 53 #endif
Wuuu 5:abe12cabd0b7 54
Wuuu 6:0912dfea40f5 55