Continue documenting overworld/field effects

9 files changed, 48 insertions, 37 deletions

diff --git a/include/constants/field_effects.h b/include/constants/field_effects.h
index cd7a43e86..7032bc826 100644
--- a/include/constants/field_effects.h
+++ b/include/constants/field_effects.h
@@ -21,9 +21,9 @@
 #define FLDEFF_LONG_GRASS                17
 #define FLDEFF_JUMP_LONG_GRASS           18
 #define FLDEFF_UNKNOWN_19                19
-#define FLDEFF_UNUSED_GRASS              20
+#define FLDEFF_UNUSED_GRASS_2            20
 #define FLDEFF_UNKNOWN_21                21
-#define FLDEFF_UNKNOWN_22                22
+#define FLDEFF_WATER_SURFACING           22
 #define FLDEFF_BERRY_TREE_GROWTH_SPARKLE 23
 #define FLDEFF_DEEP_SAND_FOOTPRINTS      24
 #define FLDEFF_POKECENTER_HEAL           25
@@ -50,8 +50,8 @@
 #define FLDEFF_HEART_ICON                46
 #define FLDEFF_NOP_47                    47
 #define FLDEFF_NOP_48                    48
-#define FLDEFF_POP_OUT_OF_ASH            49
-#define FLDEFF_LAVARIDGE_GYM_WARP        50
+#define FLDEFF_ASH_PUFF                  49
+#define FLDEFF_ASH_LAUNCH                50
 #define FLDEFF_SWEET_SCENT               51
 #define FLDEFF_SAND_PILLAR               52
 #define FLDEFF_BUBBLES                   53
@@ -65,7 +65,7 @@
 #define FLDEFF_PCTURN_ON                 61
 #define FLDEFF_HALL_OF_FAME_RECORD       62
 #define FLDEFF_USE_TELEPORT              63
-#define FLDEFF_RAYQUAZA                  64
+#define FLDEFF_RAYQUAZA_SPOTLIGHT        64
 #define FLDEFF_DESTROY_DEOXYS_ROCK       65
 #define FLDEFF_MOVE_DEOXYS_ROCK          66
 
@@ -87,9 +87,9 @@
 #define FLDEFFOBJ_LONG_GRASS            15
 #define FLDEFFOBJ_JUMP_LONG_GRASS       16
 #define FLDEFFOBJ_17                    17
-#define FLDEFFOBJ_UNUSED_GRASS          18
+#define FLDEFFOBJ_UNUSED_GRASS_2        18
 #define FLDEFFOBJ_19                    19
-#define FLDEFFOBJ_20                    20
+#define FLDEFFOBJ_WATER_SURFACING       20
 #define FLDEFFOBJ_REFLECTION_DISTORTION 21
 #define FLDEFFOBJ_SPARKLE               22
 #define FLDEFFOBJ_DEEP_SAND_FOOTPRINTS  23
@@ -101,10 +101,25 @@
 #define FLDEFFOBJ_SAND_PILE             29
 #define FLDEFFOBJ_SHORT_GRASS           30
 #define FLDEFFOBJ_HOT_SPRINGS_WATER     31
-#define FLDEFFOBJ_JUMP_OUT_OF_ASH       32
-#define FLDEFFOBJ_LAVARIDGE_GYM_WARP    33
+#define FLDEFFOBJ_ASH_PUFF              32
+#define FLDEFFOBJ_ASH_LAUNCH            33
 #define FLDEFFOBJ_BUBBLES               34
 #define FLDEFFOBJ_SMALL_SPARKLE         35
 #define FLDEFFOBJ_RAYQUAZA              36
 
+#define FLDEFF_PAL_TAG_0 0x1000
+#define FLDEFF_PAL_TAG_3 0x1003
+#define FLDEFF_PAL_TAG_4 0x1004
+#define FLDEFF_PAL_TAG_5 0x1005
+#define FLDEFF_PAL_TAG_6 0x1006
+#define FLDEFF_PAL_TAG_7 0x1007
+#define FLDEFF_PAL_TAG_8 0x1008
+#define FLDEFF_PAL_TAG_9 0x1009
+#define FLDEFF_PAL_TAG_10 0x100A
+#define FLDEFF_PAL_TAG_13 0x100D
+#define FLDEFF_PAL_TAG_14 0x100E
+#define FLDEFF_PAL_TAG_15 0x100F
+#define FLDEFF_PAL_TAG_16 0x1010
+#define FLDEFF_PAL_TAG_17 0x1011
+
 #endif // GUARD_FIELD_EFFECT_CONSTANTS_H
diff --git a/include/constants/trainer_hill.h b/include/constants/trainer_hill.h
index afbcd4ace..27357e99c 100644
--- a/include/constants/trainer_hill.h
+++ b/include/constants/trainer_hill.h
@@ -22,7 +22,7 @@
 #define TRAINER_HILL_FUNC_GET_CHALLENGE_STATUS  6
 #define TRAINER_HILL_FUNC_GET_CHALLENGE_TIME    7
 #define TRAINER_HILL_FUNC_GET_ALL_FLOORS_USED   8
-#define TRAINER_HILL_FUNC_CLEAR_RESULT          9
+#define TRAINER_HILL_FUNC_GET_IN_EREADER_MODE   9
 #define TRAINER_HILL_FUNC_IN_CHALLENGE          10
 #define TRAINER_HILL_FUNC_POST_BATTLE_TEXT      11
 #define TRAINER_HILL_FUNC_SET_ALL_TRAINER_FLAGS 12
diff --git a/include/event_object_movement.h b/include/event_object_movement.h
index f0caa38aa..fa7cedff0 100644
--- a/include/event_object_movement.h
+++ b/include/event_object_movement.h
@@ -16,11 +16,7 @@ enum SpinnerRunnerFollowPatterns
     RUNFOLLOW_SOUTH_EAST_WEST
 };
 
-struct UnkStruct_085094AC
-{
-    const union AnimCmd *const *anims;
-    u8 animPos[4];
-};
+#define FIGURE_8_LENGTH 72
 
 #define GROUND_EFFECT_FLAG_TALL_GRASS_ON_SPAWN   (1 << 0)
 #define GROUND_EFFECT_FLAG_TALL_GRASS_ON_MOVE    (1 << 1)
@@ -43,6 +39,12 @@ struct UnkStruct_085094AC
 #define GROUND_EFFECT_FLAG_HOT_SPRINGS           (1 << 18)
 #define GROUND_EFFECT_FLAG_SEAWEED               (1 << 19)
 
+struct UnkStruct_085094AC
+{
+    const union AnimCmd *const *anims;
+    u8 animPos[4];
+};
+
 struct PairedPalettes
 {
     u16 tag;
@@ -174,8 +176,6 @@ u8 sub_809785C(struct Sprite *);
 u8 sub_80978E4(struct Sprite *);
 void SetAndStartSpriteAnim(struct Sprite *, u8, u8);
 bool8 SpriteAnimEnded(struct Sprite *);
-void sub_8097750(struct Sprite *);
-bool8 sub_8097758(struct Sprite *);
 void CreateLevitateMovementTask(struct ObjectEvent *);
 void DestroyExtraMovementTask(u8);
 void UnfreezeObjectEvents(void);
@@ -191,8 +191,8 @@ u8 GetLedgeJumpDirection(s16, s16, u8);
 void CameraObjectSetFollowedObjectId(u8 objectId);
 u16 GetObjectPaletteTag(u8 palSlot);
 void UpdateObjectEventSpriteVisibility(struct Sprite *sprite, bool8 invisible);
-s16 sub_809773C(s16 a1);
-s16 sub_8097728(s16 a1);
+s16 GetFigure8XOffset(s16 idx);
+s16 GetFigure8YOffset(s16 idx);
 void CameraObjectReset2(void);
 u8 ObjectEventGetBerryTreeId(u8 objectEventId);
 void sub_8092EF0(u8 mapId, u8 mapNumber, u8 mapGroup);
diff --git a/include/field_effect.h b/include/field_effect.h
index 42d007c37..731fb9c59 100644
--- a/include/field_effect.h
+++ b/include/field_effect.h
@@ -39,8 +39,8 @@ void StartEscalatorWarp(u8 metatileBehavior, u8 priority);
 void StartLavaridgeGymB1FWarp(u8 priority);
 void StartLavaridgeGym1FWarp(u8 priority);
 
-void SpriteCB_PopOutOfAsh(struct Sprite*);
-void SpriteCB_LavaridgeGymWarp(struct Sprite*);
+void SpriteCB_AshPuff(struct Sprite*);
+void SpriteCB_AshLaunch(struct Sprite*);
 
 void MultiplyPaletteRGBComponents(u16 i, u8 r, u8 g, u8 b);
 void FreeResourcesAndDestroySprite(struct Sprite *sprite, u8 spriteId);
diff --git a/include/field_effect_helpers.h b/include/field_effect_helpers.h
index 8257bc110..9b7b6ffd5 100644
--- a/include/field_effect_helpers.h
+++ b/include/field_effect_helpers.h
@@ -8,20 +8,22 @@
 // Exported ROM declarations
 u8 CreateWarpArrowSprite(void);
 u8 sub_8155800(u8 oldSpriteId);
-void sub_81555AC(u8, u8);
+void SetSurfBobState(u8 spriteId, u8 value);
+void SetSurfBobWhileFlyingOutState(u8 spriteId, u8 value);
+void SetSurfBobWhileFishingState(u8 spriteId, u8 value, s16 data1);
 bool8 sub_8155DA0(struct ObjectEvent *);
 void sub_8155D78(struct ObjectEvent *);
 void StartAshFieldEffect(s16, s16, u16, s16);
 void SetUpReflection(struct ObjectEvent*, struct Sprite*, u8);
 u32 StartFieldEffectForObjectEvent(u8, struct ObjectEvent*);
 u8 FindTallGrassFieldEffectSpriteId(u8 localId, u8 mapNum, u8 mapGroup, s16 x, s16 y);
-void sub_8155F80(struct Sprite*);
+void UpdateRayquazaSpotlightEffect(struct Sprite*);
 void UpdateShadowFieldEffect(struct Sprite*);
 void UpdateTallGrassFieldEffect(struct Sprite*);
 void WaitFieldEffectSpriteAnim(struct Sprite*);
 void UpdateAshFieldEffect(struct Sprite*);
 void UpdateSurfBlobFieldEffect(struct Sprite*);
-void sub_8156194(struct Sprite*);
+void UpdateJumpImpactEffect(struct Sprite*);
 void UpdateFootprintsTireTracksFieldEffect(struct Sprite*);
 void UpdateSplashFieldEffect(struct Sprite*);
 void UpdateLongGrassFieldEffect(struct Sprite*);
@@ -33,7 +35,5 @@ void UpdateBubblesFieldEffect(struct Sprite*);
 void UpdateSparkleFieldEffect(struct Sprite*);
 void SetSpriteInvisible(u8 spriteId);
 void ShowWarpArrowSprite(u8 spriteId, u8 direction, s16 x, s16 y);
-void sub_8155604(u8 spriteId, u8 value, s16 data1);
-void sub_81555D8(u8 spriteId, u8 value);
 
 #endif //GUARD_FIELD_EFFECT_HELPERS_H
diff --git a/include/field_player_avatar.h b/include/field_player_avatar.h
index 51dabdca2..722fe4444 100644
--- a/include/field_player_avatar.h
+++ b/include/field_player_avatar.h
@@ -1,7 +1,7 @@
 #ifndef GUARD_FIELD_PLAYER_AVATAR_H
 #define GUARD_FIELD_PLAYER_AVATAR_H
 
-void player_step(u8 a, u16 b, u16 c);
+void PlayerStep(u8 direction, u16 newKeys, u16 heldKeys);
 void ClearPlayerAvatarInfo(void);
 void SetPlayerAvatarExtraStateTransition(u8, u8);
 u8 GetPlayerAvatarGenderByGraphicsId(u8);
@@ -49,7 +49,7 @@ bool8 IsPlayerFacingSurfableFishableWater(void);
 bool8 IsPlayerSurfingNorth(void);
 void SetPlayerAvatarWatering(u8 direction);
 u8 GetPlayerAvatarFlags(void);
-void sub_808B578(void);
+void UpdatePlayerAvatarTransitionState(void);
 u8 GetFRLGAvatarGraphicsIdByGender(u8);
 u8 GetRSAvatarGraphicsIdByGender(u8);
 void PlayerWheelieInPlace(u8 direction);
diff --git a/include/fieldmap.h b/include/fieldmap.h
index cf7d4befe..e67983677 100644
--- a/include/fieldmap.h
+++ b/include/fieldmap.h
@@ -30,7 +30,7 @@ struct MapConnection *sub_8088950(u8 direction, int x, int y);
 bool8 sub_80889A8(u8 direction, int x, int y, struct MapConnection *connection);
 bool8 sub_8088A0C(int x, int src_width, int dest_width, int offset);
 void save_serialize_map(void);
-void sub_8088B3C(u16 x, u16 y);
+void SetCameraFocusCoords(u16 x, u16 y);
 void InitMap(void);
 void InitMapFromSavedGame(void);
 void InitTrainerHillMap(void);
@@ -41,13 +41,9 @@ void LoadSecondaryTilesetPalette(struct MapLayout const *mapLayout);
 void CopySecondaryTilesetToVramUsingHeap(struct MapLayout const *mapLayout);
 void CopyPrimaryTilesetToVram(const struct MapLayout *);
 void CopySecondaryTilesetToVram(const struct MapLayout *);
-struct MapHeader const *const mapconnection_get_mapheader(struct MapConnection *connection);
+struct MapHeader const *const GetMapHeaderFromConnection(struct MapConnection *connection);
 struct MapConnection *GetConnectionAtCoords(s16 x, s16 y);
 
-void SpriteCB_PokeballGlow(struct Sprite *);
-void SpriteCB_PokecenterMonitor(struct Sprite *);
-void SpriteCB_HallOfFameMonitor(struct Sprite *);
-
 // field_region_map.c
 void FieldInitRegionMap(MainCallback callback);
 void sub_8088B94(int x, int y, int a2);
diff --git a/include/trainer_hill.h b/include/trainer_hill.h
index c849bcced..3f0644248 100644
--- a/include/trainer_hill.h
+++ b/include/trainer_hill.h
@@ -75,7 +75,7 @@ void FillHillTrainerParty(void);
 void FillHillTrainersParties(void);
 u8 GetTrainerEncounterMusicIdInTrainerHill(u16 trainerId);
 u8 GetNumFloorsInTrainerHillChallenge(void);
-void sub_81D64C0(void);
-bool32 sub_81D6534(void);
+void TryLoadTrainerHillEReaderPalette(void);
+bool32 OnTrainerHillEReaderChallengeFloor(void);
 
 #endif // GUARD_TRAINER_HILL_H
diff --git a/include/tv.h b/include/tv.h
index 8e9233c2b..7e286ff6e 100644
--- a/include/tv.h
+++ b/include/tv.h
@@ -30,7 +30,7 @@ void AlertTVThatPlayerPlayedSlotMachine(u16 nCoinsSpent);
 void AlertTVThatPlayerPlayedRoulette(u16 nCoinsSpent);
 void AlertTVOfNewCoinTotal(u16 nCoinsPaidOut);
 void TryPutSecretBaseSecretsOnAir(void);
-void sub_80EDB44(void);
+void TryPutTodaysRivalTrainerOnAir(void);
 void sub_80EDC60(const u16 *words);
 void sub_80EDA80(void);
 void ReceivePokeNewsData(void *src, u32 size, u8 masterIdx);