Document more field effects

1 files changed, 14 insertions, 8 deletions

diff --git a/include/field_effect_helpers.h b/include/field_effect_helpers.h
index 9b7b6ffd5..9795d96e8 100644
--- a/include/field_effect_helpers.h
+++ b/include/field_effect_helpers.h
@@ -1,16 +1,22 @@
 #ifndef GUARD_FIELD_EFFECT_HELPERS_H
 #define GUARD_FIELD_EFFECT_HELPERS_H
 
-// Exported type declarations
+// States for bobbing up and down while surfing
+enum {
+    // No bobbing
+    BOB_NONE,
+    // Both the surf blob/mon should bob up and down
+    BOB_PLAYER_AND_MON,
+    // Only the surf blob/mon should bob up and down
+    // For when the player has jumped/flown off
+    BOB_JUST_MON,
+};
 
-// Exported RAM declarations
-
-// Exported ROM declarations
 u8 CreateWarpArrowSprite(void);
-u8 sub_8155800(u8 oldSpriteId);
-void SetSurfBobState(u8 spriteId, u8 value);
-void SetSurfBobWhileFlyingOutState(u8 spriteId, u8 value);
-void SetSurfBobWhileFishingState(u8 spriteId, u8 value, s16 data1);
+u8 StartUnderwaterSurfBlobBobbing(u8 oldSpriteId);
+void SetSurfBlob_BobState(u8 spriteId, u8 state);
+void SetSurfBlob_DontSyncAnim(u8 spriteId, bool8 dontSync);
+void SetSurfBlob_PlayerOffset(u8 spriteId, bool8 hasOffset, s16 offset);
 bool8 sub_8155DA0(struct ObjectEvent *);
 void sub_8155D78(struct ObjectEvent *);
 void StartAshFieldEffect(s16, s16, u16, s16);