ELEC2645 (2018/19) / Mbed 2 deprecated el17lw

Dependencies:   mbed

Committer:
lewisgw
Date:
Wed Apr 24 17:58:35 2019 +0000
Revision:
25:aa145767fda5
Parent:
24:c7df5aa476a9
Child:
28:be77ad6c0bda
Updated documentation.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
lewisgw 18:304700b5d8f8 1 #ifndef FIRE_H
lewisgw 18:304700b5d8f8 2 #define FIRE_H
lewisgw 16:331be5c7ed80 3
lewisgw 16:331be5c7ed80 4 #include "mbed.h"
lewisgw 16:331be5c7ed80 5
lewisgw 24:c7df5aa476a9 6 /** Fire Class
lewisgw 24:c7df5aa476a9 7 * @brief Generates a fire ball that will end the game if the skateboarder touches it
lewisgw 24:c7df5aa476a9 8 * @author Lewis Wooltorton
lewisgw 24:c7df5aa476a9 9 * @date April 2019
lewisgw 24:c7df5aa476a9 10 */
lewisgw 24:c7df5aa476a9 11
lewisgw 18:304700b5d8f8 12 class Fire {
lewisgw 16:331be5c7ed80 13 public:
lewisgw 24:c7df5aa476a9 14 /** Constructor, non user specified.*/
lewisgw 18:304700b5d8f8 15 Fire();
lewisgw 25:aa145767fda5 16 /** Destructor, non user specified.*/
lewisgw 18:304700b5d8f8 17 ~Fire();
lewisgw 16:331be5c7ed80 18
lewisgw 21:20478f086bc2 19 // Mutators.
lewisgw 24:c7df5aa476a9 20 /** Initialises Fire object. */
lewisgw 16:331be5c7ed80 21 void init();
lewisgw 21:20478f086bc2 22
lewisgw 21:20478f086bc2 23 // Accessors
lewisgw 24:c7df5aa476a9 24 /** Gets the sprite.
lewisgw 21:20478f086bc2 25 * @returns The Fire sprite (an integer array)
lewisgw 21:20478f086bc2 26 */
lewisgw 18:304700b5d8f8 27 int * get_fire_sprite();
lewisgw 25:aa145767fda5 28 /** Gets the x coordinate.
lewisgw 25:aa145767fda5 29 * @returns The x coordinate of the Fire
lewisgw 21:20478f086bc2 30 */
lewisgw 18:304700b5d8f8 31 int get_fire_x();
lewisgw 21:20478f086bc2 32
lewisgw 21:20478f086bc2 33 // Member methods.
lewisgw 24:c7df5aa476a9 34 /** Generates Fire parameters @details Increments Fire x coordinate and toggles fire sprite.*/
lewisgw 21:20478f086bc2 35 void generate_fire();
lewisgw 16:331be5c7ed80 36
lewisgw 16:331be5c7ed80 37 private:
lewisgw 16:331be5c7ed80 38 int _x;
lewisgw 18:304700b5d8f8 39 bool _fire_counter;
lewisgw 16:331be5c7ed80 40 };
lewisgw 16:331be5c7ed80 41 #endif