Document scripts for pokedex ratings (#763)

Author: metallicity

asm/macros/scrcmd.inc

@@ -1710,10 +1710,18 @@
     .short 290
     .endm
 
-    .macro ScrCmd_123 arg0, arg1
+    .macro LoadPokedexRating hasNationalDex, destVar
     .short 291
-    .byte \arg0
-    .short \arg1
+    .byte \hasNationalDex
+    .short \destVar
+    .endm
+
+    .macro LoadLocalDexRating destVar
+    LoadPokedexRating FALSE, \destVar
+    .endm
+
+    .macro LoadNationalDexRating destVar
+    LoadPokedexRating TRUE, \destVar
     .endm
 
     .macro StartWildBattle species, level

generated/text_banks.txt

@@ -381,7 +381,7 @@ TEXT_BANK_MYSTERY_GIFT_DELIVERYMAN
 TEXT_BANK_UNK_0380
 TEXT_BANK_FIELD_MOVES
 TEXT_BANK_WIFI_PLAZA_ENTRANCE
-TEXT_BANK_UNK_0383
+TEXT_BANK_POKEDEX_RATINGS
 TEXT_BANK_UNK_0384
 TEXT_BANK_UNK_0385
 TEXT_BANK_CONTEST_ACCESSORY_NAMES

generated/vars_flags.txt

@@ -270,7 +270,7 @@ FLAG_UNK_0x010C
 FLAG_UNK_0x010D
 FLAG_UNK_0x010E
 FLAG_UNK_0x010F
-FLAG_UNK_0x0110
+FLAG_SHOWN_COMPLETE_LOCAL_DEX
 FLAG_UNK_0x0111
 FLAG_UNK_0x0112
 FLAG_UNK_0x0113
@@ -2490,7 +2490,7 @@ FLAG_UNK_0x09B6
 FLAG_UNK_0x09B7
 FLAG_UNK_0x09B8
 FLAG_UNK_0x09B9
-FLAG_UNK_0x09BA
+FLAG_FIRST_ARRIVAL_ETERNA_CITY
 FLAG_UNK_0x09BB
 FLAG_UNK_0x09BC
 FLAG_UNK_0x09BD
@@ -4130,7 +4130,8 @@ VAR_MAP_LOCAL_1C
 VAR_MAP_LOCAL_1D
 VAR_MAP_LOCAL_1E
 VAR_MAP_LOCAL_1F
-VAR_OBJ_GFX_ID_0
+OBJ_GFX_VARS_START
+VAR_OBJ_GFX_ID_0 = OBJ_GFX_VARS_START
 VAR_OBJ_GFX_ID_1
 VAR_OBJ_GFX_ID_2
 VAR_OBJ_GFX_ID_3

include/script_manager.h

@@ -93,6 +93,7 @@ enum ScriptContextType {
 #define SCRIPT_ID_OFFSET_SAFARI_GAME            8800
 #define SCRIPT_ID_OFFSET_INIT_NEW_GAME          9600
 #define SCRIPT_ID_OFFSET_FOLLOWER_PARTNERS      9700
+#define SCRIPT_ID_OFFSET_POKEDEX_RATINGS        9950
 #define SCRIPT_ID_OFFSET_FIELD_MOVES            10000
 #define SCRIPT_ID_OFFSET_TV_BROADCAST           10100
 #define SCRIPT_ID_OFFSET_TV_REPORTER_INTERVIEWS 10150

include/unk_0205DFC4.h

@@ -8,8 +8,8 @@
 
 u16 GetNumberDigitCount(u32 number);
 u16 Item_IsTMHM(u16 item);
-u16 sub_0205E078(u16 param0, u16 param1);
-u16 sub_0205E0E4(u16 param0, u16 param1);
+u16 Pokedex_GetRatingMessageID_Local(u16 pokemonSeen, u16 reachedEternaCity);
+u16 Pokedex_GetRatingMessageID_National(u16 pokemonCaught, u16 playerGender);
 u16 SaveData_GetFirstNonEggInParty(SaveData *saveData);
 BOOL HasAllLegendaryTitansInParty(SaveData *saveData);
 void sub_0205E318(FieldTask *param0, MapObject *param1, u16 param2, u16 param3, u16 param4, u16 param5);

res/field/scripts/meson.build

@@ -416,7 +416,7 @@ scr_seq_files = files(
     'scripts_unk_0408.s',
     'scripts_field_moves.s',
     'scripts_wifi_plaza_entrance.s',
-    'scripts_unk_0411.s',
+    'scripts_pokedex_ratings.s',
     'scripts_init_new_game.s',
     'scripts_berry_tree_interaction.s',
     'scripts_verity_lakefront.s',

res/field/scripts/scripts.order

@@ -409,7 +409,7 @@ scripts_unk_0407
 scripts_unk_0408
 scripts_field_moves
 scripts_wifi_plaza_entrance
-scripts_unk_0411
+scripts_pokedex_ratings
 scripts_init_new_game
 scripts_berry_tree_interaction
 scripts_verity_lakefront

res/field/scripts/scripts_pokedex_ratings.s

@@ -0,0 +1,115 @@
+#include "macros/scrcmd.inc"
+#include "res/text/bank/pokedex_ratings.h"
+
+
+    ScriptEntry PokedexRatings_CheckRowan @ 0x26DE
+    ScriptEntry PokedexRatings_CheckPC @ 0x26DF
+    ScriptEntry PokedexRatings_CheckOak @ 0x26E0
+    ScriptEntry PokedexRatings_CheckNationalDex @ 0x26E1
+    ScriptEntryEnd
+
+PokedexRatings_CheckRowan:
+    BufferPlayerName 0
+    Message PokedexRatings_Text_RowanShowMeYourPokedex
+    ShowYesNoMenu VAR_RESULT
+    GoToIfEq VAR_RESULT, MENU_NO, PokedexRatings_CheckRowanDecline
+    GoTo PokedexRatings_CheckRowanAccept
+    End
+
+PokedexRatings_CheckRowanDecline:
+    Message PokedexRatings_Text_RowanAfraidToShowMe
+    WaitABXPadPress
+    CloseMessage
+    ReleaseAll
+    ReturnCommonScript
+    End
+
+PokedexRatings_CheckRowanAccept:
+    Call PokedexRatings_RateLocalDex
+    CloseMessage
+    ReleaseAll
+    ReturnCommonScript
+    End
+
+PokedexRatings_CheckOak:
+    BufferPlayerName 0
+    GetPlayerGender VAR_RESULT
+    CallIfEq VAR_RESULT, GENDER_MALE, PokedexRatings_OakPromptMessageMale
+    CallIfEq VAR_RESULT, GENDER_FEMALE, PokedexRatings_OakPromptMessageFemale
+    ShowYesNoMenu VAR_RESULT
+    GoToIfEq VAR_RESULT, MENU_NO, PokedexRatings_CheckOakDecline
+    GoTo PokedexRatings_CheckNationalDex
+    End
+
+PokedexRatings_OakPromptMessageMale:
+    Message PokedexRatings_Text_OakShowMeYourPokedex_Male
+    Return
+
+PokedexRatings_OakPromptMessageFemale:
+    Message PokedexRatings_Text_OakShowMeYourPokedex_Female
+    Return
+
+PokedexRatings_CheckOakDecline:
+    Message PokedexRatings_Text_OakComeSeeMe
+    WaitABXPadPress
+    CloseMessage
+    ReleaseAll
+    ReturnCommonScript
+    End
+
+PokedexRatings_CheckNationalDex:
+    Call PokedexRatings_RateNationalDex
+    CloseMessage
+    ReleaseAll
+    ReturnCommonScript
+    End
+
+PokedexRatings_CheckPC:
+    Call PokedexRatings_CheckPCNationalOrLocal
+    ReturnCommonScript
+    End
+
+PokedexRatings_CheckPCNationalOrLocal:
+    GetNationalDexEnabled VAR_RESULT
+    GoToIfEq VAR_RESULT, FALSE, PokedexRatings_CheckPCLocalDex
+    GoToIfEq VAR_RESULT, TRUE, PokedexRatings_CheckPCNationalDex
+    End
+
+PokedexRatings_CheckPCLocalDex:
+    Message PokedexRatings_Text_AccessedProfessorRowansPC
+    GoTo PokedexRatings_RateLocalDex
+
+PokedexRatings_CheckPCNationalDex:
+    Message PokedexRatings_Text_AccessedProfessorOaksPC
+    GoTo PokedexRatings_RateNationalDex
+
+PokedexRatings_RateLocalDex:
+    GoToIfUnset FLAG_FIRST_ARRIVAL_ETERNA_CITY, PokedexRatings_JustRateLocalDex
+    CheckLocalDexCompleted VAR_RESULT
+    CallIfEq VAR_RESULT, TRUE, PokedexRatings_LocalDexCompleted
+PokedexRatings_JustRateLocalDex:
+    GetLocalDexSeenCount VAR_0x8004
+    BufferNumber 0, VAR_0x8004
+    Message PokedexRatings_Text_PokemonSpottedInSinnoh
+    LoadLocalDexRating VAR_RESULT
+    BufferPlayerName 0
+    MessageVar VAR_RESULT
+    WaitABPress
+    Return
+
+PokedexRatings_LocalDexCompleted:
+    SetFlag FLAG_SHOWN_COMPLETE_LOCAL_DEX
+    Return
+
+PokedexRatings_RateNationalDex:
+    GetNationalDexCaughtCount VAR_0x8004
+    GetPlayerGender VAR_0x8005
+    BufferNumber 0, VAR_0x8004
+    Message PokedexRatings_Text_PokemonCaughtSoFar
+    LoadNationalDexRating VAR_RESULT
+    BufferPlayerName 0
+    MessageVar VAR_RESULT
+    WaitABPress
+    Return
+
+    .balign 4, 0

res/field/scripts/scripts_sandgem_town_pokemon_research_lab.s

@@ -51,7 +51,7 @@ _00AF:
 _00B7:
     GetNationalDexEnabled VAR_RESULT
     GoToIfEq VAR_RESULT, 1, _07AE
-    GoToIfUnset FLAG_UNK_0x09BA, _00E5
+    GoToIfUnset FLAG_FIRST_ARRIVAL_ETERNA_CITY, _00E5
     CheckLocalDexCompleted VAR_RESULT
     GoToIfEq VAR_RESULT, 1, _060E
 _00E5:
@@ -508,7 +508,7 @@ _05FD:
     End
 
 _060E:
-    GoToIfSet FLAG_UNK_0x0110, _0621
+    GoToIfSet FLAG_SHOWN_COMPLETE_LOCAL_DEX, _0621
     GoTo _0631
     End