From 1666517f47f5f3b694578b9e5580926043b12676 Mon Sep 17 00:00:00 2001
From: blackgamma7 <blackgamma7@gmail.com>
Date: Fri, 18 Nov 2022 08:24:27 -0500
Subject: [PATCH] z_shot_sun: minor doc (#1429)

* z_shot_sun: minor doc

document one field and function remaining in z_shot_sun

* z_shot_sun: updated state doc'ing

* Update z_shot_sun.c

format enum

* ran format.py

* `z_shot_sun`: changes based on feedback

gave enum better name, removed redundant comment.

* Update z_shot_sun.c

enum changed.
---
 src/overlays/actors/ovl_Shot_Sun/z_shot_sun.c | 30 +++++++++++--------
 src/overlays/actors/ovl_Shot_Sun/z_shot_sun.h |  2 +-
 2 files changed, 19 insertions(+), 13 deletions(-)

diff --git a/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.c b/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.c
index fcde28815c..29761f631a 100644
--- a/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.c
+++ b/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.c
@@ -18,7 +18,7 @@ void ShotSun_Update(Actor* thisx, PlayState* play);
 
 void ShotSun_SpawnFairy(ShotSun* this, PlayState* play);
 void ShotSun_TriggerFairy(ShotSun* this, PlayState* play);
-void func_80BADF0C(ShotSun* this, PlayState* play);
+void ShotSun_UpdateFairySpawner(ShotSun* this, PlayState* play);
 void ShotSun_UpdateHyliaSun(ShotSun* this, PlayState* play);
 
 ActorInit Shot_Sun_InitVars = {
@@ -33,6 +33,12 @@ ActorInit Shot_Sun_InitVars = {
     NULL,
 };
 
+typedef enum {
+    /* 0 */ SPAWNER_OUT_OF_RANGE ,
+    /* 1 */ SPAWNER_OCARINA_START,
+    /* 2 */ SPAWNER_OCARINA_PLAYING
+} FairySpawnerState;
+
 static ColliderCylinderInit sCylinderInit = {
     {
         COLTYPE_NONE,
@@ -61,10 +67,10 @@ void ShotSun_Init(Actor* thisx, PlayState* play) {
     osSyncPrintf("%d ---- オカリナの秘密発生!!!!!!!!!!!!!\n", this->actor.params);
     params = this->actor.params & 0xFF;
     if (params == 0x40 || params == 0x41) {
-        this->unk_1A4 = 0;
+        this->fairySpawnerState = SPAWNER_OUT_OF_RANGE;
         this->actor.flags |= ACTOR_FLAG_4;
         this->actor.flags |= ACTOR_FLAG_25;
-        this->actionFunc = func_80BADF0C;
+        this->actionFunc = ShotSun_UpdateFairySpawner;
         this->actor.flags |= ACTOR_FLAG_27;
     } else {
         Collider_InitCylinder(play, &this->collider);
@@ -119,35 +125,35 @@ void ShotSun_TriggerFairy(ShotSun* this, PlayState* play) {
     }
 }
 
-void func_80BADF0C(ShotSun* this, PlayState* play) {
+void ShotSun_UpdateFairySpawner(ShotSun* this, PlayState* play) {
     Player* player = GET_PLAYER(play);
     s32 pad;
     s32 params = this->actor.params & 0xFF;
 
     if (Math3D_Vec3fDistSq(&this->actor.world.pos, &player->actor.world.pos) > SQ(150.0f)) {
-        this->unk_1A4 = 0;
+        this->fairySpawnerState = SPAWNER_OUT_OF_RANGE;
     } else {
-        if (this->unk_1A4 == 0) {
+        if (this->fairySpawnerState == SPAWNER_OUT_OF_RANGE) {
             if (!(player->stateFlags2 & PLAYER_STATE2_24)) {
                 player->stateFlags2 |= PLAYER_STATE2_23;
                 return;
             } else {
-                this->unk_1A4 = 1;
+                this->fairySpawnerState = SPAWNER_OCARINA_START;
             }
         }
-        if (this->unk_1A4 == 1) {
+        if (this->fairySpawnerState == SPAWNER_OCARINA_START) {
             func_8010BD58(play, OCARINA_ACTION_FREE_PLAY);
-            this->unk_1A4 = 2;
-        } else if (this->unk_1A4 == 2 && play->msgCtx.ocarinaMode == OCARINA_MODE_04) {
+            this->fairySpawnerState = SPAWNER_OCARINA_PLAYING;
+        } else if (this->fairySpawnerState == SPAWNER_OCARINA_PLAYING && play->msgCtx.ocarinaMode == OCARINA_MODE_04) {
             if ((params == 0x40 && play->msgCtx.lastPlayedSong == OCARINA_SONG_SUNS) ||
                 (params == 0x41 && play->msgCtx.lastPlayedSong == OCARINA_SONG_STORMS)) {
                 this->actionFunc = ShotSun_TriggerFairy;
                 OnePointCutscene_Attention(play, &this->actor);
                 this->timer = 0;
             } else {
-                this->unk_1A4 = 0;
+                this->fairySpawnerState = SPAWNER_OUT_OF_RANGE;
             }
-            this->unk_1A4 = 0;
+            this->fairySpawnerState = SPAWNER_OUT_OF_RANGE;
         }
     }
 }
diff --git a/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.h b/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.h
index 51b2d0e6f4..9687e5940e 100644
--- a/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.h
+++ b/src/overlays/actors/ovl_Shot_Sun/z_shot_sun.h
@@ -14,7 +14,7 @@ typedef struct ShotSun {
     /* 0x0198 */ ShotSunActionFunc actionFunc;
     /* 0x019C */ Vec3s hitboxPos;
     /* 0x01A2 */ s16 timer; // Frames until fairy spawns
-    /* 0x01A4 */ u8 unk_1A4;
+    /* 0x01A4 */ u8 fairySpawnerState;
 } ShotSun; // size = 0x01A8
 
 #endif