FRLG+ whiteout message #4967

cawtds · 2024-07-13T21:02:07Z

Description

Adds FRLG type whiteout sequence with message screen and event script.

Images

Issue(s) that this PR fixes

Fixes #4082

Discord contact info

.cawt

Bassoonian

Some are actual necessary changes, some are just some ideas on how we could potentially clean it up. I'm very excited as you know, so I'd rather have some other reviewer also chime in to make sure everything is as it should be :)

Bassoonian · 2024-07-13T21:05:10Z

include/config/overworld.h

@@ -8,6 +8,7 @@
 #define OW_POISON_DAMAGE                GEN_LATEST // In Gen4, Pokémon no longer faint from Poison in the overworld. In Gen5+, they no longer take damage at all.
 #define OW_DOUBLE_APPROACH_WITH_ONE_MON FALSE      // If enabled, you can be spotted by two trainers at the same time even if you only have one eligible Pokémon in your party.
 #define OW_HIDE_REPEAT_MAP_POPUP        FALSE      // If enabled, map popups will not appear if entering a map with the same Map Section Id as the last.
+#define OW_FRLG_WHITEOUT                TRUE       // If enabled, shows an additional whiteout message and post whiteout event script with healing NPC


Config should be off by default

Suggested change

#define OW_FRLG_WHITEOUT TRUE // If enabled, shows an additional whiteout message and post whiteout event script with healing NPC

#define OW_FRLG_WHITEOUT FALSE // If enabled, shows an additional whiteout message and post whiteout event script with healing NPC

Bassoonian · 2024-07-13T21:07:06Z

src/heal_location.c

+        && warpData->y == loc->y;
+}
+
+static void SetWhiteoutRespawnHealerNpcAsLastTalked(u32 healLocationId)


Suggested change

static void SetWhiteoutRespawnHealerNpcAsLastTalked(u32 healLocationId)

static void SetWhiteoutRespawnHealerNPCAsLastTalked(u32 healLocationId)

Bassoonian · 2024-07-13T21:07:15Z

src/heal_location.c

+    gSpecialVar_LastTalked = sWhiteoutRespawnHealerNpcLocalIds[healLocationId - 1];
+}
+
+void SetWhiteoutRespawnWarpAndHealerNpc(struct WarpData * warp)


Suggested change

void SetWhiteoutRespawnWarpAndHealerNpc(struct WarpData * warp)

void SetWhiteoutRespawnWarpAndHealerNPC(struct WarpData * warp)

Bassoonian · 2024-07-13T21:08:35Z

include/constants/heal_locations.h

@@ -24,5 +24,6 @@
 #define HEAL_LOCATION_EVER_GRANDE_CITY_POKEMON_LEAGUE 20
 #define HEAL_LOCATION_SOUTHERN_ISLAND_EXTERIOR 21
 #define HEAL_LOCATION_BATTLE_FRONTIER_OUTSIDE_EAST 22
+#define HEAL_LOCATION_MAX (HEAL_LOCATION_BATTLE_FRONTIER_OUTSIDE_EAST)


Optional, but I think we generally would use HEAL_LOCATION_COUNT with a +1 here

Bassoonian · 2024-07-13T21:09:53Z

src/field_screen_effect.c

+
+

Suggested change

Bassoonian · 2024-07-13T21:12:52Z

src/heal_location.c

+        warp->mapNum = sHealLocationsPokemonCenter[healLocationId - 1][1];
+        warp->warpId = 0xFF;
+
+        if (sHealLocationsPokemonCenter[healLocationId - 1][0] == MAP_GROUP(LITTLEROOT_TOWN_BRENDANS_HOUSE_1F) && sHealLocationsPokemonCenter[healLocationId - 1][1] == MAP_NUM(LITTLEROOT_TOWN_BRENDANS_HOUSE_1F))


Since we can never both have FRLG whiteouts and the normal ones, I wonder if these hardcoded coordinates should instead become part of a config-dependent sHealLocations. Just an idea

HEAL_LOCATION_SOUTHERN_ISLAND_EXTERIOR uses the normal whiteout even with FRLG enabled. I think it might also be possible to replace struct WarpData lastHealLocation in SaveBlock1 with just a u8 healLocationId saving 4 byte. This would also make checking for the location much easier. Though this would obviously be save breaking.

Does HEAL_LOCATION_SOUTHERN_ISLAND_EXTERIOR exist in ORAS? What does it do there?

Not sure, but it is only used as a flight destination and is never set, since it is not possible to target Southern Island as a destination. I don't think it was ever intended as a heal location, just planned as a possible flight path. HEAL_LOCATION is imo a bit of a misleading name, since Teleport and Fly also use them.

…hanges

src/data/heal_locations_pkm_center.h

pkmnsnfrn · 2024-07-27T02:06:54Z

src/field_screen_effect.c

+
+    switch (gTasks[taskId].tState)
+    {
+    case 0:


Can we please replace the case numbers with constants? It would just be easier to understand what's happening ,especially because case 4 is after 2 and 5 lmao

pkmnsnfrn · 2024-07-27T02:12:22Z

src/field_screen_effect.c

+        CopyWindowToVram(windowId, COPYWIN_FULL);
+
+        // Scene changes if last heal location was the player's house
+        if (IsLastHealLocation(HEAL_LOCATION_LITTLEROOT_TOWN_MAYS_HOUSE)


I don't love this giant if statement. Is it possible to add them to a whitelist of "home" locations and then change IsLastHealLocation to GetLastHealLocation and check that against the list? IsRegularLandTrainer is an example

Okay now that I've looked at IsLastHealLocation I didn't realize you were checking 5 different conditions lmao, probably not possible

pkmnsnfrn · 2024-07-27T02:20:08Z

src/heal_location.c

+{
+    if (healLocationId == HEAL_LOCATION_NONE || healLocationId >= HEAL_LOCATION_COUNT)
+        return FALSE;
+    return sWhiteoutRespawnHealerNpcLocalIds[healLocationId - 1] > 0;


What is the expected behavior when no heal location is set?

When I whiteout without ever setting a heal location, I get sent to Battle Frontier East and I heal outside lmao.

Missing a bit of context here. What exactly isn't set? sHealLocation, sHealLocationsPokemonCenter, sWhiteoutRespawnHealerNpcLocalIds?

sHealLocation. If you use cheat start and a script, and whiteout inside the truck, you'll see the behavior.

That's also what I was referring to with #4967 (comment)

seen here: https://youtu.be/NhYclVXCmN4?t=499

src/data/heal_locations_pkm_center.h

pkmnsnfrn

Works perfectly in game. Consider all of my feedback optional, just resolve / commit the suggestions and tag me when you're done and I'll merge.

src/field_screen_effect.c

include/config/overworld.h

src/data/heal_locations_pkm_center.h

src/heal_location.c

include/heal_location.h

src/heal_location.c

src/overworld.c

FRLG whiteout message + post whiteout event

4753e87

Bassoonian reviewed Jul 13, 2024

View reviewed changes

cawtds added 4 commits July 14, 2024 12:58

added more accurate way to get heal location index, added suggested c…

34c7de1

…hanges

remove includes

dbf13a5

fix typo

2a7f102

remove redundancy

f9476de

Bassoonian assigned pkmnsnfrn Jul 16, 2024

moved new data to separate file for porymap compatability

6dad6ed

hedara90 added the category: text label Jul 26, 2024

pkmnsnfrn reviewed Jul 27, 2024

View reviewed changes

fixed issue with undefined respawn locations, cleaned up whiteout task

410738b

pkmnsnfrn reviewed Jul 28, 2024

View reviewed changes

added suggested changes

e4b539f

pkmnsnfrn approved these changes Aug 2, 2024

View reviewed changes

pkmnsnfrn merged commit 3af93bd into rh-hideout:upcoming Aug 2, 2024
1 check passed

cawtds deleted the frlg-whiteout-message branch August 12, 2024 16:01

pkmnsnfrn mentioned this pull request Aug 14, 2024

FRLG+ whiteout message #4082

Closed

AsparagusEduardo added category: battle-mechanic Pertains to battle mechanics new-feature Adds a feature category: overworld Pertains to out-of-battle mechanics labels Dec 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FRLG+ whiteout message #4967

FRLG+ whiteout message #4967

cawtds commented Jul 13, 2024 •

edited

Loading

Bassoonian left a comment

Bassoonian Jul 13, 2024

Bassoonian Jul 13, 2024

Bassoonian Jul 13, 2024

Bassoonian Jul 13, 2024

Bassoonian Jul 13, 2024

Bassoonian Jul 13, 2024

cawtds Jul 13, 2024

kittenchilly Jul 13, 2024

cawtds Jul 14, 2024 •

edited

Loading

pkmnsnfrn Jul 27, 2024

pkmnsnfrn Jul 27, 2024

pkmnsnfrn Jul 27, 2024

pkmnsnfrn Jul 27, 2024

cawtds Jul 27, 2024

pkmnsnfrn Jul 27, 2024

pkmnsnfrn left a comment

	#define OW_FRLG_WHITEOUT TRUE // If enabled, shows an additional whiteout message and post whiteout event script with healing NPC
	#define OW_FRLG_WHITEOUT FALSE // If enabled, shows an additional whiteout message and post whiteout event script with healing NPC

	static void SetWhiteoutRespawnHealerNpcAsLastTalked(u32 healLocationId)
	static void SetWhiteoutRespawnHealerNPCAsLastTalked(u32 healLocationId)

	void SetWhiteoutRespawnWarpAndHealerNpc(struct WarpData * warp)
	void SetWhiteoutRespawnWarpAndHealerNPC(struct WarpData * warp)

FRLG+ whiteout message #4967

FRLG+ whiteout message #4967

Conversation

cawtds commented Jul 13, 2024 • edited Loading

Description

Images

Issue(s) that this PR fixes

Discord contact info

Bassoonian left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cawtds Jul 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pkmnsnfrn left a comment

Choose a reason for hiding this comment

cawtds commented Jul 13, 2024 •

edited

Loading

cawtds Jul 14, 2024 •

edited

Loading