Clean up field effect doc

5 files changed, 24 insertions, 34 deletions

diff --git a/include/battle_transition.h b/include/battle_transition.h
index 0f583b101..b2e5efdc9 100644
--- a/include/battle_transition.h
+++ b/include/battle_transition.h
@@ -9,7 +9,7 @@ bool8 FldEff_Pokeball(void);
 void TransitionPhase1_Task_RunFuncs(u8 taskId);
 void GetBg0TilesDst(u16 **tilemap, u16 **tileset);
 
-extern const struct SpritePalette gFieldEffectObjectPaletteInfo10;
+extern const struct SpritePalette gSpritePalette_Pokeball;
 
 enum // TRANSITION_MUGSHOT
 {
diff --git a/include/constants/field_effects.h b/include/constants/field_effects.h
index 7032bc826..dc1085f7c 100644
--- a/include/constants/field_effects.h
+++ b/include/constants/field_effects.h
@@ -20,9 +20,9 @@
 #define FLDEFF_JUMP_SMALL_SPLASH         16
 #define FLDEFF_LONG_GRASS                17
 #define FLDEFF_JUMP_LONG_GRASS           18
-#define FLDEFF_UNKNOWN_19                19
+#define FLDEFF_UNUSED_GRASS              19
 #define FLDEFF_UNUSED_GRASS_2            20
-#define FLDEFF_UNKNOWN_21                21
+#define FLDEFF_UNUSED_SAND               21
 #define FLDEFF_WATER_SURFACING           22
 #define FLDEFF_BERRY_TREE_GROWTH_SPARKLE 23
 #define FLDEFF_DEEP_SAND_FOOTPRINTS      24
@@ -86,9 +86,9 @@
 #define FLDEFFOBJ_JUMP_SMALL_SPLASH     14
 #define FLDEFFOBJ_LONG_GRASS            15
 #define FLDEFFOBJ_JUMP_LONG_GRASS       16
-#define FLDEFFOBJ_17                    17
+#define FLDEFFOBJ_UNUSED_GRASS          17
 #define FLDEFFOBJ_UNUSED_GRASS_2        18
-#define FLDEFFOBJ_19                    19
+#define FLDEFFOBJ_UNUSED_SAND           19
 #define FLDEFFOBJ_WATER_SURFACING       20
 #define FLDEFFOBJ_REFLECTION_DISTORTION 21
 #define FLDEFFOBJ_SPARKLE               22
@@ -107,19 +107,17 @@
 #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
+#define FLDEFF_PAL_TAG_CUT_GRASS          0x1000
+#define FLDEFF_PAL_TAG_SECRET_POWER_TREE  0x1003
+#define FLDEFF_PAL_TAG_GENERAL_0          0x1004
+#define FLDEFF_PAL_TAG_GENERAL_1          0x1005
+#define FLDEFF_PAL_TAG_POKEBALL_GLOW      0x1007
+#define FLDEFF_PAL_TAG_SECRET_POWER_PLANT 0x1008
+#define FLDEFF_PAL_TAG_POKEBALL           0x1009
+#define FLDEFF_PAL_TAG_ASH                0x100D
+#define FLDEFF_PAL_TAG_SAND_PILLAR        0x100E
+#define FLDEFF_PAL_TAG_SMALL_SPARKLE      0x100F
+#define FLDEFF_PAL_TAG_HOF_MONITOR        0x1010
+#define FLDEFF_PAL_TAG_UNKNOWN            0x1011
 
 #endif // GUARD_FIELD_EFFECT_CONSTANTS_H
diff --git a/include/event_object_movement.h b/include/event_object_movement.h
index fa7cedff0..28443864d 100644
--- a/include/event_object_movement.h
+++ b/include/event_object_movement.h
@@ -100,7 +100,7 @@ void ObjectEventTurnByLocalIdAndMap(u8, u8, u8, u8);
 const struct ObjectEventGraphicsInfo *GetObjectEventGraphicsInfo(u8 graphicsId);
 void npc_by_local_id_and_map_set_field_1_bit_x20(u8, u8, u8, u8);
 void FreeAndReserveObjectSpritePalettes(void);
-void sub_808E82C(u8, u8, u8, s16, s16);
+void SetObjectEventSpritePosByLocalIdAndMap(u8 localId, u8 mapNum, u8 mapGroup, s16 x, s16 y);
 void sub_808E7E4(u8, u8, u8);
 void sub_808E78C(u8, u8, u8, u8);
 void sub_808E75C(s16, s16);
diff --git a/include/event_scripts.h b/include/event_scripts.h
index 8495b7ee1..3c4380108 100644
--- a/include/event_scripts.h
+++ b/include/event_scripts.h
@@ -372,10 +372,11 @@ extern const u8 SecretBase_Text_Trainer8Defeated[];
 extern const u8 SecretBase_Text_Trainer9Defeated[];
 
 //field effects
-extern const u8 EventScript_FldEffStrength[];
+extern const u8 EventScript_UseStrength[];
 extern const u8 EventScript_FailSweetScent[];
-extern const u8 EventScript_FldEffFlash[];
-extern const u8 EventScript_RockSmashFromPartyMenu[];
+extern const u8 EventScript_UseFlash[];
+extern const u8 EventScript_UseCut[];
+extern const u8 EventScript_UseRockSmash[];
 
 //player pc
 extern const u8 LittlerootTown_BrendansHouse_2F_EventScript_TurnOffPlayerPC[];
diff --git a/include/fldeff.h b/include/fldeff.h
index 99bcdafaf..597ce6f47 100644
--- a/include/fldeff.h
+++ b/include/fldeff.h
@@ -9,18 +9,9 @@ bool8 FldEff_CutGrass(void);
 void FixLongGrassMetatilesWindowTop(s16 x, s16 y);
 void FixLongGrassMetatilesWindowBottom(s16 x, s16 y);
 
-extern const struct SpritePalette gFieldEffectObjectPaletteInfo6;
+extern const struct SpritePalette gSpritePalette_CutGrass;
 extern struct MapPosition gPlayerFacingPosition;
 
-// groundshake
-bool8 sub_81BE66C(void);
-void sub_81BE6AC(void);
-void sub_81BE6B8(void);
-void sub_81BE72C(void);
-void sub_81BE79C(void);
-void sub_81BE7F4(void);
-void sub_81BE994(void);
-
 // escalator
 void StartEscalator(bool8 var);
 void StopEscalator(void);
@@ -39,7 +30,7 @@ bool8 GetMapPairFadeFromType(u8 a1, u8 a2);
 
 // strength
 bool8 SetUpFieldMove_Strength(void);
-bool8 sub_8145E2C(void);
+bool8 FldEff_UseStrength(void);
 
 // sweet scent
 bool8 SetUpFieldMove_SweetScent(void);