Merge pull request #377 from Viperio19/document-scripts

Document `scripts_pokemon_center_daily_trainers.s`
pret · Feb 16, 2025 · decc172 · decc172
2 parents 62c494d + cd264a7
commit decc172
Show file tree

Hide file tree

Showing 611 changed files with 2,501 additions and 2,448 deletions.
diff --git a/asm/macros/scrcmd.inc b/asm/macros/scrcmd.inc
@@ -1,5 +1,6 @@
 #include "generated/badges.h"
 #include "generated/catching_show_points_category.h"
+#include "generated/days_of_week.h"
 #include "generated/game_records.h"
 #include "generated/items.h"
 #include "generated/journal_location_events.h"
@@ -13,9 +14,14 @@
 #include "generated/species.h"
 #include "generated/trainers.h"
 #include "constants/honey_tree.h"
+#include "constants/savedata/vars_flags.h"
+#include "constants/scrcmd.h"
 
 #include "macros/movement.inc"
 
+    .set FALSE, 0
+    .set TRUE, 1
+
     .macro Noop
     .short 0
     .endm
@@ -349,9 +355,9 @@
     .byte \directionY
     .endm
 
-    .macro ScrCmd_03E arg0
+    .macro ShowYesNoMenu destVarID
     .short 62
-    .short \arg0
+    .short \destVarID
     .endm
 
     .macro ScrCmd_03F
@@ -1307,7 +1313,7 @@
     .short \arg0
     .endm
 
-    .macro ScrCmd_0EB
+    .macro BlackOutFromBattle
     .short 235
     .endm
 
@@ -1321,9 +1327,9 @@
     .short \destVarID
     .endm
 
-    .macro ScrCmd_0EE arg0
+    .macro CheckHasTwoAliveMons destVarID
     .short 238
-    .short \arg0
+    .short \destVarID
     .endm
 
     .macro StartDummyTrainerBattle
@@ -2769,14 +2775,14 @@
     .byte \arg3
     .endm
 
-    .macro ScrCmd_200 arg0
+    .macro GetPreviousMapID destVarID
     .short 512
-    .short \arg0
+    .short \destVarID
     .endm
 
-    .macro ScrCmd_201 arg0
+    .macro GetCurrentMapID destVarID
     .short 513
-    .short \arg0
+    .short \destVarID
     .endm
 
     .macro ScrCmd_202 arg0
@@ -3042,9 +3048,9 @@
     .short \arg1
     .endm
 
-    .macro ScrCmd_234 arg0
+    .macro GetDayOfWeek destVarID
     .short 564
-    .short \arg0
+    .short \destVarID
     .endm
 
     .macro ScrCmd_235 arg0, arg1=0, arg2=0, arg3=0
@@ -4672,3 +4678,7 @@
     .macro ScriptEntry name
     .long \name-.-4
     .endm
+
+    .macro ScriptEntryEnd
+    .short 0xFD13
+    .endm
diff --git a/generated/days_of_week.txt b/generated/days_of_week.txt
@@ -0,0 +1,7 @@
+DAY_OF_WEEK_SUNDAY
+DAY_OF_WEEK_MONDAY
+DAY_OF_WEEK_TUESDAY
+DAY_OF_WEEK_WEDNESDAY
+DAY_OF_WEEK_THURSDAY
+DAY_OF_WEEK_FRIDAY
+DAY_OF_WEEK_SATURDAY
diff --git a/generated/meson.build b/generated/meson.build
@@ -37,6 +37,7 @@ metang_generators = {
     'battle_subscripts': { 'type': 'enum', 'tag': 'BattleSubscript' }, # functionally pre-generating the NARC index
     'battle_terrains': { 'type': 'enum', 'tag': 'BattleTerrain' },
     'catching_show_points_category': { 'type': 'enum', 'tag': 'CatchingShowPointsCategory' },
+    'days_of_week': { 'type': 'enum', 'tag': 'DayOfWeek' },
     'egg_groups': { 'type': 'enum', 'tag': 'EggGroup' },
     'evolution_methods': { 'type': 'enum', 'tag': 'EvolutionMethod' },
     'exp_rates': { 'type': 'enum', 'tag': 'ExpRate' },

diff --git a/generated/text_banks.txt b/generated/text_banks.txt
@@ -201,7 +201,7 @@ TEXT_BANK_UNK_0199
 TEXT_BANK_UNK_0200
 TEXT_BANK_UNK_0201
 TEXT_BANK_NATURE_NAMES
-TEXT_BANK_UNK_0203
+TEXT_BANK_POKEMON_CENTER_DAILY_TRAINERS
 TEXT_BANK_CONTEST_TEXT
 TEXT_BANK_UNK_0205
 TEXT_BANK_UNK_0206

diff --git a/generated/trainer_classes.txt b/generated/trainer_classes.txt
@@ -82,7 +82,7 @@ TRAINER_CLASS_PARASOL_LADY
 TRAINER_CLASS_WAITER
 TRAINER_CLASS_INTERVIEWERS
 TRAINER_CLASS_CAMERAMAN
-TRAINER_CLASS_REPORTERS
+TRAINER_CLASS_REPORTER
 TRAINER_CLASS_IDOL
 TRAINER_CLASS_GALACTIC_BOSS
 TRAINER_CLASS_COMMANDER_JUPITER

diff --git a/generated/trainers.txt b/generated/trainers.txt
@@ -366,10 +366,10 @@ TRAINER_UNKNOWN_364
 TRAINER_UNKNOWN_365
 TRAINER_WAITRESS_KATI
 TRAINER_WORKER_GERARDO
-TRAINER_UNKNOWN_368
-TRAINER_UNKNOWN_369
-TRAINER_UNKNOWN_370
-TRAINER_UNKNOWN_371
+TRAINER_INTERVIEWERS_ROXY_AND_OLI_UNUSED
+TRAINER_CAMERAMAN_TEVIN_UNUSED
+TRAINER_REPORTER_KINSEY_UNUSED
+TRAINER_IDOL_GRACE_UNUSED
 TRAINER_BATTLE_GIRL_TYLER
 TRAINER_BIRD_KEEPER_AUTUMN
 TRAINER_UNKNOWN_374
@@ -429,7 +429,7 @@ TRAINER_GALACTIC_GRUNT_LAKE_VERITY_4
 TRAINER_GALACTIC_GRUNT_GALACTIC_HQ_1F
 TRAINER_UNKNOWN_429
 TRAINER_GALACTIC_GRUNT_GALACTIC_HQ_2F_3
-TRAINER_UNKNOWN_431
+TRAINER_GUITARIST_ARTURO_UNUSED
 TRAINER_UNKNOWN_432
 TRAINER_UNKNOWN_433
 TRAINER_UNKNOWN_434
@@ -458,12 +458,12 @@ TRAINER_PICNICKER_KARINA
 TRAINER_PICNICKER_SUMMER
 TRAINER_PICNICKER_TORI
 TRAINER_PICNICKER_ANA
-TRAINER_UNKNOWN_460
+TRAINER_CLOWN_LEE_UNUSED
 TRAINER_UNKNOWN_461
 TRAINER_UNKNOWN_462
 TRAINER_UNKNOWN_463
 TRAINER_UNKNOWN_464
-TRAINER_UNKNOWN_465
+TRAINER_POKE_KID_ARIEL_UNUSED
 TRAINER_UNKNOWN_466
 TRAINER_UNKNOWN_467
 TRAINER_UNKNOWN_468
@@ -545,7 +545,7 @@ TRAINER_SOCIALITE_REBECCA
 TRAINER_LASS_BLYTHE
 TRAINER_RICH_BOY_ROMAN
 TRAINER_LADY_KYLIE
-TRAINER_REPORTERS_VALERIE
+TRAINER_REPORTER_VALERIE
 TRAINER_SCHOOL_KID_ESTEBAN
 TRAINER_SCIENTIST_EMILIO
 TRAINER_BEAUTY_GABRIELLA
@@ -892,9 +892,9 @@ TRAINER_POKE_KID_ARIEL_REMATCH_1
 TRAINER_POKE_KID_ARIEL_REMATCH_2
 TRAINER_RICH_BOY_LIAM
 TRAINER_LADY_CELESTE
-TRAINER_REPORTERS_KINSEY
-TRAINER_REPORTERS_KINSEY_REMATCH_1
-TRAINER_REPORTERS_KINSEY_REMATCH_2
+TRAINER_REPORTER_KINSEY
+TRAINER_REPORTER_KINSEY_REMATCH_1
+TRAINER_REPORTER_KINSEY_REMATCH_2
 TRAINER_MAID_BELINDA
 TRAINER_MAID_SOPHIE
 TRAINER_MAID_EMILY
@@ -910,15 +910,15 @@ TRAINER_IDOL_GRACE_REMATCH_3
 TRAINER_INTERVIEWERS_ROXY_AND_OLI_REMATCH_3
 TRAINER_CLOWN_LEE_REMATCH_3
 TRAINER_POKE_KID_ARIEL_REMATCH_3
-TRAINER_REPORTERS_KINSEY_REMATCH_3
+TRAINER_REPORTER_KINSEY_REMATCH_3
 TRAINER_GALACTIC_BOSS_CYRUS_CELESTIC_TOWN_RUINS
 TRAINER_CAMERAMAN_TEVIN_REMATCH_4
 TRAINER_GUITARIST_ARTURO_REMATCH_4
 TRAINER_IDOL_GRACE_REMATCH_4
 TRAINER_INTERVIEWERS_ROXY_AND_OLI_REMATCH_4
 TRAINER_CLOWN_LEE_REMATCH_4
 TRAINER_POKE_KID_ARIEL_REMATCH_4
-TRAINER_REPORTERS_KINSEY_REMATCH_4
+TRAINER_REPORTER_KINSEY_REMATCH_4
 TRAINER_LEADER_VOLKNER_FIGHT_AREA
 TRAINER_ELITE_FOUR_FLINT_FIGHT_AREA
 TRAINER_RIVAL_FIGHT_AREA_PIPLUP

diff --git a/include/constants/savedata/vars_flags.h b/include/constants/savedata/vars_flags.h
@@ -73,4 +73,12 @@
 
 #define SYSTEM_FLAGS_FIRST_ARRIVAL_TO_ZONE (SYSTEM_FLAGS_GIRATINA_ANIM_START + GIRATINA_SHADOW_ANIM_MAX)
 
+#define FLAG_DEFEATED_IDOL_GRACE                0x0ABC
+#define FLAG_DEFEATED_REPORTER_KINSEY           0x0ABD
+#define FLAG_DEFEATED_CAMERAMAN_TEVIN           0x0ABE
+#define FLAG_DEFEATED_CLOWN_LEE                 0x0ABF
+#define FLAG_DEFEATED_INTERVIEWERS_ROXY_AND_OLI 0x0AC0
+#define FLAG_DEFEATED_POKE_KID_ARIEL            0x0AC1
+#define FLAG_DEFEATED_GUITARIST_ARTURO          0x0AC2
+
 #endif // POKEPLATINUM_CONSTANTS_VARS_AND_FLAGS_H
diff --git a/include/constants/scrcmd.h b/include/constants/scrcmd.h
@@ -0,0 +1,7 @@
+#ifndef POKEPLATINUM_CONSTANTS_SCRCMD_H
+#define POKEPLATINUM_CONSTANTS_SCRCMD_H
+
+#define MENU_YES 0
+#define MENU_NO  1
+
+#endif // POKEPLATINUM_CONSTANTS_SCRCMD_H
diff --git a/include/constants/trainer.h b/include/constants/trainer.h
@@ -90,7 +90,7 @@ enum TrainerClass {
     TRAINER_CLASS_WAITER,
     TRAINER_CLASS_INTERVIEWERS,
     TRAINER_CLASS_CAMERAMAN,
-    TRAINER_CLASS_REPORTERS,
+    TRAINER_CLASS_REPORTER,
     TRAINER_CLASS_IDOL,
     TRAINER_CLASS_GALACTIC_BOSS,
     TRAINER_CLASS_COMMANDER_JUPITER,

diff --git a/include/data/trainer_class_genders.h b/include/data/trainer_class_genders.h
@@ -87,7 +87,7 @@ static const u8 sTrainerClassGender[] = {
     [TRAINER_CLASS_WAITER]                  = GENDER_MALE,
     [TRAINER_CLASS_INTERVIEWERS]            = GENDER_NONE,
     [TRAINER_CLASS_CAMERAMAN]               = GENDER_MALE,
-    [TRAINER_CLASS_REPORTERS]               = GENDER_FEMALE,
+    [TRAINER_CLASS_REPORTER]                = GENDER_FEMALE,
     [TRAINER_CLASS_IDOL]                    = GENDER_FEMALE,
     [TRAINER_CLASS_GALACTIC_BOSS]           = GENDER_MALE,
     [TRAINER_CLASS_COMMANDER_JUPITER]       = GENDER_FEMALE,

diff --git a/include/data/trainer_class_prize_mul.h b/include/data/trainer_class_prize_mul.h
@@ -86,7 +86,7 @@ static u8 sTrainerClassPrizeMul[] = {
     [TRAINER_CLASS_WAITER]                  = 8,
     [TRAINER_CLASS_INTERVIEWERS]            = 18,
     [TRAINER_CLASS_CAMERAMAN]               = 8,
-    [TRAINER_CLASS_REPORTERS]               = 10,
+    [TRAINER_CLASS_REPORTER]                = 10,
     [TRAINER_CLASS_IDOL]                    = 18,
     [TRAINER_CLASS_GALACTIC_BOSS]           = 45,
     [TRAINER_CLASS_COMMANDER_JUPITER]       = 20,

diff --git a/include/script_manager.h b/include/script_manager.h
@@ -83,10 +83,11 @@ enum ScriptContextType {
     NUM_SCRIPT_CONTEXTS
 };
 
-#define SCRIPT_ID_OFFSET_SINGLE_BATTLES 3000
-#define SCRIPT_ID_OFFSET_DOUBLE_BATTLES 5000
-#define SCRIPT_ID_OFFSET_HIDDEN_ITEMS   8000
-#define SCRIPT_ID_OFFSET_SAFARI_ZONE    8800
+#define SCRIPT_ID_OFFSET_SINGLE_BATTLES         3000
+#define SCRIPT_ID_OFFSET_DOUBLE_BATTLES         5000
+#define SCRIPT_ID_OFFSET_HIDDEN_ITEMS           8000
+#define SCRIPT_ID_OFFSET_SAFARI_ZONE            8800
+#define SCRIPT_ID_POKEMON_CENTER_DAILY_TRAINERS 10400
 
 #define FLAG_OFFSET_HIDDEN_ITEMS     730
 #define FLAG_OFFSET_TRAINER_DEFEATED 1360

diff --git a/include/unk_02048614.h b/include/unk_02048614.h
@@ -14,11 +14,11 @@ BOOL ScrCmd_0E7(ScriptContext *param0);
 BOOL ScrCmd_0E8(ScriptContext *param0);
 BOOL ScrCmd_0E9(ScriptContext *param0);
 BOOL ScrCmd_0EA(ScriptContext *param0);
-BOOL ScrCmd_0EB(ScriptContext *param0);
+BOOL ScrCmd_BlackOutFromBattle(ScriptContext *param0);
 BOOL ScrCmd_CheckWonBattle(ScriptContext *ctx);
 BOOL ScrCmd_CheckLostBattle(ScriptContext *ctx);
 BOOL ScrCmd_CheckDidNotCapture(ScriptContext *ctx);
-BOOL ScrCmd_0EE(ScriptContext *param0);
+BOOL ScrCmd_CheckHasTwoAliveMons(ScriptContext *param0);
 BOOL ScrCmd_StartDummyTrainerBattle(ScriptContext *ctx);
 BOOL ScrCmd_0F0(ScriptContext *param0);
 BOOL ScrCmd_0F1(ScriptContext *param0);

diff --git a/res/field/scripts/meson.build b/res/field/scripts/meson.build
@@ -405,7 +405,7 @@ scr_seq_files = files(
     'scripts_unk_0397.s',
     'scripts_communication_club_colosseum_2p.s',
     'scripts_communication_club_colosseum_4p.s',
-    'scripts_unk_0400.s',
+    'scripts_pokemon_center_daily_trainers.s',
     'scripts_empty.s',
     'scripts_unk_0402.s',
     'scripts_unk_0403.s',

diff --git a/res/field/scripts/scripts.order b/res/field/scripts/scripts.order
@@ -398,7 +398,7 @@ scripts_rock_peak_ruins
 scripts_unk_0397
 scripts_communication_club_colosseum_2p
 scripts_communication_club_colosseum_4p
-scripts_unk_0400
+scripts_pokemon_center_daily_trainers
 scripts_empty
 scripts_unk_0402
 scripts_unk_0403

diff --git a/res/field/scripts/scripts_acuity_cavern.s b/res/field/scripts/scripts_acuity_cavern.s
@@ -6,7 +6,7 @@
     ScriptEntry _000E
     ScriptEntry _0014
     ScriptEntry _002F
-    .short 0xFD13
+    ScriptEntryEnd
 
 _000E:
     SetFlag 0x9E3
@@ -48,7 +48,7 @@ _007A:
     End
 
 _0085:
-    ScrCmd_0EB
+    BlackOutFromBattle
     ReleaseAll
     End
 

diff --git a/res/field/scripts/scripts_acuity_lakefront.s b/res/field/scripts/scripts_acuity_lakefront.s
@@ -7,7 +7,7 @@
     ScriptEntry _0012
     ScriptEntry _0083
     ScriptEntry _009A
-    .short 0xFD13
+    ScriptEntryEnd
 
 _0012:
     GoToIfUnset 186, _002A

diff --git a/res/field/scripts/scripts_amity_square.s b/res/field/scripts/scripts_amity_square.s
@@ -48,7 +48,7 @@
     ScriptEntry _12E9
     ScriptEntry _12F7
     ScriptEntry _174A
-    .short 0xFD13
+    ScriptEntryEnd
 
 _00B6:
     SetFlag 0x9CC
@@ -146,15 +146,15 @@ _01CE:
 _0229:
     AddVar 0x400C, 1
     Message 2
-    ScrCmd_03E 0x800C
+    ShowYesNoMenu 0x800C
     GoToIfEq 0x800C, 0, _0299
     GoTo _026D
     End
 
 _024B:
     AddVar 0x400C, 1
     Message 4
-    ScrCmd_03E 0x800C
+    ShowYesNoMenu 0x800C
     GoToIfEq 0x800C, 0, _0299
     GoTo _026D
     End
@@ -1010,7 +1010,7 @@ _10AA:
 _10E1:
     BufferItemName 0, 0x8004
     Message 37
-    ScrCmd_03E 0x800C
+    ShowYesNoMenu 0x800C
     GoToIfEq 0x800C, 1, _1161
     SetVar 0x8005, 5
     ScrCmd_07D 0x8004, 0x8005, 0x800C
@@ -1027,7 +1027,7 @@ _10E1:
 _1136:
     ScrCmd_261 0, 0x8004
     Message 37
-    ScrCmd_03E 0x800C
+    ShowYesNoMenu 0x800C
     GoToIfEq 0x800C, 1, _1161
     SetVar 0x8005, 1
     CallCommonScript 0x7DF