Ben Evans / Mbed 2 deprecated Defender_Game

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

SavedGames/SavedGames.h@67:a2984682d641, 2020-05-21 (annotated)

Committer:
evanso
Date:
Thu May 21 20:23:24 2020 +0000
Revision:
67:a2984682d641
Parent:
64:e9dfc35a1738
Child:
68:bb1650c657ef
Added SaveGame unit test which all passed! Had to define the unit test that tests actually saving and reading from a file as kept getting an error when declaring the sd object.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
evanso 49:ed569eceeaa4 1 #ifndef SAVEDGAMES_H
evanso 49:ed569eceeaa4 2 #define SAVEDGAMES_H
evanso 49:ed569eceeaa4 3
evanso 49:ed569eceeaa4 4 // Included libraries ----------------------------------------------------------
evanso 49:ed569eceeaa4 5 #include "mbed.h"
evanso 49:ed569eceeaa4 6 #include "N5110.h"
evanso 49:ed569eceeaa4 7 #include "Gamepad.h"
evanso 50:13c8710985f4 8 #include "SDFileSystem.h"
evanso 51:35cb8e604b72 9
evanso 51:35cb8e604b72 10 struct SavedGamesData{
evanso 52:feb8cf28bcff 11 int score; /**< Score variable */
evanso 52:feb8cf28bcff 12 int lives; /**< lives left variable */
evanso 52:feb8cf28bcff 13 int smart_bombs; /**< smart_bombs left variable */
evanso 52:feb8cf28bcff 14 int alien_number; /**< number of alien on screen variable*/
evanso 51:35cb8e604b72 15 };
evanso 49:ed569eceeaa4 16
evanso 49:ed569eceeaa4 17 /** SavedGames class
evanso 49:ed569eceeaa4 18 * @brief Stores saved games on sd card, stores score, lives, smart bombs and
evanso 49:ed569eceeaa4 19 * number of current alliens
evanso 49:ed569eceeaa4 20 * @author Benjamin Evans, University of Leeds
evanso 49:ed569eceeaa4 21 * @date May 2020
evanso 49:ed569eceeaa4 22 */
evanso 49:ed569eceeaa4 23 class SavedGames{
evanso 49:ed569eceeaa4 24 public:
evanso 49:ed569eceeaa4 25 /** Constructor */
evanso 49:ed569eceeaa4 26 SavedGames();
evanso 49:ed569eceeaa4 27
evanso 49:ed569eceeaa4 28 /** Destructor */
evanso 49:ed569eceeaa4 29 ~SavedGames();
evanso 49:ed569eceeaa4 30
evanso 51:35cb8e604b72 31 /** Initalises SavedGames
evanso 51:35cb8e604b72 32 * @param lcd @details N5110 object
evanso 51:35cb8e604b72 33 * @param sd @details sd card object
evanso 51:35cb8e604b72 34 */
evanso 67:a2984682d641 35 void init();
evanso 49:ed569eceeaa4 36
evanso 51:35cb8e604b72 37 /** Adds saved data to sd card
evanso 51:35cb8e604b72 38 * @param sd @details sd card object
evanso 53:01be7898c23f 39 * @param data @details SavedGamesData struct
evanso 54:d46459104dea 40 * @param lcd @details N5110 object
evanso 51:35cb8e604b72 41 */
evanso 59:0b2e43312d6b 42 void add_saved_data(SDFileSystem &sd,SavedGamesData data, N5110 &lcd);
evanso 53:01be7898c23f 43
evanso 61:7c4ec680a428 44 /** Reads saved data from sd cardand return it as a struct
evanso 53:01be7898c23f 45 * @param sd @details sd card object
evanso 54:d46459104dea 46 * @param lcd @details N5110 object
evanso 61:7c4ec680a428 47 * @return data @details SavedGamesData struct
evanso 53:01be7898c23f 48 */
evanso 61:7c4ec680a428 49 SavedGamesData read_saved_data(SDFileSystem &sd, N5110 &lcd);
evanso 54:d46459104dea 50
evanso 54:d46459104dea 51 /** Scrolls through the diffent saved games parts
evanso 54:d46459104dea 52 * @param d_ @details Direction of joystick
evanso 54:d46459104dea 53 */
evanso 59:0b2e43312d6b 54 void saved_games_scroll(Direction d_);
evanso 54:d46459104dea 55
evanso 54:d46459104dea 56 /** Draws the saved game screen
evanso 54:d46459104dea 57 * @param lcd @details N5110 object
evanso 54:d46459104dea 58 */
evanso 54:d46459104dea 59 void display_saved_games(N5110 &lcd);
evanso 59:0b2e43312d6b 60
evanso 61:7c4ec680a428 61 /** Draws the select save game select screen
evanso 60:55fdc6bb29b9 62 * @param lcd @details N5110 object
evanso 60:55fdc6bb29b9 63 */
evanso 60:55fdc6bb29b9 64 void save_game_screen(N5110 &lcd);
evanso 60:55fdc6bb29b9 65
evanso 67:a2984682d641 66 /** Runs the save test unit test
evanso 67:a2984682d641 67 * @param lcd @details N5110 object
evanso 67:a2984682d641 68 * @param sd @details sd card object
evanso 67:a2984682d641 69 */
evanso 67:a2984682d641 70 void run_save_test(SDFileSystem &sd, N5110 &lcd);
evanso 67:a2984682d641 71
evanso 67:a2984682d641 72 /** Save test unit test, checks the saving and reading functions work
evanso 67:a2984682d641 73 * @param lcd @details N5110 object
evanso 67:a2984682d641 74 * @param sd @details sd card object
evanso 67:a2984682d641 75 * @param d_ @details Direction of joystick
evanso 67:a2984682d641 76 */
evanso 67:a2984682d641 77 bool save_test(Direction d_,SDFileSystem &sd, N5110 &lcd);
evanso 67:a2984682d641 78
evanso 49:ed569eceeaa4 79 // Accessors and mutators --------------------------------------------------
evanso 49:ed569eceeaa4 80
evanso 50:13c8710985f4 81 /** Gets error flag
evanso 50:13c8710985f4 82 * @return error_;
evanso 50:13c8710985f4 83 */
evanso 50:13c8710985f4 84 bool get_error();
evanso 50:13c8710985f4 85
evanso 63:4631447440cf 86 /** set error
evanso 63:4631447440cf 87 * @param error;
evanso 63:4631447440cf 88 */
evanso 64:e9dfc35a1738 89 void set_error(bool error);
evanso 63:4631447440cf 90
evanso 59:0b2e43312d6b 91 /** Gets the displayed saved game number
evanso 59:0b2e43312d6b 92 * @return display_data_number_;
evanso 59:0b2e43312d6b 93 */
evanso 59:0b2e43312d6b 94 int get_display_data_number();
evanso 59:0b2e43312d6b 95
evanso 49:ed569eceeaa4 96 private:
evanso 64:e9dfc35a1738 97 // Function prototypes -----------------------------------------------------
evanso 64:e9dfc35a1738 98
evanso 64:e9dfc35a1738 99 /** Check if sd card is inserted and print message if not
evanso 64:e9dfc35a1738 100 * @param lcd @details N5110 object
evanso 64:e9dfc35a1738 101 * @param sd @details sd card object
evanso 64:e9dfc35a1738 102 * @note Dont think sd.card_present()function acutally works
evanso 64:e9dfc35a1738 103 */
evanso 64:e9dfc35a1738 104 void check_sd_present(SDFileSystem &sd,N5110 &lcd);
evanso 64:e9dfc35a1738 105
evanso 64:e9dfc35a1738 106 /** shows error if saved data files opens incorrectly
evanso 64:e9dfc35a1738 107 * @param lcd @details N5110 object
evanso 64:e9dfc35a1738 108 */
evanso 64:e9dfc35a1738 109 void error_open_file(N5110 &lcd);
evanso 64:e9dfc35a1738 110
evanso 64:e9dfc35a1738 111 /** Draws no saved files screen
evanso 64:e9dfc35a1738 112 * @param lcd @details N5110 object
evanso 64:e9dfc35a1738 113 */
evanso 64:e9dfc35a1738 114 void no_saved_files(N5110 &lcd);
evanso 67:a2984682d641 115
evanso 49:ed569eceeaa4 116 // Varibles ----------------------------------------------------------------
evanso 49:ed569eceeaa4 117
evanso 50:13c8710985f4 118 /** Flag for error, true = error */
evanso 50:13c8710985f4 119 bool error_;
evanso 51:35cb8e604b72 120
evanso 54:d46459104dea 121 /** Variable for which vector data to select */
evanso 54:d46459104dea 122 int display_data_number_;
evanso 61:7c4ec680a428 123
evanso 61:7c4ec680a428 124
evanso 49:ed569eceeaa4 125 };
evanso 49:ed569eceeaa4 126 #endif