Sector Z, Fortuna & General Docs (#261)

* Sector Z Docs initial

* Sector Z docs

* some other things

* correction

* Space Junk

* SectorZ_SetLevelObjects

* rename assets with correct prefix

* aSzBackgroundTex

* details

* pr review

* Sector X initials

* Meteo Initials

* Sector X things I forgot

* fox_tr360 & fox_ve1 & fox_so initials

* fox_so details

* Zones initials

* More Zones initials

* more zones initials

* area 6 initials

* fortuna inits

* fortuna actors

* some more docs

* more docs for Fortuna

* fix mistake in data incorrectly imported

* Fortuna Radars

* BossFO

* Sector Y Initials

* Venom 2 general Docs

* Some Corneria Docs

* Actor, Scenery and Boss IDs in update and draw functions of gObjectInfo

* more docs and this usage

* fox_360 this usage

* more actor types and this usages

* fox_effect type usage

* training docs

* some Sector X docs

* fix incorrect usage of "this"

* fix comment

* more docs

* funcNames

* fox_bg spacing

* boolean

* scenery corneria bumbs

* terrain bumps

* corneria arch

* more corneria objects

* hitboxes

* more corneria objects

* more corneria level objects

* more corneria objects

* aCoWaterfallDL

* corneria docs

* more corneria docs

* Granga swork start

* corneria swork

* Corneria

* Corneria Granga docs

* more granga docs

* granga work buffer enum

* CarrierParts enum use

* option

* Corneria Docs

* GRANGA_FWK

* fox_co.h header

* fix Fault_FillRectangle typo

* PR reviews

* sCsTeamInitialPos

* Doodad
This commit is contained in:
Alejandro Asenjo Nitti
2024-07-06 09:47:49 -03:00
committed by GitHub
parent 24e316a2b2
commit c348962cab
75 changed files with 14011 additions and 12859 deletions
+120 -119
View File
@@ -25,7 +25,7 @@ void ActorAllRange_SetShadowData(Actor* this);
void ActorAllRange_SpawnTeam(void);
void ActorAllRange_PlayMessage(u16* msg, RadioCharacterId character);
void ActorAllRange_UpdateStarWolfEvents(Actor*);
void ActorAllRange_UpdateEvemyEvents(Actor*);
void ActorAllRange_UpdateEnemyEvents(Actor*);
void ActorAllRange_ApplyDamage(Actor*);
bool func_360_80031900(Actor*);
void ActorAllRange_Update(Actor* this);
@@ -50,7 +50,7 @@ void Background_dummy_80040CDC(void);
void Background_DrawGround(void);
// fox_boss
void Boss_AwardBonus(Boss* boss);
void Boss_AwardBonus(Boss* this);
void Boss299_Init(Boss* boss);
void Boss299_Update(Boss* boss);
void Boss299_Draw(Boss* boss);
@@ -92,10 +92,10 @@ void func_display_80057814(Player*);
void Play_Draw(void);
// fox_edata
void func_edata_800594F0(Scenery*);
void func_edata_800595D0(Scenery*);
void Scenery48_Draw(Scenery*);
void Scenery49_Draw(Scenery*);
void Object_ApplyWaterDistortion(void);
void func_edata_800596B0(Actor*);
void Actor289_Draw(Actor*);
// fox_edisplay
void Graphics_SetScaleMtx(f32);
@@ -104,22 +104,22 @@ void Actor201_Draw(Actor*);
void Actor202_Draw(Actor*);
void MeteoTunnel_Draw(Scenery*);
void Scenery_DrawTitaniaBones(Scenery*);
void Scenery42_Draw(Scenery*);
void CoIBeam_Draw(Scenery*);
void Actor196_Draw(Actor*);
void Sprite167_Draw(Sprite*);
void FogShadow_Draw(Sprite*);
void func_edisplay_80059F68(Scenery*);
void func_edisplay_80059FDC(Scenery*);
void CoBuilding9_Draw(Scenery*);
void CoBuilding10_Draw(Scenery*);
void ActorDebris_Draw(Actor*);
void Actor_DrawEngineAndContrails(Actor*);
void Actor_DrawEngineGlow(Actor*, s32);
void func_edisplay_8005B388(Actor*);
void func_edisplay_8005B6A4(Actor*);
void func_edisplay_8005B71C(Actor*);
void func_edisplay_8005B7CC(Actor*);
void func_edisplay_8005B848(Actor*);
void func_edisplay_8005B9A4(Actor*);
void func_edisplay_8005BA30(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 ItemCheckpoint_Draw(Item*);
void ItemSilverRing_Draw(Item*);
void ItemSilverStar_Draw(Item*);
@@ -160,20 +160,20 @@ void func_enmy_80062C38(f32, f32);
bool Object_CheckHitboxCollision(Vec3f* pos, f32* hitboxData, Object* obj, f32 xRot, f32 yRot, f32 zRot);
bool Object_CheckSingleHitbox(Vec3f*, f32*, Vec3f*);
bool Object_CheckPolyCollision(Vec3f* , Vec3f* , ObjectId , Object* );
s32 Object_CheckCollision(s32 , Vec3f* , Vec3f* , s32 );
s32 Object_CheckCollision(s32 index, Vec3f* pos, Vec3f* vel, s32 mode);
void Scenery_UpdateTitaniaBones(Scenery*);
void func_enmy_800654E4(Object*);
void func_enmy_800656D4(Actor*);
void Actors190_191_Update(Actor*);
void func_enmy_800660F0(Actor*);
void Actor_Despawn(Actor*);
void func_enmy_8006654C(Actor*);
void Actor192_Update(Actor*);
void func_enmy_8006684C(Actor*);
void func_enmy_800669A0(Actor*);
void func_enmy_80066A80(Actor*);
void Actor193_Update(Actor*);
void Actor180_Update(Actor*);
void func_enmy_80066C00(Scenery*);
void func_enmy_80066D5C(Scenery*);
void CoBuilding9_Update(Scenery*);
void Sprite167_Update(Sprite*);
void func_enmy_80066EA8(Scenery*);
void SceneryRotateTowardsCamera(Scenery*);
void Item_CheckBounds(Item*);
void Item_SpinPickup(Item*);
void Actor_SpawnDebris70(f32, f32, f32, f32, f32, f32, f32, f32);
@@ -212,18 +212,19 @@ void Object_Update(void);
//fox_enmy2
void Actor237_Update(Actor*);
void Actor237_Draw(Actor*);
void Scenery54_Update(Scenery*);
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 Scenery42_Update(Scenery*);
void CoIBeam_Update(Scenery*);
void Actor196_Update(Actor*);
void ActorDebris_Update(Actor*);
void MeteoTunnel_Update(Scenery*);
void Actor_SetupPlayerShot(PlayerShotId, PlayerShot*, s32, f32, f32, f32, f32, f32, f32, f32, f32, f32);
void Actor_SpawnPlayerLaser(s32, f32, f32, f32, f32, f32, f32, f32, f32, f32);
void Actor_SpawnPlayerLaser(s32 actorId, f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 xRot, f32 yRot,
f32 zRot);
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);
@@ -243,78 +244,78 @@ 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);
void func_effect_80077A00(Effect* );
void func_effect_80077A7C(Effect* );
void func_effect_80077B78(Effect* );
void func_effect_80077B84(Effect* );
void func_effect_80078038(Effect* );
void func_effect_800780F8(Effect* );
void func_effect_800783C0(Effect* );
void func_effect_80078438(Effect* );
void func_effect_800784B4(Effect* );
void func_effect_80078550(Effect* );
void func_effect_80078604(Effect* );
void func_effect_8007868C(Effect* );
void func_effect_8007879C(Effect* );
void func_effect_800788B0(Effect* );
void func_effect_80078A64(Effect* );
void func_effect_80078AEC(Effect* );
void func_effect_80078B8C(Effect*);
void func_effect_80078BE0(Effect* );
void func_effect_80078C84(Effect* );
void func_effect_80078CE8(Effect* );
void Effect_Effect372_Draw(Effect* );
void Effect_Effect382_Draw(Effect* );
void Effect_Effect388_Draw(Effect* );
void Effect_Effect384_Draw(Effect* );
void Effect_Effect385_Draw(Effect* );
void Effect_Effect389_Draw(Effect* );
void Effect_Effect347_Draw(Effect* );
void Effect_Effect351_Draw(Effect* );
void Effect_Clouds_Draw(Effect* );
void Effect_Effect366_Draw(Effect* );
void Effect_Effect367_Draw(Effect* );
void Effect_Effect344_Draw(Effect* );
void Effect_Effect345_Draw(Effect* );
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_Effect356_Draw(Effect* );
void Macbeth_Effect376_Draw(Effect* );
void func_effect_80078E50(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
void func_effect_80078EBC(Effect* );
void func_effect_80078F78(Effect* );
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 func_effect_80079618(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
void func_effect_8007968C(Effect*);
void func_effect_800798F0(Effect* );
void func_effect_8007A28C(Effect* );
void func_effect_8007A3C0(Effect* );
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 func_effect_8007A5F8(Effect* , Vec3f* pos, u32 sfxId);
void func_effect_8007A6F0(Vec3f* pos, s32 sfxId);
void func_effect_8007A748(Effect*);
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 func_effect_8007A994(Effect*);
void func_effect_8007AA60(Effect*);
void func_effect_8007AB50(Effect*);
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 func_effect_8007B040(Effect*);
void func_effect_8007B0F4(Effect*);
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 func_effect_8007B3B8(Effect*);
void Effect_Effect384_Update(Effect*);
void func_effect_8007B550(f32 xPos, f32 yPos, f32 zPos, f32 scale1, s32 );
void func_effect_8007B5C0(Effect*);
void func_effect_8007B62C(Effect*);
void func_effect_8007B670(Effect*);
void func_effect_8007B67C(Effect*);
void func_effect_8007B758(Effect*);
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 func_effect_8007B960(Effect*);
void Effect_Effect364_Update(Effect*);
void func_effect_8007BC7C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
void func_effect_8007BCE8(Effect*);
void func_effect_8007B9DC(Effect*);
void func_effect_8007BDE0(Effect*);
void func_effect_8007BE54(Effect*);
void func_effect_8007BEE8(Effect*);
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 func_effect_8007C250(Effect*);
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 func_effect_8007C50C(Effect*);
void Effect_Effect390_Update(Effect*);
void func_effect_8007C688(f32 xPos, f32 yPos, f32 zPos, f32 scale2, s32 timer50);
void func_effect_8007C8C4(Effect*);
void Effect_Effect387_Update(Effect*);
void func_effect_8007C85C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
void func_effect_8007C9E0(Effect*);
void func_effect_8007CAF0(Effect*);
void Effect_Effect343_Update(Effect*);
void Effect_Effect343_Draw(Effect*);
void func_effect_8007CF30(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);
@@ -322,54 +323,54 @@ 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 func_effect_8007D24C(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
void func_effect_8007D2C8(f32 xPos, f32 yPos, f32 zPos, f32 scale2);
void func_effect_8007D2F4(Effect*);
void func_effect_8007D55C(Effect*);
void func_effect_8007D748(Effect*);
void func_effect_8007D8A8(Effect*);
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 func_effect_8007DA58(Effect*);
void func_effect_8007DAE4(Effect*);
void func_effect_8007DB70(Effect*);
void func_effect_8007DED4(Effect*);
void func_effect_8007E014(Effect*);
void func_effect_8007E258(Effect*);
void func_effect_8007E298(Effect*);
void func_effect_8007E330(Effect*);
void func_effect_8007E3E4(Effect*);
void func_effect_8007E45C(Effect*);
void func_effect_8007E5CC(Effect*);
void func_effect_8007E648(Effect*);
void func_effect_8007E93C(Effect* effect, u32 objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
void Effect_Effect375_Update(Effect*);
void Macbeth_Effect375_Draw(Effect*);
void Effect_Effect374_Update(Effect*);
void Macbeth_Effect374_Draw(Effect*);
void Effect_Effect344_Update(Effect*);
void Effect_Effect345_Update(Effect*);
void Effect_Effect342_Update(Effect*);
void Effect_Effect342_Draw(Effect*);
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 func_effect_8007F11C(ObjectId objId, f32 xPos, f32 yPos, f32 zPos, f32 speed);
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 func_effect_8007F438(Effect*);
void func_effect_8007F6B0(Effect*);
void func_effect_8007F958(Effect*);
void func_effect_8007FBE0(Effect*);
void func_effect_8007FE88(Effect*);
void Effect_Effect346_Update(Effect*);
void Effect_Effect348_Update(Effect*);
void Effect_Effect349_Update(Effect*);
void Effect_Effect350_Update(Effect*);
void Effect_Effect353_354_Update(Effect*);
bool func_effect_8007FD84(Effect*);
void func_effect_800802B8(Effect*);
void func_effect_800802D8(Effect*);
void func_effect_800802F8(Effect*);
void func_effect_80080360(Effect*);
void func_effect_8008040C(Effect*);
void func_effect_8008092C(Effect*);
void func_effect_80080ACC(Effect*);
void func_effect_80080D04(Effect*);
void Effect_Effect355_Update(Effect*);
void Effect_Effect377_Update(Effect*);
void Effect_Effect356_Update(Effect*);
void Effect_Effect376_Update(Effect*);
void Effect_Effect398_Update(Effect*);
void Effect_Effect398_Draw(Effect*);
void Effect_Effect394_Update(Effect*);
void Effect_Effect394_Draw(Effect*);
void func_effect_800815DC(void);
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 func_effect_80081C5C(Effect*);
void func_effect_80082F78(Effect*);
void Effect_Effect395_Update(Effect*);
void Effect_Effect395_Draw(Effect*);
void func_effect_8008377C(f32, f32, f32, f32, f32);
void func_effect_800837EC(Effect*);
void func_effect_80083B8C(Effect*);
void func_effect_80083C70(Effect* effect, f32 xPos, f32 yPos, f32 zPos, f32 xVel, f32 yVel, f32 zVel, f32 arg7, s32 arg8);
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 func_effect_80083D2C(f32 xPos, f32 yPos, f32 zPos, f32 srcZ);
void func_effect_80083FA8(Effect*);
void func_effect_80084194(Effect*);
void Effect_Effect399_Update(Effect*);
void Effect_Effect399_Draw(Effect*);
// fox_fade
void Wipe_Draw(WipeMode mode, s32 frame);
@@ -385,7 +386,7 @@ void func_hud_80087530(f32, f32, s32);
void func_hud_800884E4(void);
void func_hud_80088564(void);
void HUD_DrawStatusScreens(void);
s32 func_hud_8008AC54(s32);
s32 Hud_MissileSeekModeCheck(s32);
void func_hud_8008AD94(void);
void func_hud_8008B5B0(f32 x, f32 y);
s32 func_hud_8008B774(void);
@@ -419,8 +420,8 @@ void func_hud_800953A0(Actor*, s32);
void func_hud_8009546C(Actor*, s32);
void func_hud_80095538(Actor*, s32);
void HUD_AquasComplete(Player*);
void func_hud_80094954(Effect*);
void func_hud_80094BBC(Effect*);
void Hud_Effect363_Update(Effect*);
void Hud_Effect363_Draw(Effect*);
void func_hud_80094D20(f32, f32);
void func_hud_80096A74(Player* player);
@@ -465,12 +466,12 @@ void Player_UpdateArwingRoll(Player*);
void Player_ArwingBoost(Player*);
void Camera_UpdateArwingOnRails(Player*);
void Camera_UpdateCockpitOnRails(Player*, s32);
void Camera_FollowPlayer(Player*, s32 , bool );
void Camera_UpdateArwing360(Player*, s32);
void Camera_FollowPlayer(Player*, s32 , bool);
void Camera_UpdateArwing360(Player*, bool);
void Camera_UpdateTank360(Player*, s32 );
void Camera_UpdateOnFoot360(Player*, s32 );
void Camera_SetStarfieldPos(f32, f32, f32, f32, f32, f32);
void Camera_Update360(Player*, s32);
void Camera_Update360(Player*, bool);
void Camera_SetupLights(Player*);
void Play_SpawnVsItem(ObjectId , Item*);
void Play_Main(void);