Remainder of script_menu documentation

2 files changed, 124 insertions, 124 deletions

diff --git a/include/constants/script_menu.h b/include/constants/script_menu.h
index 820ecad6e..013cb8a27 100644
--- a/include/constants/script_menu.h
+++ b/include/constants/script_menu.h
@@ -8,120 +8,120 @@
 #define MULTI_B_PRESSED  127
 
 // Multichoice Ids
-#define MULTI_BRINEY_ON_DEWFORD         0
-#define MULTI_PC                        1 // Exit only, populated by CreatePCMultichoice
-#define MULTI_ENTERINFO                 2
-#define MULTI_CONTEST_INFO              3
-#define MULTI_CONTEST_TYPE              4
-#define MULTI_DECOR_NOREGISTRY          5
-#define MULTI_DECOR_REGISTRY            6
-#define MULTI_REGISTER_MENU             7
-#define MULTI_SSTIDAL_LILYCOVE          8 // Exit only, populated by CreateLilycoveSSTidalMultichoice
-#define MULTI_UNUSED_9                  9
-#define MULTI_UNUSED_10                 10
-#define MULTI_FRONTIER_PASS_INFO        11
-#define MULTI_BIKE                      12
-#define MULTI_STATUS_INFO               13
-#define MULTI_BRINEY_OFF_DEWFORD        14
-#define MULTI_UNUSED_15                 15
-#define MULTI_VIEWED_PAINTINGS          16
-#define MULTI_YESNOINFO                 17
-#define MULTI_BATTLE_MODE               18
-#define MULTI_UNUSED_19                 19
-#define MULTI_YESNOINFO_2               20
-#define MULTI_UNUSED_21                 21
-#define MULTI_UNUSED_22                 22
-#define MULTI_CHALLENGEINFO             23
-#define MULTI_LEVEL_MODE                24
-#define MULTI_MECHADOLL1_Q1             25
-#define MULTI_MECHADOLL1_Q2             26
-#define MULTI_MECHADOLL1_Q3             27
-#define MULTI_MECHADOLL2_Q1             28
-#define MULTI_MECHADOLL2_Q2             29
-#define MULTI_MECHADOLL2_Q3             30
-#define MULTI_MECHADOLL3_Q1             31
-#define MULTI_MECHADOLL3_Q2             32
-#define MULTI_MECHADOLL3_Q3             33
-#define MULTI_MECHADOLL4_Q1             34
-#define MULTI_MECHADOLL4_Q2             35
-#define MULTI_MECHADOLL4_Q3             36
-#define MULTI_MECHADOLL5_Q1             37
-#define MULTI_MECHADOLL5_Q2             38
-#define MULTI_MECHADOLL5_Q3             39
-#define MULTI_UNUSED_40                 40
-#define MULTI_UNUSED_41                 41
-#define MULTI_VENDING_MACHINE           42
-#define MULTI_MACH_BIKE_INFO            43
-#define MULTI_ACRO_BIKE_INFO            44
-#define MULTI_SATISFACTION              45
-#define MULTI_STERN_DEEPSEA             46
-#define MULTI_UNUSED_ASH_VENDOR         47 // Replaced by scrollable multichoice
-#define MULTI_GAME_CORNER_DOLLS         48
-#define MULTI_GAME_CORNER_COINS         49
-#define MULTI_HOWS_FISHING              50
-#define MULTI_UNUSED_51                 51
-#define MULTI_SSTIDAL_SLATEPORT_1       52 // TODO: rename
-#define MULTI_SSTIDAL_BATTLE_FRONTIER   53
-#define MULTI_RIGHTLEFT                 54
-#define MULTI_GAME_CORNER_TMS           55
-#define MULTI_SSTIDAL_SLATEPORT_2       56 //
-#define MULTI_FLOORS                    57 
-#define MULTI_SHARDS_R                  58
-#define MULTI_SHARDS_Y                  59
-#define MULTI_SHARDS_RY                 60
-#define MULTI_SHARDS_B                  61
-#define MULTI_SHARDS_RB                 62
-#define MULTI_SHARDS_YB                 63
-#define MULTI_SHARDS_RYB                64
-#define MULTI_SHARDS_G                  65
-#define MULTI_SHARDS_RG                 66
-#define MULTI_SHARDS_YG                 67
-#define MULTI_SHARDS_RYG                68
-#define MULTI_SHARDS_BG                 69
-#define MULTI_SHARDS_RBG                70
-#define MULTI_SHARDS_YBG                71
-#define MULTI_SHARDS_RYBG               72
-#define MULTI_TOURNEY_WITH_RECORD       73
-#define MULTI_LINK_SERVICES_A1          74 // TODO: rename
-#define MULTI_LINK_SERVICES_A2          75 //
-#define MULTI_LINK_SERVICES_B1          76 //
-#define MULTI_LINK_SERVICES_B2          77 //
-#define MULTI_LINK_SERVICES_C           78 //
-#define MULTI_LINK_SERVICES_D           79 //
-#define MULTI_WIRELESS_MINIGAME         80
-#define MULTI_LINK_LEADER               81
-#define MULTI_CONTEST_RANK              82
-#define MULTI_FRONTIER_ITEM_CHOOSE      83
-#define MULTI_LINK_CONTEST_INFO         84
-#define MULTI_LINK_CONTEST_MODE         85
-#define MULTI_FORCED_START_MENU         86
-#define MULTI_FRONTIER_GAMBLER_BET      87
-#define MULTI_TENT                      88
-#define MULTI_UNUSED_SSTIDAL_1          89 // These 4 were replaced by CreateLilycoveSSTidalMultichoice
-#define MULTI_UNUSED_SSTIDAL_2          90 //
-#define MULTI_UNUSED_SSTIDAL_3          91 //
-#define MULTI_UNUSED_SSTIDAL_4          92 //
-#define MULTI_FOSSIL                    93
-#define MULTI_YESNO                     94
-#define MULTI_FRONTIER_RULES            95
-#define MULTI_BATTLE_ARENA_RULES        96
-#define MULTI_BATTLE_TOWER_RULES        97
-#define MULTI_BATTLE_DOME_RULES         98
-#define MULTI_BATTLE_FACTORY_RULES      99
-#define MULTI_BATTLE_PALACE_RULES       100
-#define MULTI_BATTLE_PYRAMID_RULES      101
-#define MULTI_BATTLE_PIKE_RULES         102
-#define MULTI_GO_ON_RECORD_REST_RETIRE  103
-#define MULTI_GO_ON_REST_RETIRE         104
-#define MULTI_GO_ON_RECORD_RETIRE       105
-#define MULTI_GO_ON_RETIRE              106
-#define MULTI_TOURNEY_NO_RECORD         107
-#define MULTI_TV_LATI                   108
-#define MULTI_BATTLE_TOWER_FEELINGS     109
-#define MULTI_WHERES_RAYQUAZA           110
-#define MULTI_SLATEPORT_TENT_RULES      111
-#define MULTI_FALLARBOR_TENT_RULES      112
-#define MULTI_TAG_MATCH_TYPE            113
+#define MULTI_BRINEY_ON_DEWFORD            0
+#define MULTI_PC                           1 // Exit only, populated by CreatePCMultichoice
+#define MULTI_ENTERINFO                    2
+#define MULTI_CONTEST_INFO                 3
+#define MULTI_CONTEST_TYPE                 4
+#define MULTI_DECOR_NOREGISTRY             5
+#define MULTI_DECOR_REGISTRY               6
+#define MULTI_REGISTER_MENU                7
+#define MULTI_SSTIDAL_LILYCOVE             8 // Exit only, populated by CreateLilycoveSSTidalMultichoice
+#define MULTI_UNUSED_9                     9
+#define MULTI_UNUSED_10                    10
+#define MULTI_FRONTIER_PASS_INFO           11
+#define MULTI_BIKE                         12
+#define MULTI_STATUS_INFO                  13
+#define MULTI_BRINEY_OFF_DEWFORD           14
+#define MULTI_UNUSED_15                    15
+#define MULTI_VIEWED_PAINTINGS             16
+#define MULTI_YESNOINFO                    17
+#define MULTI_BATTLE_MODE                  18
+#define MULTI_UNUSED_19                    19
+#define MULTI_YESNOINFO_2                  20
+#define MULTI_UNUSED_21                    21
+#define MULTI_UNUSED_22                    22
+#define MULTI_CHALLENGEINFO                23
+#define MULTI_LEVEL_MODE                   24
+#define MULTI_MECHADOLL1_Q1                25
+#define MULTI_MECHADOLL1_Q2                26
+#define MULTI_MECHADOLL1_Q3                27
+#define MULTI_MECHADOLL2_Q1                28
+#define MULTI_MECHADOLL2_Q2                29
+#define MULTI_MECHADOLL2_Q3                30
+#define MULTI_MECHADOLL3_Q1                31
+#define MULTI_MECHADOLL3_Q2                32
+#define MULTI_MECHADOLL3_Q3                33
+#define MULTI_MECHADOLL4_Q1                34
+#define MULTI_MECHADOLL4_Q2                35
+#define MULTI_MECHADOLL4_Q3                36
+#define MULTI_MECHADOLL5_Q1                37
+#define MULTI_MECHADOLL5_Q2                38
+#define MULTI_MECHADOLL5_Q3                39
+#define MULTI_UNUSED_40                    40
+#define MULTI_UNUSED_41                    41
+#define MULTI_VENDING_MACHINE              42
+#define MULTI_MACH_BIKE_INFO               43
+#define MULTI_ACRO_BIKE_INFO               44
+#define MULTI_SATISFACTION                 45
+#define MULTI_STERN_DEEPSEA                46
+#define MULTI_UNUSED_ASH_VENDOR            47 // Replaced by scrollable multichoice
+#define MULTI_GAME_CORNER_DOLLS            48
+#define MULTI_GAME_CORNER_COINS            49
+#define MULTI_HOWS_FISHING                 50
+#define MULTI_UNUSED_51                    51
+#define MULTI_SSTIDAL_SLATEPORT_WITH_BF    52
+#define MULTI_SSTIDAL_BATTLE_FRONTIER      53
+#define MULTI_RIGHTLEFT                    54
+#define MULTI_GAME_CORNER_TMS              55
+#define MULTI_SSTIDAL_SLATEPORT_NO_BF      56
+#define MULTI_FLOORS                       57 
+#define MULTI_SHARDS_R                     58
+#define MULTI_SHARDS_Y                     59
+#define MULTI_SHARDS_RY                    60
+#define MULTI_SHARDS_B                     61
+#define MULTI_SHARDS_RB                    62
+#define MULTI_SHARDS_YB                    63
+#define MULTI_SHARDS_RYB                   64
+#define MULTI_SHARDS_G                     65
+#define MULTI_SHARDS_RG                    66
+#define MULTI_SHARDS_YG                    67
+#define MULTI_SHARDS_RYG                   68
+#define MULTI_SHARDS_BG                    69
+#define MULTI_SHARDS_RBG                   70
+#define MULTI_SHARDS_YBG                   71
+#define MULTI_SHARDS_RYBG                  72
+#define MULTI_TOURNEY_WITH_RECORD          73
+#define MULTI_LINK_SERVICES_A1             74 // TODO: rename
+#define MULTI_LINK_SERVICES_A2             75 //
+#define MULTI_LINK_SERVICES_B1             76 //
+#define MULTI_LINK_SERVICES_B2             77 //
+#define MULTI_LINK_SERVICES_C              78 //
+#define MULTI_LINK_SERVICES_D              79 //
+#define MULTI_WIRELESS_MINIGAME            80
+#define MULTI_LINK_LEADER                  81
+#define MULTI_CONTEST_RANK                 82
+#define MULTI_FRONTIER_ITEM_CHOOSE         83
+#define MULTI_LINK_CONTEST_INFO            84
+#define MULTI_LINK_CONTEST_MODE            85
+#define MULTI_FORCED_START_MENU            86
+#define MULTI_FRONTIER_GAMBLER_BET         87
+#define MULTI_TENT                         88
+#define MULTI_UNUSED_SSTIDAL_1             89 // These 4 were replaced by CreateLilycoveSSTidalMultichoice
+#define MULTI_UNUSED_SSTIDAL_2             90 //
+#define MULTI_UNUSED_SSTIDAL_3             91 //
+#define MULTI_UNUSED_SSTIDAL_4             92 //
+#define MULTI_FOSSIL                       93
+#define MULTI_YESNO                        94
+#define MULTI_FRONTIER_RULES               95
+#define MULTI_BATTLE_ARENA_RULES           96
+#define MULTI_BATTLE_TOWER_RULES           97
+#define MULTI_BATTLE_DOME_RULES            98
+#define MULTI_BATTLE_FACTORY_RULES         99
+#define MULTI_BATTLE_PALACE_RULES          100
+#define MULTI_BATTLE_PYRAMID_RULES         101
+#define MULTI_BATTLE_PIKE_RULES            102
+#define MULTI_GO_ON_RECORD_REST_RETIRE     103
+#define MULTI_GO_ON_REST_RETIRE            104
+#define MULTI_GO_ON_RECORD_RETIRE          105
+#define MULTI_GO_ON_RETIRE                 106
+#define MULTI_TOURNEY_NO_RECORD            107
+#define MULTI_TV_LATI                      108
+#define MULTI_BATTLE_TOWER_FEELINGS        109
+#define MULTI_WHERES_RAYQUAZA              110
+#define MULTI_SLATEPORT_TENT_RULES         111
+#define MULTI_FALLARBOR_TENT_RULES         112
+#define MULTI_TAG_MATCH_TYPE               113
 
 // Lilycove SS Tidal Multichoice Selections
 #define SSTIDAL_SELECTION_SLATEPORT        0
diff --git a/include/script_menu.h b/include/script_menu.h
index 683598bd4..086ad147f 100644
--- a/include/script_menu.h
+++ b/include/script_menu.h
@@ -3,17 +3,17 @@
 
 extern const u8 *const gStdStrings[];
 
-bool8 ScriptMenu_Multichoice(u8 left, u8 top, u8 var3, u8 var4);
-bool8 ScriptMenu_MultichoiceWithDefault(u8 left, u8 top, u8 var3, u8 var4, u8 var5);
-bool8 ScriptMenu_YesNo(u8 var1, u8 var2);
-bool8 ScriptMenu_MultichoiceGrid(u8 left, u8 top, u8 multichoiceId, u8 a4, u8 columnCount);
-bool8 ScriptMenu_ShowPokemonPic(u16 var1, u8 var2, u8 var3);
+bool8 ScriptMenu_Multichoice(u8 left, u8 top, u8 multichoiceId, bool8 ignoreBPress);
+bool8 ScriptMenu_MultichoiceWithDefault(u8 left, u8 top, u8 multichoiceId, bool8 ignoreBPress, u8 defaultChoice);
+bool8 ScriptMenu_YesNo(u8 left, u8 top);
+bool8 ScriptMenu_MultichoiceGrid(u8 left, u8 top, u8 multichoiceId, bool8 ignoreBPress, u8 columnCount);
+bool8 ScriptMenu_ShowPokemonPic(u16 species, u8 x, u8 y);
 bool8 (*ScriptMenu_GetPicboxWaitFunc(void))(void);
-int ConvertPixelWidthToTileWidth(int);
-u8 CreateWindowFromRect(u8, u8, u8, u8);
-void ClearToTransparentAndRemoveWindow(u8);
-int DisplayTextAndGetWidth(const u8*, int);
-int ScriptMenu_AdjustLeftCoordFromWidth(int arg0, int tileWidth);
+int ConvertPixelWidthToTileWidth(int width);
+u8 CreateWindowFromRect(u8 x, u8 y, u8 width, u8 height);
+void ClearToTransparentAndRemoveWindow(u8 windowId);
+int DisplayTextAndGetWidth(const u8* str, int width);
+int ScriptMenu_AdjustLeftCoordFromWidth(int left, int width);
 bool16 ScriptMenu_CreatePCMultichoice(void);
 void ScriptMenu_DisplayPCStartupPrompt(void);