General docs (#269)

* fox_display.c DOCS

* PRINTF

* actor->destroy boolean

* corneria docs

* Boss->unk_04C to Boss->animFrame

* aCoGrangaWalkingAnim

* more corneria docs

* Spawner

* Spawner code refined

* Spawner description

* Actor Spawn guard

* Molar Rock (name by @inspectredc)

* more docs

* actor docs

* initial disassembly config for lodgenet

* correct vram addresses for lodgenet

* Actor Docs

* More actor docs

* more actor docs

* correction

* correction

* more actor docs

* Preliminary work for Effect documentation

* Change Init for Setup

* fox_play cleanup and defake

* fox_zo function names

* fox_so function renaming

* more object docs

* venom 1 actors

* actor docs

* some fox_bo docs

* some fox_fo corrections

* fox_ma obj->this

* fox_ma renamings

* fox_ma docs

* fox_ti Actors

* revert permuter settings to ido

* some renames on fox_andross.c

* fox_sy actors

* object names

* corrections

* some effect comments

* fix AudioTable struct and data to avoid UB

* uintptr_t in audio

* audio load changes

* event id enum usage in fox_sy

* clear padding in sPlaylists

* HUD_FoBase_ExplodeCs

* HUD

1 files changed, 71 insertions, 71 deletions

diff --git a/include/functions.h b/include/functions.h
index e0c9f879..62f1efcc 100644
--- a/include/functions.h
+++ b/include/functions.h
@@ -10,14 +10,14 @@
 void AllRange_FortunaIntro(Player*);
 void AllRange_GetStarWolfHits(Actor*);
 void AllRange_DrawCountdown(void);
-void Boss309_Update(Boss*);
-void Boss309_Draw(Boss*);
-void Boss310_Update(Boss*);
-void Boss310_Draw(Boss*);
-void Actor271_Update(Actor*);
-void Actor271_Draw(Actor*);
-void Actor272_Update(Actor*);
-void Actor272_Draw(Actor*);
+void BoBase_Update(Boss*);
+void BoBase_Draw(Boss*);
+void BoBaseShield_Update(Boss*);
+void BoBaseShield_Draw(Boss*);
+void BoShieldReactor_Update(Actor*);
+void BoShieldReactor_Draw(Actor*);
+void BoLaserCannon_Update(Actor*);
+void BoLaserCannon_Draw(Actor*);
 bool AllRange_PlayMessage(u16*, RadioCharacterId);
 void AllRange_GreatFoxRepair(Player*);
 void AllRange_ClearRadio(void);
@@ -86,26 +86,26 @@ void ActorCutscene_Draw(Actor*);
 void Cutscene_DrawGreatFox(void);
 
 // fox_display
-void func_display_80053658(WingInfo*);
-void Play_DrawEngineGlow(s32);
-void func_display_80057814(Player*);
-void Play_Draw(void);
+void Display_ArwingWings(WingInfo*);
+void Display_DrawEngineGlow(s32);
+void Display_SetupPlayerSfxPos(Player*);
+void Display_Update(void);
 
 // fox_edata
-void Scenery48_Draw(Scenery*);
-void Scenery49_Draw(Scenery*);
+void Ve1SceneryWall1_Draw(Scenery*);
+void Ve1SceneryWall2_Draw(Scenery*);
 void Object_ApplyWaterDistortion(void);
-void Actor289_Draw(Actor*);
+void AndJamesTrigger_Draw(Actor*);
 
 // fox_edisplay
 void Graphics_SetScaleMtx(f32);
 void Sprite168_Draw(Sprite*);
-void Actor201_Draw(Actor*);
-void Actor202_Draw(Actor*);
+void MeteoBall_Draw(Actor*);
+void ActorHopBot_Draw(Actor*);
 void MeteoTunnel_Draw(Scenery*);
 void Scenery_DrawTitaniaBones(Scenery*);
 void CoIBeam_Draw(Scenery*);
-void Actor196_Draw(Actor*);
+void ActorMoleMissile_Draw(ActorMoleMissile*);
 void Sprite167_Draw(Sprite*);
 void FogShadow_Draw(Sprite*);
 void CoBuilding9_Draw(Scenery*);
@@ -114,12 +114,12 @@ void ActorDebris_Draw(Actor*);
 void Actor_DrawEngineAndContrails(Actor*);
 void Actor_DrawEngineGlow(Actor*, s32);
 void func_edisplay_8005B388(Actor*);
-void Actor180_Draw(Actor*);
-void Actor182_Draw(Actor*);
-void Actor186_Draw(Actor*);
-void Actor190_191_Draw(Actor*);
-void Actor192_Draw(Actor*);
-void Actor193_Draw(Actor*);
+void MeMolarRock_Draw(Actor*);
+void MeMeteor2_Draw(MeMeteor2*);
+void MeLaserCannon1_Draw(MeLaserCannon1*);
+void ActorMissileSeek_Draw(Actor*);
+void ActorSkibot_Draw(ActorSkibot*);
+void ActorRadar_Draw(CoRadar*);
 void ItemCheckpoint_Draw(Item*);
 void ItemSilverRing_Draw(Item*);
 void ItemSilverStar_Draw(Item*);
@@ -163,13 +163,13 @@ bool Object_CheckPolyCollision(Vec3f* , Vec3f* , ObjectId , Object* );
 s32 Object_CheckCollision(s32 index, Vec3f* pos, Vec3f* vel, s32 mode);
 void Scenery_UpdateTitaniaBones(Scenery*);
 void func_enmy_800654E4(Object*);
-void Actors190_191_Update(Actor*);
+void ActorMissileSeek_Update(Actor*);
 void func_enmy_800660F0(Actor*);
 void Actor_Despawn(Actor*);
-void Actor192_Update(Actor*);
+void ActorSkibot_Update(ActorSkibot*);
 void func_enmy_8006684C(Actor*);
-void Actor193_Update(Actor*);
-void Actor180_Update(Actor*);
+void ActorRadar_Update(CoRadar*);
+void MeMolarRock_Update(Actor*);
 void func_enmy_80066C00(Scenery*);
 void CoBuilding9_Update(Scenery*);
 void Sprite167_Update(Sprite*);
@@ -213,13 +213,13 @@ void Object_Update(void);
 void Actor237_Update(Actor*);
 void Actor237_Draw(Actor*);
 void CoWaterfall_Update(Scenery*);
-void Actor201_Update(Actor*);
-void Actor202_Update(Actor*);
-void Actor194_Update(Actor*);
-void Actor194_Dying(Actor*);
-void Actor194_Draw(Actor*);
+void MeteoBall_Update(Actor*);
+void ActorHopBot_Update(Actor*);
+void MeMora_Update(Actor*);
+void MeMora_Dying(Actor*);
+void MeMora_Draw(Actor*);
 void CoIBeam_Update(Scenery*);
-void Actor196_Update(Actor*);
+void ActorMoleMissile_Update(ActorMoleMissile*);
 void ActorDebris_Update(Actor*);
 void MeteoTunnel_Update(Scenery*);
 void Actor_SetupPlayerShot(PlayerShotId, PlayerShot*, s32, f32, f32, f32, f32, f32, f32, f32, f32, f32);
@@ -234,16 +234,16 @@ s32 Scenery111_Draw(Scenery*);
 void ActorEvent_Draw(Actor*);
 void func_enmy2_800763A4(Actor*);
 void ActorEvent_Dying(Actor*);
-void Actor234_Update(Actor*);
-void Actor234_Draw(Actor*);
+void TiGreatFox_Update(Actor*);
+void TiGreatFox_Draw(Actor*);
 
 // fox_effect
 s32 func_effect_80081B24(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 s32 BonusText_Display(f32 xPos, f32 yPos, f32 zPos, s32 hits);
 void BonusText_Update(void);
 void BonusText_DrawAll(void);
-Effect* func_effect_8007783C(ObjectId objId);
-void func_effect_8007797C(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2);
+Effect* Effect_Load(ObjectId objId);
+void Effect_FireSmoke_Spawn2(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2);
 void Effect_Effect372_Draw(Effect* );
 void Effect_Effect382_Draw(Effect* );
 void Effect_Effect388_Draw(Effect* );
@@ -261,77 +261,77 @@ void Effect_Effect346_Draw(Effect* );
 void Effect_Effect348_Draw(Effect* );
 void Effect_Effect355_Draw(Effect* );
 void Effect_Effect353_Draw(Effect*);
-void Macbeth_Effect377_Draw(Effect* );
+void Effect_Effect377_Draw(Effect* );
 void Effect_Effect356_Draw(Effect* );
-void Macbeth_Effect376_Draw(Effect* );
-void func_effect_80078E50(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect376_Draw(Effect* );
+void Effect_Effect393_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void Effect_Effect393_Update(Effect* );
 void Effect_Effect393_Draw(Effect* );
-void func_effect_800794CC(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
-void func_effect_8007953C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
-void func_effect_800795AC(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect357_Spawn50(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect357_Spawn80(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect357_Spawn95(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void func_effect_80079618(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void Effect_Effect357_Update(Effect*);
 void Effect_Effect357_Draw(Effect* );
 void Effect_Effect383_Update(Effect* );
 void Effect_Effect383_Draw(Effect* );
-void func_effect_8007A568(f32 xPos, f32 yPos, f32 zPos, f32 scale1);
+void Effect_Effect383_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1);
 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 func_effect_8007A900(f32 xPos, f32 yPos, f32 zPos, f32 scale1, u8, u8, u16);
+void Effect_Effect359_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1, u8, u8, u16);
 void Effect_Effect359_Update(Effect359*);
 void Effect_Effect359_Draw(Effect*);
 void Effect_Effect372_Update(Effect*);
-void func_effect_8007ACE0(f32 xPos, f32 yPos, f32 zPos, f32 scale2, f32 scale1, f32 yRot);
-void func_effect_8007ADF4(f32 xPos, f32 yPos, f32 zPos, f32 scale2, f32 scale1);
-void func_effect_8007AFD0(f32 xPos, f32 zPos, f32 xVel, f32 zVel, f32 scale1);
+void Effect_Effect372_Spawn1(f32 xPos, f32 yPos, f32 zPos, f32 scale2, f32 scale1, f32 yRot);
+void Effect_Effect372_Spawn2(f32 xPos, f32 yPos, f32 zPos, f32 scale2, f32 scale1);
+void Effect_Effect382_Spawn(f32 xPos, f32 zPos, f32 xVel, f32 zVel, f32 scale1);
 void Effect_Effect382_Update(Effect*);
 void Effect_Effect381_Update(Effect*);
-void func_effect_8007B228(f32 xPos, f32 yPos, f32 zPos, f32 scale1);
-void func_effect_8007B344(f32 xPos, f32 yPos, f32 zPos, f32 scale1, s32 );
+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 func_effect_8007B550(f32 xPos, f32 yPos, f32 zPos, f32 scale1, s32 );
+void Effect_Effect385_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale1, s32 );
 void Effect_Effect385_Update(Effect*);
 void Effect_Clouds_Update(Effect*);
 void Effect_Effect388_Update(Effect*);
 void Effect_Effect389_Update(Effect*);
 void Effect_Effect347_Update(Effect*);
-void func_effect_8007B8F8(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect364_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void Effect_Effect364_Update(Effect*);
-void func_effect_8007BC7C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect362_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void Effect_Effect362_Update(Effect*);
 void Effect_Effect364_Draw(Effect*);
 void Effect_Effect361_Update(Effect*);
 void Effect_Effect360_Update(Effect*);
 void Effect_Effect360_361_362_Draw(Effect*);
-void func_effect_8007BFFC(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2, s32 timer50);
-void func_effect_8007C120(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2, s32 timer50);
+void Effect386_Spawn1(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2, s32 timer50);
+void Effect_Effect390_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2, s32 timer50);
 void Effect_Effect386_Update(Effect*);
-void func_effect_8007C484(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2, s32 arg7);
+void Effect_Effect389_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 scale2, s32 arg7);
 void Effect_Effect390_Update(Effect*);
-void func_effect_8007C688(f32 xPos, f32 yPos, f32 zPos, f32 scale2, s32 timer50);
+void Effect_Effect387_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2, s32 timer50);
 void Effect_Effect387_Update(Effect*);
-void func_effect_8007C85C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect343_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void Effect_Effect343_Update(Effect*);
 void Effect_Effect343_Draw(Effect*);
-void func_effect_8007CF30(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_FireSmoke_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void func_effect_8007D074(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void func_effect_8007D0E0(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void func_effect_8007D10C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
-void func_effect_8007D1E0(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
+void Effect_Effect341_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void func_effect_8007D24C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void func_effect_8007D2C8(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
 void Effect_Effect339_Update(Effect*);
 void Effect_FireSmoke_Draw(Effect*);
 void Effect_Effect340_Update(Effect*);
 void Effect_Effect341_Update(Effect*);
-void func_effect_8007D9DC(f32 xPos, f32 yPos, f32 zPos, f32 scale2, f32 scale1, s32 timer50);
+void Effect_Effect367_Spawn(f32 xPos, f32 yPos, f32 zPos, f32 scale2, f32 scale1, s32 timer50);
 void Effect_Effect375_Update(Effect*);
-void Macbeth_Effect375_Draw(Effect*);
+void Effect_Effect375_Draw(Effect*);
 void Effect_Effect374_Update(Effect*);
-void Macbeth_Effect374_Draw(Effect*);
+void Effect_Effect374_Draw(Effect*);
 void Effect_Effect344_Update(Effect*);
 void Effect_Effect345_Update(Effect*);
 void Effect_Effect342_Update(Effect*);
@@ -364,10 +364,10 @@ void func_effect_80081A8C(f32 xPos, f32 yPos, f32 zPos, f32 scale2, s32 arg4);
 void func_effect_80081BEC(f32 xPos, f32 yPos, f32 zPos, f32 scale2, s32 arg4);
 void Effect_Effect395_Update(Effect*);
 void Effect_Effect395_Draw(Effect*);
-void func_effect_8008377C(f32, f32, f32, f32, f32);
+void Effect_Effect391_Spawn(f32, f32, f32, f32, f32);
 void Effect_Effect391_Update(Effect*);
 void Effect_Effect391_Draw(Effect*);
-void func_effect_80083C70(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 arg8);
 void func_effect_80083D2C(f32 xPos, f32 yPos, f32 zPos, f32 srcZ);
 void Effect_Effect399_Update(Effect*);
 void Effect_Effect399_Draw(Effect*);
@@ -386,8 +386,8 @@ void func_hud_80087530(f32, f32, s32);
 void func_hud_800884E4(void);
 void func_hud_80088564(void);
 void HUD_DrawStatusScreens(void);
-s32 Hud_MissileSeekModeCheck(s32);
-void func_hud_8008AD94(void);
+s32 ActorMissileSeek_ModeCheck(s32);
+void HUD_RadioCharacterName_Draw(void);
 void func_hud_8008B5B0(f32 x, f32 y);
 s32 func_hud_8008B774(void);
 void func_hud_8008BD00(u8*, s32, s32, u8);
@@ -404,11 +404,11 @@ void HUD_DrawCountdown(s32* , f32);
 void func_hud_8008E9EC(f32, f32);
 void func_hud_8008EA14(f32, f32);
 void HUD_Draw(void);
-void HUD_BossFO_Draw(Boss*);
+void HUD_FoBase_Draw(Boss*);
 void func_hud_8008FFF0(Boss*, s32);
-s32 func_hud_80090200(Boss* boss);
+s32 HUD_FoBase_ExplodeCs(Boss* this);
 bool func_hud_8009092C(Actor*);
-void HUD_BossFO_Update(Boss*);
+void HUD_FoBase_Update(Boss*);
 bool func_hud_800915FC(Actor*);
 bool func_hud_800924E0(Actor*);