Misc overworld documentation

1 files changed, 19 insertions, 22 deletions

diff --git a/include/overworld.h b/include/overworld.h
index 1f53662b3..f62a5136d 100644
--- a/include/overworld.h
+++ b/include/overworld.h
@@ -46,28 +46,25 @@ void Overworld_SetEventObjTemplateCoords(u8 localId, s16 x, s16 y);
 void Overworld_SetEventObjTemplateMovementType(u8 localId, u8 movementType);
 const struct MapLayout *GetMapLayout(void);
 void ApplyCurrentWarp(void);
-void set_warp2_warp3_to_neg_1(void);
 struct MapHeader const *const Overworld_GetMapHeaderByGroupAndId(u16 mapGroup, u16 mapNum);
 struct MapHeader const *const GetDestinationWarpMapHeader(void);
 void WarpIntoMap(void);
-void Overworld_SetWarpDestination(s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
-void warp1_set_2(s8 mapGroup, s8 mapNum, s8 warpId);
-void saved_warp2_set(s32 unused, s8 mapGroup, s8 mapNum, s8 warpId);
-void saved_warp2_set_2(s32 unused, s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
-void copy_saved_warp2_bank_and_enter_x_to_warp1(u8 unused);
-void sub_8084CCC(u8 a1);
-void Overworld_SetWarpDestToLastHealLoc(void);
-void Overworld_SetHealLocationWarp(u8 healLocationId);
-void sub_8084D5C(s16 a1, s16 a2);
-void sub_8084DD4(s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
-void sub_8084E14(void);
+void SetWarpDestination(s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
+void SetWarpDestinationToMapWarp(s8 mapGroup, s8 mapNum, s8 warpId);
+void SetDynamicWarp(s32 unused, s8 mapGroup, s8 mapNum, s8 warpId);
+void SetDynamicWarpWithCoords(s32 unused, s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
+void SetWarpDestinationToDynamicWarp(u8 unused);
+void SetWarpDestinationToHealLocation(u8 a1);
+void SetWarpDestinationToLastHealLocation(void);
+void SetLastHealLocationWarp(u8 healLocationId);
+void sub_8084D5C(s16 x, s16 y);
+void SetEscapeWarp(s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
+void SetWarpDestinationToEscapeWarp(void);
 void SetFixedDiveWarp(s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
 void SetFixedHoleWarp(s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
-void SetFixedHoleWarpAsDestination(s16 x, s16 y);
-void warp1_set_to_sav1w(void);
-void sub_8084F2C(s8 mapGroup, s8 mapNum, s8 warpId, s8 x, s8 y);
-void sub_8084F6C(u8 a1);
-void sub_8084FAC(int unused);
+void SetWarpDestinationToFixedHoleWarp(s16 x, s16 y);
+void SetContinueGameWarpToHealLocation(u8 a1);
+void SetContinueGameWarpToDynamicWarp(int unused);
 const struct MapConnection *GetMapConnection(u8 dir);
 bool8 SetDiveWarpEmerge(u16 x, u16 y);
 bool8 SetDiveWarpDive(u16 x, u16 y);
@@ -78,7 +75,7 @@ bool32 Overworld_IsBikingAllowed(void);
 void SetDefaultFlashLevel(void);
 void Overworld_SetFlashLevel(s32 flashLevel);
 u8 Overworld_GetFlashLevel(void);
-void sub_8085524(u16 mapLayoutId);
+void SetCurrentMapLayout(u16 mapLayoutId);
 void sub_8085540(u8 var);
 u8 sub_808554C(void);
 u16 GetLocationMusic(struct WarpData *warp);
@@ -97,15 +94,15 @@ void Overworld_FadeOutMapMusic(void);
 void UpdateAmbientCry(s16 *state, u16 *delayCounter);
 u8 GetMapTypeByGroupAndId(s8 mapGroup, s8 mapNum);
 u8 GetMapTypeByWarpData(struct WarpData *warp);
-u8 Overworld_GetMapTypeOfSaveblockLocation(void);
+u8 GetCurrentMapType(void);
 u8 GetLastUsedWarpMapType(void);
 bool8 is_map_type_1_2_3_5_or_6(u8 mapType);
 bool8 Overworld_MapTypeAllowsTeleportAndFly(u8 mapType);
 bool8 Overworld_MapTypeIsIndoors(u8 mapType);
-u8 sav1_saved_warp2_map_get_name(void);
-u8 sav1_map_get_name(void);
+u8 GetSavedWarpRegionMapSectionId(void);
+u8 GetCurrentRegionMapSectionId(void);
 u8 GetCurrentMapBattleScene(void);
-void overworld_free_bg_tilemaps(void);
+void CleanupOverworldWindowsAndTilemaps(void);
 bool32 is_c1_link_related_active(void);
 void CB1_Overworld(void);
 void CB2_OverworldBasic(void);