From 8e1537fb57dc7ed17079b30f7a3851132cf462bd Mon Sep 17 00:00:00 2001 From: Phlosioneer Date: Sun, 10 Mar 2019 08:10:59 -0400 Subject: [PATCH] Document map name popup flag --- data/event_scripts.s | 4 ++-- data/maps/InsideOfTruck/scripts.inc | 2 +- data/maps/LavaridgeTown/scripts.inc | 4 ++-- data/maps/LittlerootTown/scripts.inc | 6 +++--- data/maps/PetalburgCity/scripts.inc | 8 ++++---- data/maps/Route101/scripts.inc | 4 ++-- data/maps/Route128/scripts.inc | 2 +- data/maps/RustboroCity/scripts.inc | 4 ++-- data/maps/SeafloorCavern_Room9/scripts.inc | 2 +- data/maps/SkyPillar_Outside/scripts.inc | 4 ++-- data/maps/SlateportCity/scripts.inc | 4 ++-- data/maps/SootopolisCity/scripts.inc | 10 +++++----- include/constants/flags.h | 2 +- src/field_special_scene.c | 4 ++-- src/map_name_popup.c | 2 +- 15 files changed, 31 insertions(+), 31 deletions(-) diff --git a/data/event_scripts.s b/data/event_scripts.s index 1175c8d00..67351d184 100644 --- a/data/event_scripts.s +++ b/data/event_scripts.s @@ -3161,7 +3161,7 @@ Route118_EventScript_273D13:: @ 8273D13 Route125_EventScript_273D13:: @ 8273D13 Route127_EventScript_273D13:: @ 8273D13 Route129_EventScript_273D13:: @ 8273D13 - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP return UnusualWeather_StartKyogreWeather:: @ 8273D17 @@ -3188,7 +3188,7 @@ UnusualWeather_EventScript_EndEventAndCleanup_2:: @ 8273D31 special DrawWholeMapView setvar VAR_UNUSUAL_WEATHER_LOCATION, UNUSUAL_WEATHER_NONE setvar VAR_SHOULD_END_UNUSUAL_WEATHER, 0 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP fadescreenswapbuffers 0 releaseall end diff --git a/data/maps/InsideOfTruck/scripts.inc b/data/maps/InsideOfTruck/scripts.inc index 672b2003b..0f7f5447d 100644 --- a/data/maps/InsideOfTruck/scripts.inc +++ b/data/maps/InsideOfTruck/scripts.inc @@ -15,7 +15,7 @@ InsideOfTruck_MapScript1_23BF01: @ 823BF01 InsideOfTruck_EventScript_23BF04:: @ 823BF04 lockall - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP checkplayergender compare VAR_RESULT, MALE goto_if_eq InsideOfTruck_EventScript_23BF20 diff --git a/data/maps/LavaridgeTown/scripts.inc b/data/maps/LavaridgeTown/scripts.inc index 5c1612199..acbb3fcd2 100644 --- a/data/maps/LavaridgeTown/scripts.inc +++ b/data/maps/LavaridgeTown/scripts.inc @@ -37,7 +37,7 @@ LavaridgeTown_EventScript_1EA53F:: @ 81EA53F return LavaridgeTown_EventScript_1EA543:: @ 81EA543 - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP return LavaridgeTown_MapScript2_1EA547: @ 81EA547 @@ -95,7 +95,7 @@ LavaridgeTown_EventScript_1EA5FF:: @ 81EA5FF call_if_ne LavaridgeTown_EventScript_1EA6C9 removeobject 7 setvar VAR_LAVARIDGE_RIVAL_STATE, 2 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP savebgm MUS_DUMMY fadedefaultbgm releaseall diff --git a/data/maps/LittlerootTown/scripts.inc b/data/maps/LittlerootTown/scripts.inc index e133169ba..f347811f8 100644 --- a/data/maps/LittlerootTown/scripts.inc +++ b/data/maps/LittlerootTown/scripts.inc @@ -31,7 +31,7 @@ LittlerootTown_EventScript_1E7E45:: @ 81E7E45 return LittlerootTown_EventScript_1E7E4B:: @ 81E7E4B - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP return LittlerootTown_EventScript_1E7E4F:: @ 81E7E4F @@ -141,7 +141,7 @@ LittlerootTown_EventScript_1E7F17:: @ 81E7F17 closedoor VAR_0x8004, VAR_0x8005 waitdooranim clearflag FLAG_HIDE_LITTLEROOT_TOWN_FAT_MAN - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP return LittlerootTown_Movement_1E7F98: @ 81E7F98 @@ -194,7 +194,7 @@ LittlerootTown_EventScript_1E7FB1:: @ 81E7FB1 clearflag FLAG_HIDE_LITTLEROOT_TOWN_RIVAL clearflag FLAG_HIDE_LITTLEROOT_TOWN_BIRCH delay 20 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP warp MAP_LITTLEROOT_TOWN_PROFESSOR_BIRCHS_LAB, 255, 6, 5 waitstate releaseall diff --git a/data/maps/PetalburgCity/scripts.inc b/data/maps/PetalburgCity/scripts.inc index 5a652ab15..c8b723383 100644 --- a/data/maps/PetalburgCity/scripts.inc +++ b/data/maps/PetalburgCity/scripts.inc @@ -20,7 +20,7 @@ PetalburgCity_EventScript_1DC307:: @ 81DC307 return PetalburgCity_EventScript_1DC30F:: @ 81DC30F - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP savebgm MUS_TSURETEK return @@ -48,7 +48,7 @@ PetalburgCity_EventScript_1DC32E:: @ 81DC32E waitmovement 2, MAP_PETALBURG_CITY msgbox PetalburgCity_Text_1EC297, MSGBOX_DEFAULT closemessage - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP setvar VAR_PETALBURG_STATE, 3 fadedefaultbgm clearflag FLAG_SPECIAL_FLAG_0x4001 @@ -61,7 +61,7 @@ PetalburgCity_EventScript_1DC32E:: @ 81DC32E PetalburgCity_EventScript_1DC390:: @ 81DC390 lockall - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP applymovement 5, PetalburgCity_Movement_1DC41B applymovement EVENT_OBJ_ID_PLAYER, PetalburgCity_Movement_1DC406 waitmovement 0 @@ -76,7 +76,7 @@ PetalburgCity_EventScript_1DC390:: @ 81DC390 hideobjectat EVENT_OBJ_ID_PLAYER, MAP_PETALBURG_CITY closedoor VAR_0x8004, VAR_0x8005 waitdooranim - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP fadedefaultbgm clearflag FLAG_SPECIAL_FLAG_0x4001 warp MAP_PETALBURG_CITY_WALLYS_HOUSE, 255, 2, 4 diff --git a/data/maps/Route101/scripts.inc b/data/maps/Route101/scripts.inc index aa20ba2da..47663e1dd 100644 --- a/data/maps/Route101/scripts.inc +++ b/data/maps/Route101/scripts.inc @@ -12,7 +12,7 @@ Route101_MapScript2_1EBCCB: @ 81EBCCB .2byte 0 Route101_EventScript_1EBCD5:: @ 81EBCD5 - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP setvar VAR_ROUTE101_STATE, 1 end @@ -236,7 +236,7 @@ Route101_EventScript_1EBE16:: @ 81EBE16 setflag FLAG_HIDE_ROUTE_101_BIRCH_STARTERS_BAG setvar VAR_BIRCH_LAB_STATE, 2 setvar VAR_ROUTE101_STATE, 3 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP checkplayergender compare VAR_RESULT, MALE call_if_eq Route101_EventScript_1EBE85 diff --git a/data/maps/Route128/scripts.inc b/data/maps/Route128/scripts.inc index 647d62b6a..84091ac3a 100644 --- a/data/maps/Route128/scripts.inc +++ b/data/maps/Route128/scripts.inc @@ -73,7 +73,7 @@ Route128_EventScript_1F6B57:: @ 81F6B57 delay 15 removeobject 3 waitfieldeffect 30 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP setvar VAR_ROUTE128_STATE, 2 releaseall end diff --git a/data/maps/RustboroCity/scripts.inc b/data/maps/RustboroCity/scripts.inc index f93711344..1ba63c959 100644 --- a/data/maps/RustboroCity/scripts.inc +++ b/data/maps/RustboroCity/scripts.inc @@ -24,7 +24,7 @@ RustboroCity_EventScript_1E06FF:: @ 81E06FF end RustboroCity_EventScript_1E0707:: @ 81E0707 - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP return RustboroCity_MapScript2_1E070B: @ 81E070B @@ -100,7 +100,7 @@ RustboroCity_EventScript_1E07BD:: @ 81E07BD removeobject 15 setflag FLAG_HIDE_RUSTBORO_CITY_SCIENTIST setvar VAR_RUSTBORO_STATE, 7 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP releaseall end diff --git a/data/maps/SeafloorCavern_Room9/scripts.inc b/data/maps/SeafloorCavern_Room9/scripts.inc index 38a10a004..4c630a1d4 100644 --- a/data/maps/SeafloorCavern_Room9/scripts.inc +++ b/data/maps/SeafloorCavern_Room9/scripts.inc @@ -140,7 +140,7 @@ SeafloorCavern_Room9_EventScript_234DC9:: @ 8234DC9 setflag FLAG_HIDE_SEAFLOOR_CAVERN_ROOM_9_MAGMA_GRUNTS setflag FLAG_HIDE_SEAFLOOR_CAVERN_ROOM_9_KYOGRE_1 setflag FLAG_HIDE_SEAFLOOR_CAVERN_AQUA_GRUNTS - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP warp MAP_ROUTE128, 255, 38, 22 waitstate releaseall diff --git a/data/maps/SkyPillar_Outside/scripts.inc b/data/maps/SkyPillar_Outside/scripts.inc index 93d4e42c3..c4769c990 100644 --- a/data/maps/SkyPillar_Outside/scripts.inc +++ b/data/maps/SkyPillar_Outside/scripts.inc @@ -12,7 +12,7 @@ SkyPillar_Outside_MapScript1_2392B8: @ 82392B8 end SkyPillar_Outside_EventScript_2392CF:: @ 82392CF - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP return SkyPillar_Outside_EventScript_2392D3:: @ 82392D3 @@ -81,7 +81,7 @@ SkyPillar_Outside_EventScript_239304:: @ 8239304 closemessage playse SE_KAIDAN fadescreenswapbuffers 1 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP setvar VAR_RAYQUAZA_STATE, 4 removeobject 1 clearflag FLAG_HIDE_SOOTOPOLIS_CITY_WALLACE diff --git a/data/maps/SlateportCity/scripts.inc b/data/maps/SlateportCity/scripts.inc index acf66d2bd..1830c3f00 100644 --- a/data/maps/SlateportCity/scripts.inc +++ b/data/maps/SlateportCity/scripts.inc @@ -36,7 +36,7 @@ SlateportCity_EventScript_1DCC99:: @ 81DCC99 return SlateportCity_EventScript_1DCCE7:: @ 81DCCE7 - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP getplayerxy VAR_0x8004, VAR_0x8005 compare VAR_0x8004, 30 goto_if_eq SlateportCity_EventScript_1DCD06 @@ -83,7 +83,7 @@ SlateportCity_EventScript_1DCD1C:: @ 81DCD1C removeobject 35 setobjectxyperm 35, 10, 12 setobjectmovementtype 35, MOVEMENT_TYPE_FACE_DOWN - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP setvar VAR_SLATEPORT_OUTSIDE_MUSEUM_STATE, 2 addvar VAR_SCOTT_STATE, 1 releaseall diff --git a/data/maps/SootopolisCity/scripts.inc b/data/maps/SootopolisCity/scripts.inc index dbfe923f0..ad72120f9 100644 --- a/data/maps/SootopolisCity/scripts.inc +++ b/data/maps/SootopolisCity/scripts.inc @@ -62,7 +62,7 @@ SootopolisCity_MapScript1_1E56EF: @ 81E56EF end SootopolisCity_EventScript_1E5781:: @ 81E5781 - setflag FLAG_SPECIAL_FLAG_0x4000 + setflag FLAG_HIDE_MAP_NAME_POPUP return SootopolisCity_EventScript_1E5785:: @ 81E5785 @@ -272,7 +272,7 @@ SootopolisCity_EventScript_1E5946:: @ 81E5946 waitmovement 0 special RemoveCameraObject setvar VAR_RAYQUAZA_STATE, 2 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP releaseall end @@ -372,7 +372,7 @@ SootopolisCity_EventScript_1E5A82:: @ 81E5A82 waitmovement 0 special RemoveCameraObject setvar VAR_RAYQUAZA_STATE, 2 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP releaseall end @@ -544,7 +544,7 @@ SootopolisCity_EventScript_1E5C1E:: @ 81E5C1E clearflag FLAG_LEGENDARIES_IN_SOOTOPOLIS fadenewbgm MUS_RUNECITY delay 120 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP warp8 MAP_SOOTOPOLIS_CITY, 255, 43, 32 waitstate end @@ -597,7 +597,7 @@ SootopolisCity_EventScript_1E5CCE:: @ 81E5CCE clearflag FLAG_LEGENDARIES_IN_SOOTOPOLIS fadenewbgm MUS_NAMINORI delay 120 - clearflag FLAG_SPECIAL_FLAG_0x4000 + clearflag FLAG_HIDE_MAP_NAME_POPUP warp8 MAP_SOOTOPOLIS_CITY, 255, 29, 53 waitstate end diff --git a/include/constants/flags.h b/include/constants/flags.h index f0759389f..230fbabaf 100644 --- a/include/constants/flags.h +++ b/include/constants/flags.h @@ -1548,7 +1548,7 @@ // Special Flags (Unknown) #define SPECIAL_FLAGS_START 0x4000 -#define FLAG_SPECIAL_FLAG_0x4000 0x4000 +#define FLAG_HIDE_MAP_NAME_POPUP 0x4000 #define FLAG_SPECIAL_FLAG_0x4001 0x4001 #define FLAG_SPECIAL_FLAG_0x4002 0x4002 #define FLAG_SPECIAL_FLAG_0x4003 0x4003 diff --git a/src/field_special_scene.c b/src/field_special_scene.c index 2b518808b..e059e6ef8 100644 --- a/src/field_special_scene.c +++ b/src/field_special_scene.c @@ -301,7 +301,7 @@ void Task_HandlePorthole(u8 taskId) break; case EXIT_PORTHOLE: // exit porthole. FlagClear(FLAG_SPECIAL_FLAG_0x4001); - FlagClear(FLAG_SPECIAL_FLAG_0x4000); + FlagClear(FLAG_HIDE_MAP_NAME_POPUP); SetWarpDestinationToDynamicWarp(0); DoDiveWarp(); DestroyTask(taskId); @@ -338,7 +338,7 @@ void sub_80FB7A4(void) { FlagSet(FLAG_SYS_CRUISE_MODE); FlagSet(FLAG_SPECIAL_FLAG_0x4001); - FlagSet(FLAG_SPECIAL_FLAG_0x4000); + FlagSet(FLAG_HIDE_MAP_NAME_POPUP); SetDynamicWarp(0, gSaveBlock1Ptr->location.mapGroup, gSaveBlock1Ptr->location.mapNum, -1); sub_80FB59C(); sub_80AF8B8(); diff --git a/src/map_name_popup.c b/src/map_name_popup.c index 8936198ae..d95b808e9 100644 --- a/src/map_name_popup.c +++ b/src/map_name_popup.c @@ -207,7 +207,7 @@ bool8 sub_80D47D4(void) void ShowMapNamePopup(void) { - if (FlagGet(FLAG_SPECIAL_FLAG_0x4000) != TRUE) + if (FlagGet(FLAG_HIDE_MAP_NAME_POPUP) != TRUE) { if (!FuncIsActiveTask(Task_MapNamePopUpWindow)) {