Document party_menu first pass

7 files changed, 113 insertions, 24 deletions

diff --git a/include/constants/battle_frontier.h b/include/constants/battle_frontier.h
index d287dd2db..b849686f5 100644
--- a/include/constants/battle_frontier.h
+++ b/include/constants/battle_frontier.h
@@ -4,16 +4,17 @@
 #define FRONTIER_CHALLENGE(facility, mode) ((facility << 8) + mode)
 
 // Battle Frontier facility ids.
-#define FRONTIER_FACILITY_TOWER 0
-#define FRONTIER_FACILITY_DOME 1
-#define FRONTIER_FACILITY_PALACE 2
-#define FRONTIER_FACILITY_ARENA 3
-#define FRONTIER_FACILITY_FACTORY 4
-#define FRONTIER_FACILITY_PIKE 5
-#define FRONTIER_FACILITY_PYRAMID 6
-#define NUM_FRONTIER_FACILITIES 7
+#define FRONTIER_FACILITY_TOWER    0
+#define FRONTIER_FACILITY_DOME     1
+#define FRONTIER_FACILITY_PALACE   2
+#define FRONTIER_FACILITY_ARENA    3
+#define FRONTIER_FACILITY_FACTORY  4
+#define FRONTIER_FACILITY_PIKE     5
+#define FRONTIER_FACILITY_PYRAMID  6
+#define NUM_FRONTIER_FACILITIES    7
 // The multiplayer battle colosseum rooms re-use VAR_FRONTIER_FACILITY.
-#define FRONTIER_FACILITY_DOUBLE_COLOSSEUM 9
+#define FACILITY_UNION_ROOM        8
+#define FACILITY_MULTI_OR_EREADER  9  // Direct Corner multi battles, multi battle with Steven, and e-Reader battles
 
 #define TENT_VERDANTURF 2
 #define TENT_FALLARBOR 3
diff --git a/include/constants/contest.h b/include/constants/contest.h
index d3296222b..0c866069e 100644
--- a/include/constants/contest.h
+++ b/include/constants/contest.h
@@ -16,4 +16,10 @@
 #define CONTEST_CATEGORY_TOUGH    4
 #define CONTEST_CATEGORIES_COUNT  5
 
+#define CANT_ENTER_CONTEST             0
+#define CAN_ENTER_CONTEST_EQUAL_RANK   1
+#define CAN_ENTER_CONTEST_HIGH_RANK    2
+#define CANT_ENTER_CONTEST_EGG         3
+#define CANT_ENTER_CONTEST_FAINTED     4
+
 #endif  // GUARD_CONSTANTS_CONTEST_H
diff --git a/include/constants/flags.h b/include/constants/flags.h
index 750990697..56c06b1c7 100644
--- a/include/constants/flags.h
+++ b/include/constants/flags.h
@@ -883,7 +883,7 @@
 #define FLAG_HIDE_LILCOVE_MOTEL_GAME_DESIGNERS                      0x39D
 #define FLAG_HIDE_MT_CHIMNEY_TEAM_AQUA                              0x39E
 #define FLAG_HIDE_MT_CHIMNEY_TEAM_MAGMA                             0x39F
-#define FLAG_HIDE_FALLARBOR_HOUSE_1_PROF_COZMO                      0x3A0
+#define FLAG_HIDE_FALLARBOR_HOUSE_PROF_COZMO                        0x3A0
 #define FLAG_HIDE_LAVARIDGE_TOWN_RIVAL_1                            0x3A1
 #define FLAG_HIDE_LAVARIDGE_TOWN_RIVAL_2                            0x3A2
 #define FLAG_HIDE_RUSTURF_TUNNEL_ROCK_1                             0x3A3
@@ -1552,6 +1552,6 @@
 #define FLAG_SPECIAL_FLAG_0x4001                                   0x4001
 #define FLAG_SPECIAL_FLAG_0x4002                                   0x4002
 #define FLAG_SPECIAL_FLAG_0x4003                                   0x4003
-#define FLAG_SPECIAL_FLAG_0x4004                                   0x4004
+#define FLAG_STORING_ITEMS_IN_PYRAMID_BAG                          0x4004
 
 #endif // GUARD_CONSTANTS_FLAGS_H
diff --git a/include/constants/map_groups.h b/include/constants/map_groups.h
index 6a3276b44..802c381b5 100755
--- a/include/constants/map_groups.h
+++ b/include/constants/map_groups.h
@@ -98,8 +98,8 @@
 #define MAP_FALLARBOR_TOWN_BATTLE_TENT_BATTLE_ROOM (3 | (5 << 8))
 #define MAP_FALLARBOR_TOWN_POKEMON_CENTER_1F       (4 | (5 << 8))
 #define MAP_FALLARBOR_TOWN_POKEMON_CENTER_2F       (5 | (5 << 8))
-#define MAP_FALLARBOR_TOWN_HOUSE1                  (6 | (5 << 8))
-#define MAP_FALLARBOR_TOWN_HOUSE2                  (7 | (5 << 8))
+#define MAP_FALLARBOR_TOWN_COZMOS_HOUSE            (6 | (5 << 8))
+#define MAP_FALLARBOR_TOWN_MOVE_RELEARNERS_HOUSE   (7 | (5 << 8))
 
 // Map Group 6
 #define MAP_VERDANTURF_TOWN_BATTLE_TENT_LOBBY       (0 | (6 << 8))
diff --git a/include/constants/party_menu.h b/include/constants/party_menu.h
index 213263b47..a15280afb 100644
--- a/include/constants/party_menu.h
+++ b/include/constants/party_menu.h
@@ -10,13 +10,6 @@
 #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
@@ -49,4 +42,91 @@
 #define TUTOR_MOVE_FURY_CUTTER     29
 #define TUTOR_MOVE_COUNT           30
 
+#define PARTY_LAYOUT_SINGLE          0
+#define PARTY_LAYOUT_DOUBLE          1
+#define PARTY_LAYOUT_MULTI           2
+#define PARTY_LAYOUT_MULTI_SHOWCASE  3  // The layout during the screen that appears just before a multi battle
+#define PARTY_LAYOUT_COUNT           4
+#define KEEP_PARTY_LAYOUT            0xFF
+
+#define PARTY_MENU_TYPE_FIELD                     0 
+#define PARTY_MENU_TYPE_IN_BATTLE                 1 
+#define PARTY_MENU_TYPE_CONTEST                   2 
+#define PARTY_MENU_TYPE_CHOOSE_MON                3 
+#define PARTY_MENU_TYPE_CHOOSE_HALF               4  // multi battles, eReader battles, and some battle facilities
+#define PARTY_MENU_TYPE_IN_MULTI_BATTLE           5  // TODO: investigate
+#define PARTY_MENU_TYPE_DAYCARE                   6 
+#define PARTY_MENU_TYPE_MOVE_RELEARNER            7 
+#define PARTY_MENU_TYPE_UNION_ROOM_REGISTER       8  // trading board
+#define PARTY_MENU_TYPE_UNION_ROOM_TRADE          9  // trading board
+#define PARTY_MENU_TYPE_SPIN_TRADE                10 // Unused beta for Gen IV's Spin Trade
+#define PARTY_MENU_TYPE_MINIGAME                  11
+#define PARTY_MENU_TYPE_STORE_PYRAMID_HELD_ITEMS  12
+
+#define PARTY_ACTION_CHOOSE_MON         0
+#define PARTY_ACTION_SEND_OUT           1
+#define PARTY_ACTION_CANT_SWITCH        2
+#define PARTY_ACTION_USE_ITEM           3
+#define PARTY_ACTION_ABILITY_PREVENTS   4
+#define PARTY_ACTION_GIVE_ITEM          5  
+#define PARTY_ACTION_GIVE_PC_ITEM       6   // Unused. Not possible to give non-mail items directly from PC
+#define PARTY_ACTION_GIVE_MAILBOX_MAIL  7
+#define PARTY_ACTION_SWITCH             8
+#define PARTY_ACTION_SWITCHING          9
+#define PARTY_ACTION_SOFTBOILED         10
+#define PARTY_ACTION_CHOOSE_AND_CLOSE   11
+#define PARTY_ACTION_MOVE_TUTOR         12
+#define PARTY_ACTION_MINIGAME           13
+#define PARTY_ACTION_REUSABLE_ITEM      14  // Unused. The only reusable items are handled separately
+
+// IDs for DisplayPartyMenuStdMessage, to display the message at the bottom of the party menu
+#define PARTY_MSG_CHOOSE_MON                0
+#define PARTY_MSG_CHOOSE_MON_OR_CANCEL      1
+#define PARTY_MSG_CHOOSE_MON_AND_CONFIRM    2
+#define PARTY_MSG_MOVE_TO_WHERE             3 
+#define PARTY_MSG_TEACH_WHICH_MON           4
+#define PARTY_MSG_USE_ON_WHICH_MON          5
+#define PARTY_MSG_GIVE_TO_WHICH_MON         6
+#define PARTY_MSG_NOTHING_TO_CUT            7
+#define PARTY_MSG_CANT_SURF_HERE            8
+#define PARTY_MSG_ALREADY_SURFING           9
+#define PARTY_MSG_CURRENT_TOO_FAST          10
+#define PARTY_MSG_ENJOY_CYCLING             11
+#define PARTY_MSG_ALREADY_IN_USE            12
+#define PARTY_MSG_CANT_USE_HERE             13
+#define PARTY_MSG_NO_MON_FOR_BATTLE         14
+#define PARTY_MSG_CHOOSE_MON_2              15
+#define PARTY_MSG_NOT_ENOUGH_HP             16
+#define PARTY_MSG_X_MONS_ARE_NEEDED         17
+#define PARTY_MSG_MONS_CANT_BE_SAME         18
+#define PARTY_MSG_NO_SAME_HOLD_ITEMS        19
+#define PARTY_MSG_UNUSED                    20
+#define PARTY_MSG_DO_WHAT_WITH_MON          21
+#define PARTY_MSG_RESTORE_WHICH_MOVE        22
+#define PARTY_MSG_BOOST_PP_WHICH_MOVE       23
+#define PARTY_MSG_DO_WHAT_WITH_ITEM         24
+#define PARTY_MSG_DO_WHAT_WITH_MAIL         25
+#define PARTY_MSG_ALREADY_HOLDING_ONE       26
+#define PARTY_MSG_NONE                      127
+
+// IDs for DisplayPartyPokemonDescriptionText, to display a message in the party pokemon's box
+#define PARTYBOX_DESC_NO_USE      0
+#define PARTYBOX_DESC_ABLE_3      1
+#define PARTYBOX_DESC_FIRST       2
+#define PARTYBOX_DESC_SECOND      3
+#define PARTYBOX_DESC_THIRD       4
+#define PARTYBOX_DESC_FOURTH      5
+#define PARTYBOX_DESC_ABLE        6
+#define PARTYBOX_DESC_NOT_ABLE    7
+#define PARTYBOX_DESC_ABLE_2      8
+#define PARTYBOX_DESC_NOT_ABLE_2  9
+#define PARTYBOX_DESC_LEARNED     10
+#define PARTYBOX_DESC_HAVE        11
+#define PARTYBOX_DESC_DONT_HAVE   12
+
+#define SELECTWINDOW_ACTIONS  0
+#define SELECTWINDOW_ITEM     1
+#define SELECTWINDOW_MAIL     2
+#define SELECTWINDOW_MOVES    3
+
 #endif // GUARD_CONSTANTS_PARTY_MENU_H
diff --git a/include/constants/pokemon.h b/include/constants/pokemon.h
index 5cd98d3f3..b2084f154 100644
--- a/include/constants/pokemon.h
+++ b/include/constants/pokemon.h
@@ -184,7 +184,6 @@
 #define OT_ID_PRESET          1
 #define OT_ID_RANDOM_NO_SHINY 2
 
-
 #define MON_GIVEN_TO_PARTY      0
 #define MON_GIVEN_TO_PC         1
 #define MON_CANT_GIVE           2
@@ -193,6 +192,9 @@
 #define PLAYER_HAS_ONE_MON             1
 #define PLAYER_HAS_ONE_USABLE_MON      2
 
+#define MON_ALREADY_KNOWS_MOVE  0xFFFE
+#define MON_HAS_MAX_MOVES       0xFFFF
+
 #define MON_MALE       0x00
 #define MON_FEMALE     0xFE
 #define MON_GENDERLESS 0xFF
diff --git a/include/constants/trade.h b/include/constants/trade.h
index 4fb8966d0..fa42e6b43 100644
--- a/include/constants/trade.h
+++ b/include/constants/trade.h
@@ -20,13 +20,13 @@
 #define READY_FINISH_TRADE  1
 #define FINISH_TRADE        2
 
-// Return values for CanTradeSelectedMon and CanTradeSelectedPartyMenuMon
+// Return values for CanTradeSelectedMon and CanSpinTradeMon
 #define CAN_TRADE_MON           0
 #define CANT_TRADE_LAST_MON     1
 #define CANT_TRADE_NATIONAL     2
-#define CANT_TRADE_EGG          3
+#define CANT_TRADE_EGG_YET      3
 #define CANT_TRADE_INVALID_MON  4
-#define CANT_TRADE_EGG2         5
+#define CANT_TRADE_EGG_YET2     5
 
 // Return values for CheckValidityOfTradeMons
 #define PLAYER_MON_INVALID   0