Yiu Fai Kwok / Mbed 2 deprecated el17yfk

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 FXOS8700CQ mbed-rtos

Characters/Charmander.h@17:5d8ff39a0e49, 2019-04-21 (annotated)

Committer:
yfkwok
Date:
Sun Apr 21 11:02:28 2019 +0000
Revision:
17:5d8ff39a0e49
Parent:
14:abe64fe0b6a5
Child:
25:31111e6e13ad
21/04/2019 - Add Doxygen comments for the following classes: Exam, Characters, Score and Start

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yfkwok 17:5d8ff39a0e49 1 /** Charmander Class
yfkwok 17:5d8ff39a0e49 2 * @brief This class contains all information such as sprites and descriptions for the character Charmander
yfkwok 17:5d8ff39a0e49 3 * @version 1.0
yfkwok 17:5d8ff39a0e49 4 * @author Yiu Fai Kwok
yfkwok 17:5d8ff39a0e49 5 * @date Match, 2019
yfkwok 17:5d8ff39a0e49 6 */
yfkwok 2:464c7e62d97d 7 #ifndef CHARMANDER_H
yfkwok 2:464c7e62d97d 8 #define CHARMANDER_H
yfkwok 2:464c7e62d97d 9
yfkwok 2:464c7e62d97d 10 #include "mbed.h"
yfkwok 2:464c7e62d97d 11 #include "N5110.h"
yfkwok 2:464c7e62d97d 12 #include "Gamepad.h"
yfkwok 2:464c7e62d97d 13
yfkwok 2:464c7e62d97d 14 class Charmander
yfkwok 2:464c7e62d97d 15 {
yfkwok 2:464c7e62d97d 16
yfkwok 2:464c7e62d97d 17 public:
yfkwok 17:5d8ff39a0e49 18 /** Constructor */
yfkwok 2:464c7e62d97d 19 Charmander();
yfkwok 17:5d8ff39a0e49 20 /** Deconstructor */
yfkwok 2:464c7e62d97d 21 ~Charmander();
yfkwok 2:464c7e62d97d 22
yfkwok 17:5d8ff39a0e49 23 /**
yfkwok 17:5d8ff39a0e49 24 * @brief Draw the primary sprite
yfkwok 17:5d8ff39a0e49 25 * @param position x pos_x (int)
yfkwok 17:5d8ff39a0e49 26 * @param position y pos_y (int)
yfkwok 17:5d8ff39a0e49 27 * @details Draws the primary evolution of the character, the position will be determined by parameters pos_x and pos_y
yfkwok 17:5d8ff39a0e49 28 */
yfkwok 2:464c7e62d97d 29 void draw_cha1_sprite(int pos_x,int pos_y,N5110 &lcd);
yfkwok 17:5d8ff39a0e49 30
yfkwok 17:5d8ff39a0e49 31
yfkwok 17:5d8ff39a0e49 32 /**
yfkwok 17:5d8ff39a0e49 33 * @brief Draw the secondary sprite
yfkwok 17:5d8ff39a0e49 34 * @param position x pos_x (int)
yfkwok 17:5d8ff39a0e49 35 * @param position y pos_y (int)
yfkwok 17:5d8ff39a0e49 36 * @details Draws the secondary evolution of the character, the position will be determined by parameters pos_x and pos_y
yfkwok 17:5d8ff39a0e49 37 */
yfkwok 14:abe64fe0b6a5 38 void draw_cha2_sprite(int pos_x,int pos_y,N5110 &lcd);
yfkwok 17:5d8ff39a0e49 39
yfkwok 17:5d8ff39a0e49 40 /**
yfkwok 17:5d8ff39a0e49 41 * @brief Draw the tertiary sprite
yfkwok 17:5d8ff39a0e49 42 * @param position x pos_x (int)
yfkwok 17:5d8ff39a0e49 43 * @param position y pos_y (int)
yfkwok 17:5d8ff39a0e49 44 * @details Draws the tertiary evolution of the character, the position will be determined by parameters pos_x and pos_y
yfkwok 17:5d8ff39a0e49 45 */
yfkwok 14:abe64fe0b6a5 46 void draw_cha3_sprite(int pos_x,int pos_y,N5110 &lcd);
yfkwok 17:5d8ff39a0e49 47
yfkwok 17:5d8ff39a0e49 48 /**
yfkwok 17:5d8ff39a0e49 49 * @brief Draw the primary alternative sprite
yfkwok 17:5d8ff39a0e49 50 * @param position x pos_x (int)
yfkwok 17:5d8ff39a0e49 51 * @param position y pos_y (int)
yfkwok 17:5d8ff39a0e49 52 * @details Draws the alternative primary evolution of the character, the position will be determined by parameters pos_x and pos_y
yfkwok 17:5d8ff39a0e49 53 */
yfkwok 14:abe64fe0b6a5 54 void draw_cha1_alt_sprite(int pos_x,int pos_y,N5110 &lcd);
yfkwok 17:5d8ff39a0e49 55
yfkwok 17:5d8ff39a0e49 56 /**
yfkwok 17:5d8ff39a0e49 57 * @brief Draw the secondary alternative sprite
yfkwok 17:5d8ff39a0e49 58 * @param position x pos_x (int)
yfkwok 17:5d8ff39a0e49 59 * @param position y pos_y (int)
yfkwok 17:5d8ff39a0e49 60 * @details Draws the alternative secondary evolution of the character, the position will be determined by parameters pos_x and pos_y
yfkwok 17:5d8ff39a0e49 61 */
yfkwok 14:abe64fe0b6a5 62 void draw_cha2_alt_sprite(int pos_x,int pos_y,N5110 &lcd);
yfkwok 17:5d8ff39a0e49 63
yfkwok 17:5d8ff39a0e49 64 /**
yfkwok 17:5d8ff39a0e49 65 * @brief Draw the tertiary alternative sprite
yfkwok 17:5d8ff39a0e49 66 * @param position x pos_x (int)
yfkwok 17:5d8ff39a0e49 67 * @param position y pos_y (int)
yfkwok 17:5d8ff39a0e49 68 * @details Draws the alternative tertiary evolution of the character, the position will be determined by parameters pos_x and pos_y
yfkwok 17:5d8ff39a0e49 69 */
yfkwok 14:abe64fe0b6a5 70 void draw_cha3_alt_sprite(int pos_x,int pos_y,N5110 &lcd);
yfkwok 17:5d8ff39a0e49 71
yfkwok 17:5d8ff39a0e49 72 /**
yfkwok 17:5d8ff39a0e49 73 * @brief Draw the evolution 1 sprite
yfkwok 17:5d8ff39a0e49 74 * @details Draws the primary evolution of the character which is displayed when evolving
yfkwok 17:5d8ff39a0e49 75 */
yfkwok 8:d707bb3b9106 76 void evo_1_sprite(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 77
yfkwok 17:5d8ff39a0e49 78 /**
yfkwok 17:5d8ff39a0e49 79 * @brief Draw the evolution 2 sprite
yfkwok 17:5d8ff39a0e49 80 * @details Draws the secondary evolution of the character which is displayed when evolving
yfkwok 17:5d8ff39a0e49 81 */
yfkwok 8:d707bb3b9106 82 void evo_2_sprite(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 83
yfkwok 17:5d8ff39a0e49 84 /**
yfkwok 17:5d8ff39a0e49 85 * @brief Draw the name title
yfkwok 17:5d8ff39a0e49 86 * @param position x x (int)
yfkwok 17:5d8ff39a0e49 87 * @param position y y (int)
yfkwok 17:5d8ff39a0e49 88 * @details Draws the name tile of the character, the position will be determined by parameters x and y
yfkwok 17:5d8ff39a0e49 89 */
yfkwok 8:d707bb3b9106 90 void evo_3_sprite(N5110 &lcd, int x, int y);
yfkwok 17:5d8ff39a0e49 91
yfkwok 17:5d8ff39a0e49 92 /**
yfkwok 17:5d8ff39a0e49 93 * @brief Draw the congratulation sprite for evolution 1
yfkwok 17:5d8ff39a0e49 94 * @details Draws the primary evolution of the character which is displayed after evolution
yfkwok 17:5d8ff39a0e49 95 */
yfkwok 8:d707bb3b9106 96 void evo_1_cong(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 97
yfkwok 17:5d8ff39a0e49 98 /**
yfkwok 17:5d8ff39a0e49 99 * @brief Draw the congratulation sprite for evolution 2
yfkwok 17:5d8ff39a0e49 100 * @details Draws the secondary evolution of the character which is displayed after evolution
yfkwok 17:5d8ff39a0e49 101 */
yfkwok 8:d707bb3b9106 102 void evo_2_cong(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 103
yfkwok 17:5d8ff39a0e49 104 /**
yfkwok 17:5d8ff39a0e49 105 * @brief Draw the congratulation sprite for evolution 3
yfkwok 17:5d8ff39a0e49 106 * @details Draws the final evolution of the character which is displayed after evolution
yfkwok 17:5d8ff39a0e49 107 */
yfkwok 8:d707bb3b9106 108 void evo_3_cong(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 109
yfkwok 17:5d8ff39a0e49 110 /**
yfkwok 17:5d8ff39a0e49 111 * @brief Display the descrption of the character
yfkwok 17:5d8ff39a0e49 112 * @details Contain the detail description of the character and the instruction sets to navigate through the manual
yfkwok 17:5d8ff39a0e49 113 */
yfkwok 2:464c7e62d97d 114 void description(Gamepad &pad, N5110 &lcd);
yfkwok 2:464c7e62d97d 115
yfkwok 2:464c7e62d97d 116 private:
yfkwok 2:464c7e62d97d 117
yfkwok 2:464c7e62d97d 118 int _pos_x;
yfkwok 2:464c7e62d97d 119 int _pos_y;
yfkwok 8:d707bb3b9106 120 int _x;
yfkwok 8:d707bb3b9106 121 int _y;
yfkwok 2:464c7e62d97d 122
yfkwok 2:464c7e62d97d 123 };
yfkwok 2:464c7e62d97d 124
yfkwok 2:464c7e62d97d 125 #endif