ELEC2645 (2018/19) / Mbed 2 deprecated el17yfk

Game codes for Pokemon Academy Yiu Fai Kwok - 201198802 I have read the University Regulations on Plagiarism and state that the work covered by this declaration is my own and does not contain any unacknowledged work from other sources.

Dependencies:   mbed FXOS8700CQ mbed-rtos

Characters/Charmander.h@25:31111e6e13ad, 2019-04-29 (annotated)

Committer:
yfkwok
Date:
Mon Apr 29 20:59:49 2019 +0000
Revision:
25:31111e6e13ad
Parent:
17:5d8ff39a0e49
Child:
31:0d2c19a285f6
29/04/2019 - Class documentation update

Who changed what in which revision?

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