Fly from Pokenav #5679

khbsd · 2024-11-18T01:21:20Z

Lets the player press 'R' over locations they have visited to fly to them from the PokeNav Region Map.

Description

refactored some logic from CB_ExitFlyMap() to allow setting the fly destination correctly from other files
added OW_FLAG_POKE_RIDER to allow this feature to be disabled
added gSkipShowMonAnim as an EWRAM variable to control whether the ShowMon animation plays or not
added new Looped Task in pokenav_region_map.c to handle flying
added new function UpdateRegionMapHelpBarText() so the HelpBarText can be easily synced with cursor movement and loading the map from the menu
added new inputs to both ProcessRegionMapInput_* functions
added new zoomed in and out text strings with the R button and the text 'FLY' for when the cursor is over a flyable location in the region map
adjusted some #includes and changed some static functions to non-static so they could be declared in the header files
uhhhhh probs more but i forgor

remade the branch and manually copy-pasted the correct changes. cleaned, compiled, tested.

Feature(s) this PR does NOT handle:

Adding other interactions in the overworld to handle other HM moves, this is specifically for Fly

Discord contact info

@khbsd

…expansion into pokenav-fly-v2

AlexOn1ine · 2024-12-19T12:08:45Z

Could you also make it work with the Town Map item?

hedara90 · 2024-12-19T12:10:35Z

Currently, you can use the PokeNav to fly while indoors (and I'm assuming other areas where flying is usually not possible).

hedara90 · 2024-12-08T17:42:30Z

include/config/overworld.h

+#define OW_FLAG_PAUSE_TIME           0  // If this flag is set and OW_USE_FAKE_RTC is enabled, seconds on the in-game clock will not advance.
+#define OW_FLAG_NO_ENCOUNTER         0  // If this flag is set, wild encounters will be disabled.
+#define OW_FLAG_NO_TRAINER_SEE       0  // If this flag is set, trainers will not battle the player unless they're talked to.
+#define OW_FLAG_NO_COLLISION         0  // If this flag is set, the player will be able to walk over tiles with collision. Mainly intended for debugging purposes.
+#define OW_FLAG_POKE_RIDER           0  // If this flag is set, the player will be able to use fly from the Pokenav Region Map section by pressing 'R' on a city/location they have been to.


Suggested change

#define OW_FLAG_PAUSE_TIME 0 // If this flag is set and OW_USE_FAKE_RTC is enabled, seconds on the in-game clock will not advance.

#define OW_FLAG_NO_ENCOUNTER 0 // If this flag is set, wild encounters will be disabled.

#define OW_FLAG_NO_TRAINER_SEE 0 // If this flag is set, trainers will not battle the player unless they're talked to.

#define OW_FLAG_NO_COLLISION 0 // If this flag is set, the player will be able to walk over tiles with collision. Mainly intended for debugging purposes.

#define OW_FLAG_POKE_RIDER 0 // If this flag is set, the player will be able to use fly from the Pokenav Region Map section by pressing 'R' on a city/location they have been to.

#define OW_FLAG_PAUSE_TIME 0 // If this flag is set and OW_USE_FAKE_RTC is enabled, seconds on the in-game clock will not advance.

#define OW_FLAG_NO_ENCOUNTER 0 // If this flag is set, wild encounters will be disabled.

#define OW_FLAG_NO_TRAINER_SEE 0 // If this flag is set, trainers will not battle the player unless they're talked to.

#define OW_FLAG_NO_COLLISION 0 // If this flag is set, the player will be able to walk over tiles with collision. Mainly intended for debugging purposes.

#define OW_FLAG_POKE_RIDER 0 // If this flag is set, the player will be able to use fly from the Pokenav Region Map section by pressing 'R' on a city/location they have been to.

Match previous alignment

hedara90 · 2024-12-19T12:47:58Z

src/pokenav_region_map.c

+{
+    struct RegionMap* regionMap = GetSubstructPtr(POKENAV_SUBSTRUCT_REGION_MAP);
+
+    if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER)


Suggested change

if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER)

if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER && Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType))

Handling for prevention of flying indoors etc.

hedara90 · 2024-12-19T12:48:48Z

src/pokenav_region_map.c

@@ -215,6 +222,9 @@ static u32 HandleRegionMapInput(struct Pokenav_RegionMapMenu *state)
    case MAP_INPUT_B_BUTTON:
        state->callback = GetExitRegionMapMenuId;
        return POKENAV_MAP_FUNC_EXIT;
+    case MAP_INPUT_R_BUTTON:
+        if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER)


Suggested change

if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER)

if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER && Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)

…expansion into pokenav-fly-v2

khbsd · 2024-12-19T19:35:22Z

addressed @hedara90's comments, looking into the town map item functionality now!

…kenav_region_map.c

khbsd · 2024-12-20T02:46:48Z

added the prompt for flying from the town map. it replaces HOENN in the region title at the top right; this was the most space-efficient solution i could think of that didnt mean covering up more of the map.

AlexOn1ine · 2024-12-21T09:21:54Z

src/field_region_map.c

+u8 hoennOffset;
+u8 flyOffset;


why is this outside of a function?

i figured it'd be better to set them when the FieldUpdateRegionMap() is called rather than every time the PrintTitleWindowText() function is called to speed up text display

Pass them as arguments into PrintTitleWindowText() instead then. We don't define variables outside of functions unless they are globals and those don't need to be globals.

Also, the function FieldUpdateRegionMap is rerun each case which means that they are calculated each time regardless so you aren't gaining any speed improvement with this which means you could just calc it in PrintTitleWindowText which will be better for speed because you aren't recalcing each time FieldUpdateRegionMap is run.

good to know! i thought it was a big loop inside FieldUpdateRegionMap lol

AlexOn1ine · 2024-12-21T09:23:05Z

src/field_region_map.c

@@ -45,6 +49,12 @@ static void VBCB_FieldUpdateRegionMap(void);
 static void MCB2_FieldUpdateRegionMap(void);
 static void FieldUpdateRegionMap(void);
 static void PrintRegionMapSecName(void);
+static void PrintTitleWindowText(void);
+
+static const u8* const FlyPromptText = COMPOUND_STRING("{R_BUTTON}FLY");


This should be just a normal text string. We don't use compound strings like that.

this is actually straight from the strings used in the pokenav helpbar, though there it's an array.

We use Compound Strings for non duplicate strings, so single use strings. If you want this to use multiply times it should be a normal string so

static const u8 sFlyPropmtText[] = _("{R_BUTTON}FLY");

this is technically a single use string- should it stay a compound string then?

You use it twice right?

The reason we use compound strings is because they make code more readable and additionally save a little bit of space so in your case it should be moved where it is needed in the first place. Though iirc we've decided to keep using normal strings for function arguments so you would need to convert it either way.

oh, i see, yeah it's used once in the file, but twice in the function. fixed!

hmm in this case should it be defined in the PrintTitleWindowText func? since it's only used there?

…expansion into pokenav-fly-v2

@iriv24

…thanks @iriv24!)

AlexOn1ine · 2024-12-25T17:28:05Z

src/pokenav_region_map.c

+        if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && FlagGet(OW_FLAG_POKE_RIDER) &&
+            Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)


Suggested change

if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && FlagGet(OW_FLAG_POKE_RIDER) &&

Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)

if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && FlagGet(OW_FLAG_POKE_RIDER)

&& Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)

AlexOn1ine

Few more things. I'll test ingame after that and should be ready for a merge

AlexOn1ine · 2024-12-25T17:28:35Z

src/field_region_map.c

+        AddTextPrinterParameterized(WIN_TITLE, FONT_NORMAL, gText_Hoenn, hoennOffset, 1, 0, NULL);
+        CopyWindowToVram(WIN_TITLE, COPYWIN_FULL);
+    }
+}


Suggested change

}

}

AlexOn1ine · 2024-12-25T17:28:56Z

src/field_region_map.c

+                    if (sFieldRegionMapHandler->regionMap.mapSecType == MAPSECTYPE_CITY_CANFLY &&
+                        FlagGet(OW_FLAG_POKE_RIDER) && Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)


Suggested change

if (sFieldRegionMapHandler->regionMap.mapSecType == MAPSECTYPE_CITY_CANFLY &&

FlagGet(OW_FLAG_POKE_RIDER) && Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)

if (sFieldRegionMapHandler->regionMap.mapSecType == MAPSECTYPE_CITY_CANFLY

&& FlagGet(OW_FLAG_POKE_RIDER) && Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)

AlexOn1ine · 2024-12-25T17:29:42Z

src/region_map.c

+
+void SetFlyDestination(struct RegionMap* regionMap)
+{
+    u8 flyDestination = FilterFlyDestination(regionMap);


Suggested change

u8 flyDestination = FilterFlyDestination(regionMap);

u32 flyDestination = FilterFlyDestination(regionMap);

doesn't this one need to be a u8? void SetWarpDestinationToHealLocation(u8 healLocationId);

No, it doesn't. The compiler wastes an instruction and turns it into a u32 anyways so technically it would be better to change the healLocationId argument to a u32.

ah rad- will adjust! ty!

should healLocationId-> u32 be included in this PR?

nah, since you haven't touched the function I wouldn't

AlexOn1ine · 2024-12-25T17:30:04Z

src/field_region_map.c

+    u8 hoennOffset = GetStringCenterAlignXOffset(FONT_NORMAL, gText_Hoenn, 0x38);
+    u8 flyOffset = GetStringCenterAlignXOffset(FONT_NORMAL, FlyPromptText, 0x38);


Suggested change

u8 hoennOffset = GetStringCenterAlignXOffset(FONT_NORMAL, gText_Hoenn, 0x38);

u8 flyOffset = GetStringCenterAlignXOffset(FONT_NORMAL, FlyPromptText, 0x38);

u32 hoennOffset = GetStringCenterAlignXOffset(FONT_NORMAL, gText_Hoenn, 0x38);

u32 flyOffset = GetStringCenterAlignXOffset(FONT_NORMAL, FlyPromptText, 0x38);

khbsd added 2 commits November 17, 2024 18:54

clean copy from fly-from-pokenav

0f71be0

code comment edited to describe function better

2616150

AlexOn1ine added the new-feature Adds a feature label Nov 18, 2024

AlexOn1ine added this to the 1.11 milestone Nov 18, 2024

AlexOn1ine self-assigned this Nov 18, 2024

khbsd added 3 commits November 25, 2024 15:34

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

c1c6904

…expansion into pokenav-fly-v2

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

f9f99ba

…expansion into pokenav-fly-v2

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

558b07a

…expansion into pokenav-fly-v2

AlexOn1ine removed their assignment Dec 3, 2024

khbsd added 3 commits December 7, 2024 15:52

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

6ccc803

…expansion into pokenav-fly-v2

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

eac320f

…expansion into pokenav-fly-v2

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

1556540

…expansion into pokenav-fly-v2

hedara90 reviewed Dec 19, 2024

View reviewed changes

khbsd added 2 commits December 19, 2024 13:23

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

e0ba3a3

…expansion into pokenav-fly-v2

addressed hedara's comments

991aeff

added fly prompt in the town map and cleaned up some formatting in po…

9c1eed3

…kenav_region_map.c

AlexOn1ine reviewed Dec 21, 2024

View reviewed changes

khbsd added 3 commits December 24, 2024 13:13

Merge branch 'upcoming' of https://github.com/rh-hideout/pokeemerald-…

d34544a

…expansion into pokenav-fly-v2

let OW_FLAG_POKE_RIDER be used as a flag as well as a global toggle (…

642849d

…thanks @iriv24!)

addressed alex's comments, ty!

6bef85d

AlexOn1ine reviewed Dec 25, 2024

View reviewed changes

addresses alex's comments

a82e70c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fly from Pokenav #5679

Fly from Pokenav #5679

khbsd commented Nov 18, 2024 •

edited

Loading

AlexOn1ine commented Dec 19, 2024

hedara90 commented Dec 19, 2024

hedara90 Dec 8, 2024

hedara90 Dec 19, 2024

hedara90 Dec 19, 2024

khbsd commented Dec 19, 2024

khbsd commented Dec 20, 2024

AlexOn1ine Dec 21, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024

AlexOn1ine Dec 25, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 21, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024

khbsd Dec 25, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024

AlexOn1ine left a comment

AlexOn1ine Dec 25, 2024

AlexOn1ine Dec 25, 2024

AlexOn1ine Dec 25, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024 •

edited

Loading

khbsd Dec 25, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024

khbsd Dec 25, 2024

AlexOn1ine Dec 25, 2024

	if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER)
	if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && OW_FLAG_POKE_RIDER && Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType))

		if (regionMap->mapSecType == MAPSECTYPE_CITY_CANFLY && FlagGet(OW_FLAG_POKE_RIDER) &&
		Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)

		if (sFieldRegionMapHandler->regionMap.mapSecType == MAPSECTYPE_CITY_CANFLY &&
		FlagGet(OW_FLAG_POKE_RIDER) && Overworld_MapTypeAllowsTeleportAndFly(gMapHeader.mapType) == TRUE)

	u8 flyDestination = FilterFlyDestination(regionMap);
	u32 flyDestination = FilterFlyDestination(regionMap);

		u8 hoennOffset = GetStringCenterAlignXOffset(FONT_NORMAL, gText_Hoenn, 0x38);
		u8 flyOffset = GetStringCenterAlignXOffset(FONT_NORMAL, FlyPromptText, 0x38);

Fly from Pokenav #5679

Are you sure you want to change the base?

Fly from Pokenav #5679

Conversation

khbsd commented Nov 18, 2024 • edited Loading

Description

Feature(s) this PR does NOT handle:

Discord contact info

AlexOn1ine commented Dec 19, 2024

hedara90 commented Dec 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khbsd commented Dec 19, 2024

khbsd commented Dec 20, 2024

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

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

AlexOn1ine 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

AlexOn1ine Dec 25, 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

khbsd commented Nov 18, 2024 •

edited

Loading

AlexOn1ine Dec 25, 2024 •

edited

Loading