Merge pull request #830 from GriffinRichards/doc-inc

Document some .incs split from event_scripts

6 files changed, 170 insertions, 8 deletions

diff --git a/include/constants/battle_pike.h b/include/constants/battle_pike.h
new file mode 100644
index 000000000..e92c4a006
--- /dev/null
+++ b/include/constants/battle_pike.h
@@ -0,0 +1,49 @@
+#ifndef GUARD_CONSTANTS_BATTLE_PIKE_H
+#define GUARD_CONSTANTS_BATTLE_PIKE_H
+
+#define PIKE_ROOM_SINGLE_BATTLE 0
+#define PIKE_ROOM_HEAL_FULL 1
+#define PIKE_ROOM_NPC 2
+#define PIKE_ROOM_STATUS 3
+#define PIKE_ROOM_HEAL_PART 4
+#define PIKE_ROOM_WILD_MONS 5
+#define PIKE_ROOM_HARD_BATTLE 6
+#define PIKE_ROOM_DOUBLE_BATTLE 7
+#define PIKE_ROOM_BRAIN 8
+
+// For the room with a status effect.
+#define PIKE_STATUS_KIRLIA 0
+#define PIKE_STATUS_DUSCLOPS 1
+
+// Function IDs for sBattlePikeFunctions / CallBattlePikeFunction
+#define BATTLE_PIKE_FUNC_SET_ROOM_TYPE                0
+#define BATTLE_PIKE_FUNC_GET_DATA                     1
+#define BATTLE_PIKE_FUNC_SET_DATA                     2
+#define BATTLE_PIKE_FUNC_IN_FINAL_ROOM                3
+#define BATTLE_PIKE_FUNC_SET_UP_ROOM_OBJECTS          4
+#define BATTLE_PIKE_FUNC_GET_ROOM_TYPE                5
+#define BATTLE_PIKE_FUNC_6                            6
+#define BATTLE_PIKE_FUNC_7                            7
+#define BATTLE_PIKE_FUNC_8                            8
+#define BATTLE_PIKE_FUNC_NULL_9                       9
+#define BATTLE_PIKE_FUNC_NULL_10                      10
+#define BATTLE_PIKE_FUNC_GET_ROOM_STATUS              11
+#define BATTLE_PIKE_FUNC_GET_ROOM_STATUS_MON          12
+#define BATTLE_PIKE_FUNC_HEAL_ONE_TWO_MONS            13
+#define BATTLE_PIKE_FUNC_BUFFER_NPC_MSG               14
+#define BATTLE_PIKE_FUNC_STATUS_SCREEN_FADE           15
+#define BATTLE_PIKE_FUNC_IS_IN                        16
+#define BATTLE_PIKE_FUNC_SET_HINT_ROOM                17
+#define BATTLE_PIKE_FUNC_SET_HINT_ROOM_ID             18
+#define BATTLE_PIKE_FUNC_GET_ROOM_TYPE_HINT           19
+#define BATTLE_PIKE_FUNC_CLEAR_TRAINER_IDS            20
+#define BATTLE_PIKE_FUNC_BUFFER_RECORD_MIX_MSG        21
+#define BATTLE_PIKE_FUNC_GET_QUEEN_FIGHT_TYPE         22
+#define BATTLE_PIKE_FUNC_HEAL_MONS_BEFORE_QUEEN       23
+#define BATTLE_PIKE_FUNC_SET_HEALING_ROOMS_DISABLED   24
+#define BATTLE_PIKE_FUNC_CAN_PARTY_BE_HEALED          25
+#define BATTLE_PIKE_FUNC_SAVE_MON_HELD_ITEMS          26
+#define BATTLE_PIKE_FUNC_LOAD_MON_HELD_ITEMS          27
+#define BATTLE_PIKE_FUNC_INIT_CHALLENGE               28
+
+#endif // GUARD_CONSTANTS_BATTLE_PIKE_H
diff --git a/include/constants/battle_pyramid.h b/include/constants/battle_pyramid.h
new file mode 100644
index 000000000..0d59ae94d
--- /dev/null
+++ b/include/constants/battle_pyramid.h
@@ -0,0 +1,49 @@
+#ifndef GUARD_CONSTANTS_BATTLE_PYRAMID_H
+#define GUARD_CONSTANTS_BATTLE_PYRAMID_H
+
+#define TOTAL_ROUNDS 20
+#define PICKUP_ITEMS_PER_ROUND 10
+
+#define FLOOR_WALKABLE_METATILE 0x28D
+#define FLOOR_EXIT_METATILE 0x28E
+
+#define HINT_EXIT_DIRECTION                   0
+#define HINT_REMAINING_ITEMS                  1
+#define HINT_REMAINING_TRAINERS               2
+#define HINT_EXIT_SHORT_REMAINING_TRAINERS    3
+#define HINT_EXIT_SHORT_REMAINING_ITEMS       4
+#define HINT_EXIT_MEDIUM_REMAINING_TRAINERS   5
+#define HINT_EXIT_MEDIUM_REMAINING_ITEMS      6
+#define HINT_EXIT_FAR_REMAINING_TRAINERS      7
+#define HINT_EXIT_FAR_REMAINING_ITEMS         8
+
+#define OBJ_TRAINERS  0
+#define OBJ_ITEMS     1
+
+#define OBJ_POSITIONS_UNIFORM               0
+#define OBJ_POSITIONS_IN_AND_NEAR_ENTRANCE  1
+#define OBJ_POSITIONS_IN_AND_NEAR_EXIT      2
+#define OBJ_POSITIONS_NEAR_ENTRANCE         3         
+#define OBJ_POSITIONS_NEAR_EXIT             4
+
+// Functions IDs for sBattlePyramidFunctions / CallBattlePyramidFunction
+#define BATTLE_PYRAMID_FUNC_INIT_CHALLENGE      0
+#define BATTLE_PYRAMID_FUNC_GET_DATA            1
+#define BATTLE_PYRAMID_FUNC_SET_DATA            2
+#define BATTLE_PYRAMID_FUNC_3                   3
+#define BATTLE_PYRAMID_FUNC_SET_REWARD          4
+#define BATTLE_PYRAMID_FUNC_GIVE_REWARD         5
+#define BATTLE_PYRAMID_FUNC_SEED_FLOOR          6
+#define BATTLE_PYRAMID_FUNC_SET_ITEM            7
+#define BATTLE_PYRAMID_FUNC_HIDE_ITEM           8
+#define BATTLE_PYRAMID_FUNC_INIT_TRAINERS       9
+#define BATTLE_PYRAMID_FUNC_SHOW_HINT_TEXT      10
+#define BATTLE_PYRAMID_FUNC_UPDATE_STREAK       11
+#define BATTLE_PYRAMID_FUNC_IS_IN               12
+#define BATTLE_PYRAMID_FUNC_UPDATE_LIGHT        13
+#define BATTLE_PYRAMID_FUNC_CLEAR_HELD_ITEMS    14
+#define BATTLE_PYRAMID_FUNC_SET_FLOOR_PALETTE   15
+#define BATTLE_PYRAMID_FUNC_16                  16
+#define BATTLE_PYRAMID_FUNC_RESTORE_PARTY       17
+
+#endif // GUARD_CONSTANTS_BATTLE_PYRAMID_H
diff --git a/include/constants/field_poison.h b/include/constants/field_poison.h
new file mode 100644
index 000000000..19b91e7c2
--- /dev/null
+++ b/include/constants/field_poison.h
@@ -0,0 +1,12 @@
+#ifndef GUARD_CONSTANTS_FIELD_POISON_H
+#define GUARD_CONSTANTS_FIELD_POISON_H
+
+#define FLDPSN_NONE  0
+#define FLDPSN_PSN   1
+#define FLDPSN_FNT   2
+
+#define FLDPSN_NO_WHITEOUT        0
+#define FLDPSN_WHITEOUT           1
+#define FLDPSN_FRONTIER_WHITEOUT  2
+
+#endif //GUARD_CONSTANTS_FIELD_POISON_H
diff --git a/include/constants/flags.h b/include/constants/flags.h
index d90451ad7..750990697 100644
--- a/include/constants/flags.h
+++ b/include/constants/flags.h
@@ -925,7 +925,7 @@
 #define FLAG_HIDE_MOSSDEEP_CITY_STEVENS_HOUSE_STEVEN                0x3C7
 #define FLAG_HIDE_MOSSDEEP_CITY_STEVENS_HOUSE_BELDUM_POKEBALL       0x3C8
 #define FLAG_HIDE_FORTREE_CITY_KECLEON                              0x3C9
-#define FLAG_HIDE_ROUTE_120_KECLEON_1                               0x3CA
+#define FLAG_HIDE_ROUTE_120_KECLEON_BRIDGE_INVISIBLE                0x3CA
 #define FLAG_HIDE_LILYCOVE_CITY_RIVAL                               0x3CB
 #define FLAG_HIDE_ROUTE_120_STEVEN                                  0x3CC
 #define FLAG_HIDE_SOOTOPOLIS_CITY_STEVEN                            0x3CD
@@ -936,14 +936,14 @@
 #define FLAG_HIDE_AQUA_HIDEOUT_B1F_ELECTRODE_2                      0x3D2
 #define FLAG_HIDE_OLDALE_TOWN_RIVAL                                 0x3D3
 #define FLAG_HIDE_UNDERWATER_SEA_FLOOR_CAVERN_STOLEN_SUBMARINE      0x3D4
-#define FLAG_HIDE_ROUTE_120_KECLEON_BRIDGE                          0x3D5
-#define FLAG_HIDE_ROUTE_120_KECLEON_2                               0x3D6
+#define FLAG_HIDE_ROUTE_120_KECLEON_BRIDGE_VISIBLE                  0x3D5
+#define FLAG_HIDE_ROUTE_120_KECLEON_1                               0x3D6
 #define FLAG_HIDE_RUSTURF_TUNNEL_LOVER_WOMAN                        0x3D7
 #define FLAG_HIDE_VERDANTURF_TOWN_WANDAS_HOUSE_LOVER_WOMAN          0x3D8
-#define FLAG_HIDE_ROUTE_120_KECLEON_3                               0x3D9
-#define FLAG_HIDE_ROUTE_120_KECLEON_4                               0x3DA
-#define FLAG_HIDE_ROUTE_120_KECLEON_5                               0x3DB
-#define FLAG_HIDE_ROUTE_120_KECLEON_6                               0x3DC
+#define FLAG_HIDE_ROUTE_120_KECLEON_2                               0x3D9
+#define FLAG_HIDE_ROUTE_120_KECLEON_3                               0x3DA
+#define FLAG_HIDE_ROUTE_120_KECLEON_4                               0x3DB
+#define FLAG_HIDE_ROUTE_120_KECLEON_5                               0x3DC
 #define FLAG_HIDE_ROUTE_119_KECLEON_1                               0x3DD
 #define FLAG_HIDE_ROUTE_119_KECLEON_2                               0x3DE
 #define FLAG_HIDE_ROUTE_101_BOY                                     0x3DF
diff --git a/include/constants/party_menu.h b/include/constants/party_menu.h
new file mode 100644
index 000000000..213263b47
--- /dev/null
+++ b/include/constants/party_menu.h
@@ -0,0 +1,52 @@
+#ifndef GUARD_CONSTANTS_PARTY_MENU_H
+#define GUARD_CONSTANTS_PARTY_MENU_H
+
+#define AILMENT_NONE  0
+#define AILMENT_PSN   1
+#define AILMENT_PRZ   2
+#define AILMENT_SLP   3
+#define AILMENT_FRZ   4
+#define AILMENT_BRN   5
+#define AILMENT_PKRS  6
+#define AILMENT_FNT   7
+
+#define PARTY_CHOOSE_MON        0
+#define PARTY_MUST_CHOOSE_MON   1
+#define PARTY_CANT_SWITCH       2
+#define PARTY_USE_ITEM_ON       3
+#define PARTY_ABILITY_PREVENTS  4
+#define PARTY_GIVE_ITEM         5
+
+#define TUTOR_MOVE_MEGA_PUNCH      0
+#define TUTOR_MOVE_SWORDS_DANCE    1
+#define TUTOR_MOVE_MEGA_KICK       2
+#define TUTOR_MOVE_BODY_SLAM       3
+#define TUTOR_MOVE_DOUBLE_EDGE     4
+#define TUTOR_MOVE_COUNTER         5
+#define TUTOR_MOVE_SEISMIC_TOSS    6
+#define TUTOR_MOVE_MIMIC           7
+#define TUTOR_MOVE_METRONOME       8
+#define TUTOR_MOVE_SOFT_BOILED     9
+#define TUTOR_MOVE_DREAM_EATER     10
+#define TUTOR_MOVE_THUNDER_WAVE    11
+#define TUTOR_MOVE_EXPLOSION       12
+#define TUTOR_MOVE_ROCK_SLIDE      13
+#define TUTOR_MOVE_SUBSTITUTE      14
+#define TUTOR_MOVE_DYNAMIC_PUNCH   15
+#define TUTOR_MOVE_ROLLOUT         16
+#define TUTOR_MOVE_PSYCH_UP        17
+#define TUTOR_MOVE_SNORE           18
+#define TUTOR_MOVE_ICY_WIND        19
+#define TUTOR_MOVE_ENDURE          20
+#define TUTOR_MOVE_MUD_SLAP        21
+#define TUTOR_MOVE_ICE_PUNCH       22
+#define TUTOR_MOVE_SWAGGER         23
+#define TUTOR_MOVE_SLEEP_TALK      24
+#define TUTOR_MOVE_SWIFT           25
+#define TUTOR_MOVE_DEFENSE_CURL    26
+#define TUTOR_MOVE_THUNDER_PUNCH   27
+#define TUTOR_MOVE_FIRE_PUNCH      28
+#define TUTOR_MOVE_FURY_CUTTER     29
+#define TUTOR_MOVE_COUNT           30
+
+#endif // GUARD_CONSTANTS_PARTY_MENU_H
diff --git a/include/constants/trainer_hill.h b/include/constants/trainer_hill.h
index 4aae1dbbc..cab56a5ac 100644
--- a/include/constants/trainer_hill.h
+++ b/include/constants/trainer_hill.h
@@ -11,7 +11,7 @@
 #define TRAINER_HILL_FUNC_7 7
 #define TRAINER_HILL_FUNC_8 8
 #define TRAINER_HILL_FUNC_9 9
-#define TRAINER_HILL_FUNC_10 10
+#define TRAINER_HILL_FUNC_IS_IN 10
 #define TRAINER_HILL_FUNC_11 11
 #define TRAINER_HILL_FUNC_12 12
 #define TRAINER_HILL_FUNC_13 13