Merge pull request #909 from GriffinRichards/doc-apprentice

Document Apprentice

include/constants/apprentice.h

@@ -1,22 +1,88 @@
 #ifndef GUARD_CONSTANTS_APPRENTICE_H
 #define GUARD_CONSTANTS_APPRENTICE_H
 
-#define APPRENTICE_ASK_WHICH_LEVEL 0
-#define APPRENTICE_ASK_3SPECIES 1
-#define APPRENTICE_ASK_2SPECIES 2
-#define APPRENTICE_ASK_MOVES 3
-#define APPRENTICE_ASK_GIVE 4
-#define APPRENTICE_ASK_YES_NO 6
+#define NUM_APPRENTICES 16
+#define APPRENTICE_SPECIES_COUNT 10
 
-#define APPRENTICE_BUFF_SPECIES1 0
-#define APPRENTICE_BUFF_SPECIES2 1
-#define APPRENTICE_BUFF_SPECIES3 2
-#define APPRENTICE_BUFF_MOVE1 3
-#define APPRENTICE_BUFF_MOVE2 4
-#define APPRENTICE_BUFF_ITEM 5
-#define APPRENTICE_BUFF_NAME 6
-#define APPRENTICE_BUFF_EASY_CHAT 7
-#define APPRENTICE_BUFF_LEVEL 8
-#define APPRENTICE_BUFF_SPECIES4 9
+#define NUM_WHICH_MON_QUESTIONS  MULTI_PARTY_SIZE
+#define NUM_WHICH_MOVE_QUESTIONS 5
+
+#define APPRENTICE_LVL_MODE_50    (FRONTIER_LVL_50 + 1)
+#define APPRENTICE_LVL_MODE_OPEN  (FRONTIER_LVL_OPEN + 1)
+
+#define APPRENTICE_FUNC_GAVE_LVLMODE         0
+#define APPRENTICE_FUNC_SET_LVLMODE          1
+#define APPRENTICE_FUNC_SET_ID               2
+#define APPRENTICE_FUNC_SHUFFLE_SPECIES      3
+#define APPRENTICE_FUNC_RANDOMIZE_QUESTIONS  4
+#define APPRENTICE_FUNC_ANSWERED_QUESTION    5
+#define APPRENTICE_FUNC_IS_FINAL_QUESTION    6
+#define APPRENTICE_FUNC_MENU                 7
+#define APPRENTICE_FUNC_PRINT_MSG            8
+#define APPRENTICE_FUNC_RESET                9
+#define APPRENTICE_FUNC_CHECK_GONE           10
+#define APPRENTICE_FUNC_GET_QUESTION         11
+#define APPRENTICE_FUNC_GET_NUM_PARTY_MONS   12
+#define APPRENTICE_FUNC_SET_PARTY_MON        13
+#define APPRENTICE_FUNC_INIT_QUESTION_DATA   14
+#define APPRENTICE_FUNC_FREE_QUESTION_DATA   15
+#define APPRENTICE_FUNC_BUFFER_STRING        16
+#define APPRENTICE_FUNC_SET_MOVE             17
+#define APPRENTICE_FUNC_SET_LEAD_MON         18
+#define APPRENTICE_FUNC_OPEN_BAG             19
+#define APPRENTICE_FUNC_TRY_SET_HELD_ITEM    20
+#define APPRENTICE_FUNC_SAVE                 21
+#define APPRENTICE_FUNC_SET_GFX_SAVED        22
+#define APPRENTICE_FUNC_SET_GFX              23
+#define APPRENTICE_FUNC_SHOULD_LEAVE         24
+#define APPRENTICE_FUNC_SHIFT_SAVED          25
+
+#define APPRENTICE_MSG_PLEASE_TEACH             0
+#define APPRENTICE_MSG_REJECT                   1
+#define APPRENTICE_MSG_WHICH_LVL_MODE           2
+#define APPRENTICE_MSG_THANKS_LVL_MODE          3
+#define APPRENTICE_MSG_WHICH_MON_FIRST          4
+#define APPRENTICE_MSG_THANKS_MON_FIRST         5
+#define APPRENTICE_MSG_WHICH_MON                6
+#define APPRENTICE_MSG_THANKS_MON               7
+#define APPRENTICE_MSG_WHICH_MOVE               8
+#define APPRENTICE_MSG_THANKS_MOVE              9
+#define APPRENTICE_MSG_WHAT_HELD_ITEM           10
+#define APPRENTICE_MSG_PICK_WIN_SPEECH          11
+#define APPRENTICE_MSG_THANKS_HELD_ITEM         12
+#define APPRENTICE_MSG_HOLD_NOTHING             13
+#define APPRENTICE_MSG_THANKS_NO_HELD_ITEM      14
+#define APPRENTICE_MSG_THANKS_WIN_SPEECH        15
+#define APPRENTICE_MSG_ITEM_ALREADY_SUGGESTED   16
+
+#define APPRENTICE_QUESTION_WHICH_FIRST    1
+#define APPRENTICE_QUESTION_WHICH_MON      2
+#define APPRENTICE_QUESTION_WHICH_MOVE     3
+#define APPRENTICE_QUESTION_WHAT_ITEM      4
+#define APPRENTICE_QUESTION_WIN_SPEECH     5
+
+// Would be redundant with the above set if they used the same values
+#define QUESTION_ID_WIN_SPEECH    0
+#define QUESTION_ID_WHAT_ITEM     1
+#define QUESTION_ID_WHICH_MOVE    2
+#define QUESTION_ID_WHICH_FIRST   3
+
+#define APPRENTICE_ASK_WHICH_LEVEL  0
+#define APPRENTICE_ASK_3SPECIES     1
+#define APPRENTICE_ASK_2SPECIES     2
+#define APPRENTICE_ASK_MOVES        3
+#define APPRENTICE_ASK_GIVE         4
+#define APPRENTICE_ASK_YES_NO       6
+
+#define APPRENTICE_BUFF_SPECIES1         0
+#define APPRENTICE_BUFF_SPECIES2         1
+#define APPRENTICE_BUFF_SPECIES3         2
+#define APPRENTICE_BUFF_MOVE1            3
+#define APPRENTICE_BUFF_MOVE2            4
+#define APPRENTICE_BUFF_ITEM             5
+#define APPRENTICE_BUFF_NAME             6
+#define APPRENTICE_BUFF_WIN_SPEECH       7
+#define APPRENTICE_BUFF_LEVEL            8
+#define APPRENTICE_BUFF_LEAD_MON_SPECIES 9
 
 #endif // GUARD_CONSTANTS_APPRENTICE_H

include/constants/global.h

@@ -18,12 +18,13 @@
 #define VERSION_GAMECUBE 15
 
 #define LANGUAGE_JAPANESE 1
-#define LANGUAGE_ENGLISH 2
-#define LANGUAGE_FRENCH 3
-#define LANGUAGE_ITALIAN 4
-#define LANGUAGE_GERMAN 5
-#define LANGUAGE_KOREAN 6 // 6 goes unused but the theory is it was meant to be Korean
-#define LANGUAGE_SPANISH 7
+#define LANGUAGE_ENGLISH  2
+#define LANGUAGE_FRENCH   3
+#define LANGUAGE_ITALIAN  4
+#define LANGUAGE_GERMAN   5
+#define LANGUAGE_KOREAN   6 // 6 goes unused but the theory is it was meant to be Korean
+#define LANGUAGE_SPANISH  7
+#define NUM_LANGUAGES     7
 
 #define GAME_VERSION (VERSION_EMERALD)
 #define GAME_LANGUAGE (LANGUAGE_ENGLISH)
@@ -48,6 +49,8 @@
 #define EVENT_OBJECT_TEMPLATES_COUNT 64
 #define DECOR_MAX_SECRET_BASE 16
 #define DECOR_MAX_PLAYERS_HOUSE 12
+#define APPRENTICE_COUNT 4
+#define APPRENTICE_MAX_QUESTIONS 9
 
 #define PYRAMID_BAG_ITEMS_COUNT 10
 #define HALL_FACILITIES_COUNT 9 // 7 facilities for single mode + tower double mode + tower multi mode.
@@ -63,6 +66,7 @@
 #define POKEMON_NAME_LENGTH 10
 #define PLAYER_NAME_LENGTH 7
 #define MAIL_WORDS_COUNT 9
+#define EASY_CHAT_BATTLE_WORDS_COUNT 6
 #define MOVE_NAME_LENGTH 12
 
 #define MALE 0

include/constants/pokemon.h

@@ -195,6 +195,10 @@
 #define MON_ALREADY_KNOWS_MOVE  0xFFFE
 #define MON_HAS_MAX_MOVES       0xFFFF
 
+#define LEVEL_UP_MOVE_ID   0x01FF
+#define LEVEL_UP_MOVE_LV   0xFE00
+#define LEVEL_UP_END       0xFFFF
+
 #define MON_MALE       0x00
 #define MON_FEMALE     0xFE
 #define MON_GENDERLESS 0xFF