ELEC2645 (2018/19) / Mbed 2 deprecated el17lw

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Fire/Fire.h@21:20478f086bc2, 2019-04-20 (annotated)

Committer:
lewisgw
Date:
Sat Apr 20 14:46:50 2019 +0000
Revision:
21:20478f086bc2
Parent:
18:304700b5d8f8
Child:
24:c7df5aa476a9
Fully documented and commented all classes and functions

Who changed what in which revision?

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