From a7461640410c87c73f7e7283fdb229a4818ac244 Mon Sep 17 00:00:00 2001
From: engineer124 <47598039+engineer124@users.noreply.github.com>
Date: Mon, 21 Oct 2024 11:05:45 +1100
Subject: Document `ACTOR_FLAG_UPDATE_DURING_OCARINA` and
 `PLAYER_STATE2_USING_OCARINA` (#1720)

* ocarina flag

* oops

* PR
---
 src/code/z_actor.c       | 14 +++++++-------
 src/code/z_player_call.c |  2 +-
 2 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'src/code')

diff --git a/src/code/z_actor.c b/src/code/z_actor.c
index 154ad90f2..109d9d757 100644
--- a/src/code/z_actor.c
+++ b/src/code/z_actor.c
@@ -2506,7 +2506,7 @@ void Actor_SpawnSetupActors(PlayState* play, ActorContext* actorCtx) {
 typedef struct {
     /* 0x00 */ PlayState* play;
     /* 0x04 */ Actor* actor;
-    /* 0x08 */ u32 requiredActorFlag;
+    /* 0x08 */ u32 freezeExceptionFlag;
     /* 0x0C */ u32 canFreezeCategory;
     /* 0x10 */ Actor* talkActor;
     /* 0x14 */ Player* player;
@@ -2543,8 +2543,8 @@ Actor* Actor_UpdateActor(UpdateActor_Params* params) {
     } else {
         if (!Object_IsLoaded(&play->objectCtx, actor->objectSlot)) {
             Actor_Kill(actor);
-        } else if ((params->requiredActorFlag && !(actor->flags & params->requiredActorFlag)) ||
-                   (((!params->requiredActorFlag) != 0) &&
+        } else if (((params->freezeExceptionFlag != 0) && !(actor->flags & params->freezeExceptionFlag)) ||
+                   (((!params->freezeExceptionFlag) != 0) &&
                     (!(actor->flags & ACTOR_FLAG_100000) ||
                      ((actor->category == ACTORCAT_EXPLOSIVES) && (params->player->stateFlags1 & PLAYER_STATE1_200))) &&
                     params->canFreezeCategory && (actor != params->talkActor) && (actor != params->player->heldActor) &&
@@ -2645,10 +2645,10 @@ void Actor_UpdateAll(PlayState* play, ActorContext* actorCtx) {
 
     categoryFreezeMaskP = sCategoryFreezeMasks;
 
-    if (player->stateFlags2 & PLAYER_STATE2_8000000) {
-        params.requiredActorFlag = ACTOR_FLAG_2000000;
+    if (player->stateFlags2 & PLAYER_STATE2_USING_OCARINA) {
+        params.freezeExceptionFlag = ACTOR_FLAG_UPDATE_DURING_OCARINA;
     } else {
-        params.requiredActorFlag = 0;
+        params.freezeExceptionFlag = 0;
     }
 
     if ((player->stateFlags1 & PLAYER_STATE1_40) && ((player->actor.textId & 0xFF00) != 0x1900)) {
@@ -3063,7 +3063,7 @@ void Actor_DrawAll(PlayState* play, ActorContext* actorCtx) {
 
     if (play->actorCtx.lensActive) {
         Math_StepToC(&play->actorCtx.lensMaskSize, LENS_MASK_ACTIVE_SIZE, 20);
-        if (GET_PLAYER(play)->stateFlags2 & PLAYER_STATE2_8000000) {
+        if (GET_PLAYER(play)->stateFlags2 & PLAYER_STATE2_USING_OCARINA) {
             Actor_DeactivateLens(play);
         }
     } else {
diff --git a/src/code/z_player_call.c b/src/code/z_player_call.c
index e369c675d..c1612d640 100644
--- a/src/code/z_player_call.c
+++ b/src/code/z_player_call.c
@@ -3,7 +3,7 @@
 
 #define FLAGS                                                                                                 \
     (ACTOR_FLAG_ATTENTION_ENABLED | ACTOR_FLAG_FRIENDLY | ACTOR_FLAG_10 | ACTOR_FLAG_20 | ACTOR_FLAG_200000 | \
-     ACTOR_FLAG_2000000 | ACTOR_FLAG_CAN_PRESS_SWITCH | ACTOR_FLAG_80000000)
+     ACTOR_FLAG_UPDATE_DURING_OCARINA | ACTOR_FLAG_CAN_PRESS_SWITCH | ACTOR_FLAG_80000000)
 
 ActorFunc sPlayerCallInitFunc;
 ActorFunc sPlayerCallDestroyFunc;
-- 
cgit v1.2.3