Merge pull request #935 from GriffinRichards/doc-warp

Document some warp/field screen effect

include/constants/field_specials.h

@@ -7,7 +7,7 @@
 #define PC_LOCATION_MAYS_HOUSE      2
 
 // SS Tidal Locations
-#define SS_TIDAL_LOCATION_OTHER     0
+#define SS_TIDAL_LOCATION_CURRENTS  0
 #define SS_TIDAL_LOCATION_SLATEPORT 1
 #define SS_TIDAL_LOCATION_LILYCOVE  2
 #define SS_TIDAL_LOCATION_ROUTE124  3

include/field_effect.h

@@ -34,17 +34,17 @@ bool8 FieldEffectCmd_end(u8 **script, u32 *val);
 bool8 FieldEffectCmd_loadgfx_callnative(u8 **script, u32 *val);
 bool8 FieldEffectCmd_loadtiles_callnative(u8 **script, u32 *val);
 bool8 FieldEffectCmd_loadfadedpal_callnative(u8 **script, u32 *val);
-void sub_80B6B68(void);
-void sub_80B6E4C(u8 a0, u8 priority);
-void sub_80B75D8(u8 priority);
-void sub_80B7A74(u8 priority);
+void FieldCB_FallWarpExit(void);
+void StartEscalatorWarp(u8 metatileBehavior, u8 priority);
+void StartLavaridgeGymB1FWarp(u8 priority);
+void StartLavaridgeGym1FWarp(u8 priority);
 
 void sub_80B9C28(s16*, u8);
 void sub_80B9C54(s16*, u8);
 void sub_80B9CDC(s16*, u8);
 
-void sub_80B7CAC(struct Sprite*);
-void sub_80B7A58(struct Sprite*);
+void SpriteCB_PopOutOfAsh(struct Sprite*);
+void SpriteCB_LavaridgeGymWarp(struct Sprite*);
 
 void MultiplyPaletteRGBComponents(u16 i, u8 r, u8 g, u8 b);
 void FreeResourcesAndDestroySprite(struct Sprite *sprite, u8 spriteId);

include/field_player_avatar.h

@@ -61,7 +61,7 @@ void sub_808D194(void);
 void sub_808D1C8(void);
 bool32 sub_808D1B4(void);
 bool32 sub_808D1E8(void);
-void sub_808C0A8(u8 a);
+void SetPlayerInvisibility(bool8 invisible);
 u8 player_get_pos_including_state_based_drift(s16 *x, s16 *y);
 
 #endif // GUARD_FIELD_PLAYER_AVATAR_H

include/field_screen_effect.h

@@ -1,37 +1,35 @@
 #ifndef GUARD_FIELD_SCREEN_EFFECT_H
 #define GUARD_FIELD_SCREEN_EFFECT_H
 
-void pal_fill_for_maplights(void);
-void pal_fill_black(void);
-void WarpFadeScreen(void);
-void sub_80AF128(void);
-void FieldCallback_ReturnToEventScript2(void);
-void sub_80AF188(void);
-void sub_80AF214(void);
-void sub_80AF2B4(u8 taskId);
-void sub_80AF314(void);
-void mapldr_default(void);
-void sub_80AF3B0(void);
-void sub_80AF3C8(void);
-void sub_80AF3E8(void);
-void sub_80AF40C(void);
-void sub_80AF688(void);
-bool8 sub_80AF6A4(void);
+void WarpFadeInScreen(void);
+void WarpFadeOutScreen(void);
+void FadeInFromBlack(void);
+void FadeInFromWhite(void);
+void FieldCB_ContinueScriptUnionRoom(void);
+void FieldCB_ContinueScriptHandleMusic(void);
+void FieldCB_ContinueScript(void);
+void Task_ReturnToFieldRecordMixing(u8 taskId);
+void FieldCB_ReturnToFieldCableLink(void);
+void FieldCB_ReturnToFieldWirelessLink(void);
+void FieldCB_DefaultWarpExit(void);
+void FieldCB_WarpExitFadeFromBlack(void);
+void FieldCB_WarpExitFadeFromWhite(void);
+bool8 FieldCB_ReturnToFieldOpenStartMenu(void);
+void ReturnToFieldOpenStartMenu(void);
 void sub_80AF6D4(void);
 void sub_80AF6F0(void);
 void DoWarp(void);
 void DoDiveWarp(void);
-void sub_80AF79C(void);
+void DoSootopolisLegendWarp(void);
 void DoDoorWarp(void);
 void DoFallWarp(void);
-void sub_80AF80C(u8 metatileBehavior);
-void sub_80AF828(void);
-void sub_80AF838(void);
-void sub_80AF848(void);
+void DoEscalatorWarp(u8 metatileBehavior);
+void DoLavaridgeGymB1FWarp(void);
+void DoLavaridgeGym1FWarp(void);
+void DoTeleportWarp(void);
 void DoMossdeepGymWarp(void);
-void sub_80AF8B8(void);
-void sub_80AF948(void);
-void sub_80AF9F8(void);
+void DoPortholeWarp(void);
+void DoCableClubWarp(void);
 void DoContestHallWarp(void);
 void AnimateFlash(u8 flashLevel);
 void WriteBattlePyramidViewScanlineEffectBuffer(void);
@@ -41,6 +39,6 @@ void DoOrbEffect(void);
 void FadeOutOrbEffect(void);
 void sub_80B05B4(void);
 void WriteFlashScanlineEffectBuffer(u8 flashLevel);
-bool8 walkrun_is_standing_still(void);
+bool8 IsPlayerStandingStill(void);
 
 #endif // GUARD_FIELD_SCREEN_EFFECT_H

include/field_special_scene.h

@@ -10,6 +10,6 @@ void Task_HandleTruckSequence(u8 taskId);
 void ExecuteTruckSequence(void);
 void EndTruckSequence(u8);
 void sub_80C791C(void);
-void sub_80FB768(void);
+void FieldCB_ShowPortholeView(void);
 
 #endif // GUARD_FIELD_SPECIAL_SCENE_H

include/overworld.h

@@ -136,7 +136,7 @@ void CB2_NewGame(void);
 void CB2_WhiteOut(void);
 void CB2_LoadMap(void);
 void sub_8086024(void);
-void sub_8086074(void);
+void CB2_ReturnToFieldCableClub(void);
 void CB2_ReturnToField(void);
 void CB2_ReturnToFieldLocal(void);
 void CB2_ReturnToFieldLink(void);

include/start_menu.h

@@ -3,7 +3,7 @@
 
 extern bool8 (*gMenuCallback)(void);
 
-void sub_809FA18(void);
+void ShowReturnToFieldStartMenu(void);
 void Task_ShowStartMenu(u8 taskId);
 void ShowStartMenu(void);
 void ShowBattlePyramidStartMenu(void);