Document the overworld animation manager

This documents the `unk_020711EC.c` file, which manages some animations
in the overworld for 2D (e.g. parts of the HM animation) and 3D (e.g.
distortion world's rocks and flowers) elements.

This was supposedly initially used to animate positions, although this
can be (and is being) used to animate other properties as well.

Signed-off-by: Kuruyia <[email protected]>

Author: Kuruyia

include/comm_player_manager.h

@@ -8,17 +8,17 @@
 #include "overlay023/struct_ov23_0224991C_decl.h"
 #include "overlay023/struct_ov23_0224A294_sub1.h"
 #include "overlay023/struct_ov23_0224ABC4.h"
-#include "overlay101/struct_ov101_021D5D90_decl.h"
 
 #include "communication_system.h"
+#include "overworld_anim_manager.h"
 #include "sys_task_manager.h"
 #include "trainer_info.h"
 
 typedef struct CommPlayerManager {
     u32 unk_00;
     UnkStruct_ov23_0224991C *unk_04;
     PlayerAvatar *playerAvatar[MAX_CONNECTED_PLAYERS];
-    UnkStruct_ov101_021D5D90 *unk_28[MAX_CONNECTED_PLAYERS];
+    OverworldAnimManager *unk_28[MAX_CONNECTED_PLAYERS];
     u8 isActive[MAX_CONNECTED_PLAYERS];
     SysTask *task;
     FieldSystem *fieldSystem;

include/functypes/funcptr_02071330.h

@@ -4,13 +4,14 @@
 #include "struct_decls/struct_02061AB4_decl.h"
 
 #include "overlay005/struct_ov5_021DF47C_decl.h"
-#include "overlay101/struct_ov101_021D5D90_decl.h"
+
+#include "overworld_anim_manager.h"
 
 void *BerryPatchGraphicsManager_New(UnkStruct_ov5_021DF47C *renderManager);
 void BerryPatchGraphicsManager_Free(void *manager);
 void BerryPatchGraphics_NewMoistureEffect(MapObject *mapObject);
 void *BerryPatchGraphicsManager_NewEffectCounter(UnkStruct_ov5_021DF47C *renderManager);
 void BerryPatchGraphicsManager_FreeEffectCounter(void *counter);
-UnkStruct_ov101_021D5D90 *BerryPatchGraphics_NewSparkleEffect(MapObject *mapObject);
+OverworldAnimManager *BerryPatchGraphics_NewSparkleEffect(MapObject *mapObject);
 
 #endif // POKEPLATINUM_OV5_021F204C_H

include/functypes/funcptr_02071330_1.h

@@ -12,8 +12,8 @@
 #include "field/field_system_decl.h"
 #include "overlay005/struct_ov5_021DF47C_decl.h"
 #include "overlay005/struct_ov5_021DF84C.h"
-#include "overlay101/struct_ov101_021D5D90_decl.h"
-#include "overlay101/struct_ov101_021D86B0.h"
+
+#include "overworld_anim_manager.h"
 
 UnkStruct_ov5_021DF47C *ov5_021DF440(FieldSystem *fieldSystem, u32 param1, u32 heapID);
 void ov5_021DF47C(UnkStruct_ov5_021DF47C *param0, u32 param1);
@@ -32,8 +32,8 @@ UnkStruct_ov5_021DF47C *ov5_021DF578(const MapObject *param0);
 u32 ov5_021DF5A8(UnkStruct_ov5_021DF47C *param0, u32 param1);
 void ov5_021DF5B4(UnkStruct_ov5_021DF47C *param0, u32 param1, void *param2);
 void *ov5_021DF5C0(UnkStruct_ov5_021DF47C *param0, u32 param1, int param2);
-UnkStruct_ov101_021D5D90 *ov5_021DF72C(const UnkStruct_ov5_021DF47C *param0, const UnkStruct_ov101_021D86B0 *param1, const VecFx32 *param2, int param3, const void *param4, int param5);
-void ov5_021DF74C(UnkStruct_ov101_021D5D90 *param0);
+OverworldAnimManager *ov5_021DF72C(const UnkStruct_ov5_021DF47C *param0, const OverworldAnimManagerFuncs *param1, const VecFx32 *param2, int param3, const void *param4, int param5);
+void ov5_021DF74C(OverworldAnimManager *param0);
 UnkStruct_020216E0 *ov5_021DF7F8(UnkStruct_ov5_021DF47C *param0, const UnkStruct_ov5_021DF84C *param1, const VecFx32 *param2);
 UnkStruct_020216E0 *ov5_021DF84C(UnkStruct_ov5_021DF47C *param0, u32 param1, const VecFx32 *param2);
 UnkStruct_ov5_021DF84C *ov5_021DF864(UnkStruct_ov5_021DF47C *param0, u32 param1, u32 param2, u32 param3, u32 param4, int param5, const UnkStruct_020217F4 *param6);

include/functypes/funcptr_02071330_2.h

@@ -7,14 +7,15 @@
 #include "struct_defs/struct_02073B50.h"
 
 #include "overlay005/struct_ov5_021DF47C_decl.h"
-#include "overlay101/struct_ov101_021D5D90_decl.h"
+
+#include "overworld_anim_manager.h"
 
 void *ov5_021F10E8(UnkStruct_ov5_021DF47C *param0);
 void ov5_021F10FC(void *param0);
 void ov5_021F1188(UnkStruct_ov5_021DF47C *param0, u32 param1);
 void ov5_021F11C0(UnkStruct_ov5_021DF47C *param0, u32 param1, u32 param2);
 UnkStruct_02073B50 *ov5_021F11FC(UnkStruct_ov5_021DF47C *param0, u32 param1);
-UnkStruct_ov101_021D5D90 *ov5_021F121C(const MapObject *param0, const VecFx32 *param1);
+OverworldAnimManager *ov5_021F121C(const MapObject *param0, const VecFx32 *param1);
 void FieldEffect_InitRenderObject(UnkStruct_ov5_021DF47C *param0);
 
 #endif // POKEPLATINUM_OV5_021F10E8_H