Initial Katina documentation (#228)

* initial docs

* func names

* docs

* more docs

* more katina docs

* format

* format

* yRot

* more docs

* more docs

* this

* some fixes

* fixes

* ActorAllRange

* These should not be used here

* corrections

* some renamings

* more docs

* format

* Merge remote-tracking branch 'origin' into fox_ka_docs

* ActorCutscene

* PR review

* comment

* bump torch

* PR review

* review

include/i4.h

@@ -14,7 +14,7 @@ void Bolse_LevelStart(Player*);
 void Bolse_LevelComplete(Player*);
 void Katina_LevelStart(Player*);
 void Katina_LevelComplete(Player*);
-void Katina_80197F10(Actor*);
+void Katina_SFTeamFlyTowardsCamera(Actor*);
 void SectorZ_LevelStart(Player*);
 void SectorZ_LevelComplete(Player*);
 void SectorZ_8019DD20(Actor*);
@@ -25,9 +25,9 @@ void Fortuna_8018BA2C(void);
 void Bolse_UpdateEventHandler(Actor*);
 void Bolse_80191ED8(void);
 void Bolse_DrawDynamicGround(void);
-void Katina_Boss316_Init(Boss *);
+void Katina_BossSetup(Boss *);
 void Katina_UpdateEvents(Actor*);
-void Katina_80198930(void);
+void Katina_BossInit(void);
 void SectorZ_80199900(Actor *, s32);
 void SectorZ_Missile_Update(Actor*);
 void SectorZ_UpdateEvents(Actor*);
@@ -39,12 +39,12 @@ void Bolse_80191054(Effect*);
 void Bolse_80191180(Effect*);
 void Bolse_801912FC(Boss*);
 void Bolse_80191AFC(Boss*);
-void Katina_80192984(Effect*);
-void Katina_80192A68(Effect*);
-void Katina_80193718(Boss*);
-void Katina_80193B1C(Boss*);
-void Katina_801946C4(Boss*);
-void Katina_801968F4(Boss*);
+void Katina_LaserEnergyParticlesUpdate(Effect*);
+void Katina_LaserEnergyParticlesDraw(Effect*);
+void Katina_BaseUpdate(Boss*);
+void Katina_Base_Draw(Boss*);
+void Katina_BossUpdate(Boss*);
+void Katina_BossDraw(Boss*);
 void SectorZ_8019E234(Actor*);
 void SectorZ_8019E3A8(Actor*);
 void SectorZ_8019E454(Boss*);

include/sf64object.h

@@ -652,7 +652,7 @@ typedef enum ObjectId {
   /* 336 */  OBJ_ITEM_GOLD_RING,
   /* 337 */  OBJ_ITEM_WING_REPAIR,
   /* 338 */  OBJ_ITEM_TRAINING_RING,
-  /* 339 */  OBJ_EFFECT_339,
+  /* 339 */  OBJ_EFFECT_FIRE_SMOKE,
   /* 340 */  OBJ_EFFECT_340,
   /* 341 */  OBJ_EFFECT_341,
   /* 342 */  OBJ_EFFECT_342,
@@ -1244,8 +1244,8 @@ typedef Boss Boss312;
 typedef Boss Boss313;
 typedef Boss Boss314;
 typedef Boss BossSO;
-typedef Boss Boss316;
-typedef Boss Boss317;
+typedef Boss Saucerer;
+typedef Boss Frontlinebase;
 typedef Boss BossAQ;
 typedef Boss Boss319;
 typedef Boss Boss320;
@@ -1267,7 +1267,7 @@ typedef Item Item1UP;
 typedef Item ItemGoldRing;
 typedef Item ItemWingRepair;
 typedef Item ItemTrainingRing;
-typedef Effect Effect339;
+typedef Effect EffectFireSmoke;
 typedef Effect Effect340;
 typedef Effect Effect341;
 typedef Effect Effect342;

include/variables.h

@@ -108,7 +108,7 @@ extern u8 gKaAllyKillCount;
 extern s32 gAllRangeCheckpoint;
 extern s32 gAllRangeEventTimer;
 extern s32 gAllRangeCountdown[3];
-extern s32 gShowAllRangeCountdown;
+extern bool gShowAllRangeCountdown;
 extern s32 gAllRangeFrameCount;
 extern f32 gAllRangeCountdownScale;