Additional documentation for event actors (#285)

* Torch? * docs * format
sonicdcer · Jan 24, 2025 · 83c46a6 · 83c46a6
1 parent 4a7012d
commit 83c46a6
Show file tree

Hide file tree

Showing 42 changed files with 1,908 additions and 1,881 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -151,7 +151,8 @@
     "prevent_bss_reordering3.h": "c",
     "ast_a_ti.h": "c",
     "fox_co.h": "c",
-    "ast_map.h": "c"
+    "ast_map.h": "c",
+    "ast_radio.h": "c"
   },
   "C_Cpp_Runner.msvcBatchPath": ""
 }
diff --git a/include/functions.h b/include/functions.h
@@ -180,7 +180,7 @@ void Item_SpinPickup(Item*);
 void Actor_SpawnDebris70(f32, f32, f32, f32, f32, f32, f32, f32);
 void ActorSupplies_Update(Actor*);
 void ActorSupplies_Draw(Actor*);
-void func_enmy_80067A40(void);
+void Player_RepairWings(void);
 void Item1up_Update(Item*);
 void ItemPickup_Update(Item*);
 void ItemLasers_Update(Item*);
@@ -229,11 +229,11 @@ void Actor_SpawnPlayerLaser(s32 actorId, f32 xPos, f32 yPos, f32 zPos, f32 xVel,
 void Actor_SpawnGreatFoxLaser(s32 actorId, f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 xRot, f32 yRot,
                    f32 zRot);
 void ActorEvent_SpawnEffect347(f32 xPos, f32 yPos, f32 zPos, f32 scale1);
-void ActorEvent_8006F254(Actor*);
+void ActorEvent_ShootForward(Actor*);
 void ActorEvent_Update(Actor*);
 s32 SyShipDebris_Draw(Scenery*);
 void ActorEvent_Draw(Actor*);
-void func_enmy2_800763A4(Actor*);
+void Actor_DyingCrash(Actor*);
 void ActorEvent_Dying(Actor*);
 void TiGreatFox_Update(Actor*);
 void TiGreatFox_Draw(Actor*);
@@ -281,7 +281,7 @@ void Effect_SetupTimedSfxAtPos(Effect* , Vec3f* pos, u32 sfxId);
 void Effect_SpawnTimedSfxAtPos(Vec3f* pos, s32 sfxId);
 void Effect_TimedSfx_Update(Effect*);
 bool func_effect_8007A774(Player*, Effect*, f32);
-void Effect_Effect359_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1, u8, u8, u16);
+void Effect_Effect359_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1, u8 alpha, u8, u16);
 void Effect_Effect359_Update(Effect359*);
 void Effect_Effect359_Draw(Effect*);
 void Effect_Effect372_Update(Effect*);
@@ -293,7 +293,7 @@ void Effect_Effect381_Update(Effect*);
 void Effect_Effect381_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1);
 void Effect_Effect384_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1, s32 );
 void Effect_Effect384_Update(Effect*);
-void Effect_Effect385_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1, s32 );
+void Effect_Effect385_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1, s32 alpha);
 void Effect_Effect385_Update(Effect*);
 void Effect_Clouds_Update(Effect*);
 void Effect_Effect388_Update(Effect*);
@@ -341,11 +341,11 @@ void Effect_Effect351_Update(Effect*);
 void Effect_Effect365_Update(Effect*);
 void Effect_Effect365_Draw(Effect*);
 void Effect_Effect367_Update(Effect*);
-void func_effect_8007E93C(Effect* this, u32 objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
-void func_effect_8007EE68(ObjectId objId, Vec3f* pos, Vec3f* rot, Vec3f* arg3, Vec3f* arg4, f32 scale2);
-void func_effect_8007F04C(ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 xRot, f32 yRot, f32 zRot, f32 unkX, f32 unkY, f32 unkZ, f32 xVel, f32 yVel, f32 zVel, f32 scale2);
-void Effect_EnemyLaser(ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
-void func_effect_8007F20C(ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
+void Effect_SetupShootAtCamera(Effect* this, ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
+void Effect_SpawnById1(ObjectId objId, Vec3f* pos, Vec3f* rot, Vec3f* arg3, Vec3f* arg4, f32 scale2);
+void Effect_SpawnById2(ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 xRot, f32 yRot, f32 zRot, f32 unkX, f32 unkY, f32 unkZ, f32 xVel, f32 yVel, f32 zVel, f32 scale2);
+void Effect_ShootAtPlayer(ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
+void Effect_ShootAtCamera(ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
 void Effect_Effect346_Update(Effect*);
 void Effect_Effect348_Update(Effect*);
 void Effect_Effect349_Update(Effect*);
@@ -368,7 +368,7 @@ void Effect_Effect395_Draw(Effect*);
 void Effect_Effect391_Spawn(f32, f32, f32, f32, f32);
 void Effect_Effect391_Update(Effect*);
 void Effect_Effect391_Draw(Effect*);
-void Effect_Effect399_Setup(Effect* this, f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 arg7, s32 arg8);
+void Effect_Effect399_Setup(Effect* this, f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 arg7, s32 alpha);
 void func_effect_80083D2C(f32 xPos, f32 yPos, f32 zPos, f32 srcZ);
 void Effect_Effect399_Update(Effect*);
 void Effect_Effect399_Draw(Effect*);

diff --git a/include/i5.h b/include/i5.h
@@ -52,7 +52,7 @@ void Macbeth_ShortTrainObjects(void);
 void Ground_801B5110(f32, f32, f32);
 void Ground_801B58AC(Gfx **, f32);
 bool Ground_801B6AEC(f32, f32, f32);
-s32 Ground_801B6E20(f32, f32, f32 *, f32 *, f32 *);
+bool Ground_801B6E20(f32, f32, f32 *, f32 *, f32 *);
 void Macbeth_801AD144(PlayerShot*);
 void Titania_Effect368_Spawn(f32, f32, f32, f32, f32);
 bool Macbeth_801A3C20(f32);