Add OnActorKill & OnEnemyDefeat hooks

soh/soh/Enhancements/game-interactor/GameInteractor.h

@@ -153,6 +153,8 @@ class GameInteractor {
     DEFINE_HOOK(OnOcarinaSongAction, void());
     DEFINE_HOOK(OnActorInit, void(void* actor));
     DEFINE_HOOK(OnActorUpdate, void(void* actor));
+    DEFINE_HOOK(OnActorKill, void(void* actor));
+    DEFINE_HOOK(OnEnemyDefeat, void(void* actor));
     DEFINE_HOOK(OnPlayerBonk, void());
     DEFINE_HOOK(OnPlayDestroy, void());
     DEFINE_HOOK(OnPlayDrawEnd, void());

soh/soh/Enhancements/game-interactor/GameInteractor_Hooks.cpp

@@ -50,6 +50,14 @@ void GameInteractor_ExecuteOnActorUpdate(void* actor) {
     GameInteractor::Instance->ExecuteHooks<GameInteractor::OnActorUpdate>(actor);
 }
 
+void GameInteractor_ExecuteOnActorKill(void* actor) {
+    GameInteractor::Instance->ExecuteHooks<GameInteractor::OnActorKill>(actor);
+}
+
+void GameInteractor_ExecuteOnEnemyDefeat(void* actor) {
+    GameInteractor::Instance->ExecuteHooks<GameInteractor::OnEnemyDefeat>(actor);
+}
+
 void GameInteractor_ExecuteOnPlayerBonk() {
     GameInteractor::Instance->ExecuteHooks<GameInteractor::OnPlayerBonk>();
 }

soh/soh/Enhancements/game-interactor/GameInteractor_Hooks.h

@@ -16,6 +16,8 @@ void GameInteractor_ExecuteOnPlayerUpdate();
 void GameInteractor_ExecuteOnOcarinaSongAction();
 void GameInteractor_ExecuteOnActorInit(void* actor);
 void GameInteractor_ExecuteOnActorUpdate(void* actor);
+void GameInteractor_ExecuteOnActorKill(void* actor);
+void GameInteractor_ExecuteOnEnemyDefeat(void* actor);
 void GameInteractor_ExecuteOnPlayerBonk();
 void GameInteractor_ExecuteOnOcarinaSongAction();
 void GameInteractor_ExecuteOnPlayDestroy();

soh/soh/Enhancements/gameplaystats.h

@@ -87,7 +87,7 @@ typedef enum {
     COUNT_ENEMIES_DEFEATED_PARASITIC_TENTACLE,   // EN_BA
     COUNT_ENEMIES_DEFEATED_PEAHAT,               // EN_PEEHAT
     COUNT_ENEMIES_DEFEATED_PEAHAT_LARVA,         // EN_PEEHAT
-    COUNT_ENEMIES_DEFEATED_POE,                  // EN_POH
+    COUNT_ENEMIES_DEFEATED_POE,                  // EN_POH & EN_PO_FIELD
     COUNT_ENEMIES_DEFEATED_POE_BIG,              // EN_PO_FIELD
     COUNT_ENEMIES_DEFEATED_POE_COMPOSER,         // EN_POH
     COUNT_ENEMIES_DEFEATED_POE_SISTERS,          // EN_PO_SISTERS

soh/soh/Enhancements/mods.cpp

@@ -9,6 +9,19 @@
 #include "soh/Enhancements/cosmetics/authenticGfxPatches.h"
 #include "soh/Enhancements/nametag.h"
 
+#include "src/overlays/actors/ovl_En_Bb/z_en_bb.h"
+#include "src/overlays/actors/ovl_En_Dekubaba/z_en_dekubaba.h"
+#include "src/overlays/actors/ovl_En_Mb/z_en_mb.h"
+#include "src/overlays/actors/ovl_En_Tite/z_en_tite.h"
+#include "src/overlays/actors/ovl_En_Zf/z_en_zf.h"
+#include "src/overlays/actors/ovl_En_Wf/z_en_wf.h"
+#include "src/overlays/actors/ovl_En_Reeba/z_en_reeba.h"
+#include "src/overlays/actors/ovl_En_Peehat/z_en_peehat.h"
+#include "src/overlays/actors/ovl_En_Po_Field/z_en_po_field.h"
+#include "src/overlays/actors/ovl_En_Poh/z_en_poh.h"
+#include "src/overlays/actors/ovl_En_Tp/z_en_tp.h"
+#include "src/overlays/actors/ovl_En_Firefly/z_en_firefly.h"
+
 extern "C" {
 #include <z64.h>
 #include "macros.h"
@@ -601,6 +614,197 @@ void RegisterMirrorModeHandler() {
     });
 }
 
+//this map is used for enemies that can be uniquely identified by their id
+//and that are always counted
+//enemies that can't be uniquely identified by their id
+//or only sometimes count (like ACTOR_EN_TP)
+//have to be manually handled in RegisterEnemyDefeatCounts
+static std::unordered_map<u16, u16> uniqueEnemyIdToStatCount = {
+    { ACTOR_EN_ANUBICE,    COUNT_ENEMIES_DEFEATED_ANUBIS },
+    { ACTOR_EN_AM,         COUNT_ENEMIES_DEFEATED_ARMOS },
+    { ACTOR_EN_CLEAR_TAG,  COUNT_ENEMIES_DEFEATED_ARWING },
+    { ACTOR_EN_VALI,       COUNT_ENEMIES_DEFEATED_BARI },
+    { ACTOR_EN_VM,         COUNT_ENEMIES_DEFEATED_BEAMOS },
+    { ACTOR_EN_BIGOKUTA,   COUNT_ENEMIES_DEFEATED_BIG_OCTO },
+    { ACTOR_EN_BILI,       COUNT_ENEMIES_DEFEATED_BIRI },
+    { ACTOR_EN_DNS,        COUNT_ENEMIES_DEFEATED_BUSINESS_SCRUB },
+    { ACTOR_EN_TORCH,      COUNT_ENEMIES_DEFEATED_DARK_LINK },
+    { ACTOR_EN_DH,         COUNT_ENEMIES_DEFEATED_DEAD_HAND },
+    { ACTOR_EN_HINTNUTS,   COUNT_ENEMIES_DEFEATED_DEKU_SCRUB },
+    { ACTOR_EN_DODONGO,    COUNT_ENEMIES_DEFEATED_DODONGO },
+    { ACTOR_EN_DODOJR,     COUNT_ENEMIES_DEFEATED_DODONGO_BABY },
+    { ACTOR_DOOR_KILLER,   COUNT_ENEMIES_DEFEATED_DOOR_TRAP },
+    { ACTOR_EN_FD,         COUNT_ENEMIES_DEFEATED_FLARE_DANCER },
+    { ACTOR_EN_FLOORMAS,   COUNT_ENEMIES_DEFEATED_FLOORMASTER },
+    { ACTOR_EN_TUBO_TRAP,  COUNT_ENEMIES_DEFEATED_FLYING_POT },
+    { ACTOR_EN_YUKABYUN,   COUNT_ENEMIES_DEFEATED_FLOOR_TILE },
+    { ACTOR_EN_FZ,         COUNT_ENEMIES_DEFEATED_FREEZARD },
+    { ACTOR_EN_GELDB,      COUNT_ENEMIES_DEFEATED_GERUDO_THIEF },
+    { ACTOR_EN_GOMA,       COUNT_ENEMIES_DEFEATED_GOHMA_LARVA },
+    { ACTOR_EN_CROW,       COUNT_ENEMIES_DEFEATED_GUAY },
+    { ACTOR_EN_RR,         COUNT_ENEMIES_DEFEATED_LIKE_LIKE },
+    { ACTOR_EN_DEKUNUTS,   COUNT_ENEMIES_DEFEATED_MAD_SCRUB },
+    { ACTOR_EN_OKUTA,      COUNT_ENEMIES_DEFEATED_OCTOROK },
+    { ACTOR_EN_BA,         COUNT_ENEMIES_DEFEATED_PARASITIC_TENTACLE },
+    { ACTOR_EN_PO_SISTERS, COUNT_ENEMIES_DEFEATED_POE_SISTERS },
+    { ACTOR_EN_BUBBLE,     COUNT_ENEMIES_DEFEATED_SHABOM },
+    { ACTOR_EN_SB,         COUNT_ENEMIES_DEFEATED_SHELLBLADE },
+    { ACTOR_EN_SKJ,        COUNT_ENEMIES_DEFEATED_SKULL_KID },
+    { ACTOR_EN_NY,         COUNT_ENEMIES_DEFEATED_SPIKE },
+    { ACTOR_EN_SKB,        COUNT_ENEMIES_DEFEATED_STALCHILD },
+    { ACTOR_EN_TEST,       COUNT_ENEMIES_DEFEATED_STALFOS },
+    { ACTOR_EN_WEIYER,     COUNT_ENEMIES_DEFEATED_STINGER },
+    { ACTOR_EN_BW,         COUNT_ENEMIES_DEFEATED_TORCH_SLUG },
+    { ACTOR_EN_WALLMAS,    COUNT_ENEMIES_DEFEATED_WALLMASTER },
+    { ACTOR_EN_KAREBABA,   COUNT_ENEMIES_DEFEATED_WITHERED_DEKU_BABA },
+};
+
+void RegisterEnemyDefeatCounts() {
+    GameInteractor::Instance->RegisterGameHook<GameInteractor::OnEnemyDefeat>([](void* refActor) {
+        Actor* actor = (Actor*)refActor;
+        if (uniqueEnemyIdToStatCount.contains(actor->id)) {
+            gSaveContext.sohStats.count[uniqueEnemyIdToStatCount[actor->id]]++;
+        } else {
+            switch (actor->id) {
+                case ACTOR_EN_BB:
+                    if (actor->params == ENBB_GREEN || actor->params == ENBB_GREEN_BIG) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_GREEN]++;
+                    } else if (actor->params == ENBB_BLUE) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_BLUE]++;
+                    } else if (actor->params == ENBB_WHITE) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_WHITE]++;
+                    } else if (actor->params == ENBB_RED) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_RED]++;
+                    }
+                    break;
+
+                case ACTOR_EN_DEKUBABA:
+                    if (actor->params == DEKUBABA_BIG) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_DEKU_BABA_BIG]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_DEKU_BABA]++;
+                    }
+                    break;
+
+                case ACTOR_EN_ZF:
+                    if (actor->params == ENZF_TYPE_DINOLFOS) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_DINOLFOS]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_LIZALFOS]++;
+                    }
+                    break;
+
+                case ACTOR_EN_RD:
+                    if (actor->params >= -1) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_REDEAD]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_GIBDO]++;
+                    }
+                    break;
+
+                case ACTOR_EN_IK:
+                    if (actor->params == 0) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_IRON_KNUCKLE_NABOORU]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_IRON_KNUCKLE]++;
+                    }
+                    break;
+
+                case ACTOR_EN_FIREFLY:
+                    if (actor->params == KEESE_NORMAL_FLY || actor->params == KEESE_NORMAL_PERCH) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_KEESE]++;
+                    } else if (actor->params == KEESE_FIRE_FLY || actor->params == KEESE_FIRE_PERCH) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_KEESE_FIRE]++;
+                    } else if (actor->params == KEESE_ICE_FLY) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_KEESE_ICE]++;
+                    }
+                    break;
+
+                case ACTOR_EN_REEBA:
+                    {
+                        EnReeba* reeba = (EnReeba*)actor;
+                        if (reeba->isBig) {
+                            gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_LEEVER_BIG]++;
+                        } else {
+                            gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_LEEVER]++;
+                        }
+                    }
+                    break;
+
+                case ACTOR_EN_MB:
+                    if (actor->params == 0) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_MOBLIN_CLUB]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_MOBLIN]++;
+                    }
+                    break;
+
+                case ACTOR_EN_PEEHAT:
+                    if (actor->params == PEAHAT_TYPE_LARVA) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_PEAHAT_LARVA]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_PEAHAT]++;
+                    }
+                    break;
+
+                case ACTOR_EN_POH:
+                    if (actor->params == EN_POH_FLAT || actor->params == EN_POH_SHARP) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_POE_COMPOSER]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_POE]++;
+                    }
+                    break;
+
+                case ACTOR_EN_PO_FIELD:
+                    if (actor->params == EN_PO_FIELD_BIG) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_POE_BIG]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_POE]++;
+                    }
+                    break;
+
+                case ACTOR_EN_ST:
+                    if (actor->params == 1) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_SKULLTULA_BIG]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_SKULLTULA]++;
+                    }
+                    break;
+
+                case ACTOR_EN_SW:
+                    if (((actor->params & 0xE000) >> 0xD) != 0) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_SKULLTULA_GOLD]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_SKULLWALLTULA]++;
+                    }
+                    break;
+
+                case ACTOR_EN_TP:
+                    if (actor->params == TAILPASARAN_HEAD) {  // Only count the head, otherwise each body segment will increment
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_TAILPASARAN]++;
+                    }
+                    break;
+
+                case ACTOR_EN_TITE:
+                    if (actor->params == TEKTITE_BLUE) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_TEKTITE_BLUE]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_TEKTITE_RED]++;
+                    }
+                    break;
+
+                case ACTOR_EN_WF:
+                    if (actor->params == WOLFOS_WHITE) {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_WOLFOS_WHITE]++;
+                    } else {
+                        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_WOLFOS]++;
+                    }
+                    break;
+            }
+        }
+    });
+}
+
 typedef enum {
     ADD_ICE_TRAP,
     ADD_BURN_TRAP,
@@ -771,6 +975,7 @@ void InitMods() {
     RegisterBonkDamage();
     RegisterMenuPathFix();
     RegisterMirrorModeHandler();
+    RegisterEnemyDefeatCounts();
     RegisterAltTrapTypes();
     NameTag_RegisterHooks();
 }

soh/src/code/z_actor.c

@@ -1147,6 +1147,7 @@ s32 func_8002D53C(PlayState* play, TitleCardContext* titleCtx) {
 }
 
 void Actor_Kill(Actor* actor) {
+    GameInteractor_ExecuteOnActorKill(actor);
     actor->draw = NULL;
     actor->update = NULL;
     actor->flags &= ~ACTOR_FLAG_TARGETABLE;

soh/src/overlays/actors/ovl_Door_Killer/z_door_killer.c

@@ -10,6 +10,7 @@
 #include "objects/object_mizu_objects/object_mizu_objects.h"
 #include "objects/object_haka_door/object_haka_door.h"
 #include "objects/object_door_killer/object_door_killer.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
 
 #define FLAGS ACTOR_FLAG_UPDATE_WHILE_CULLED
 
@@ -270,7 +271,7 @@ void DoorKiller_Die(DoorKiller* this, PlayState* play) {
         Flags_SetSwitch(play, switchFlag);
     }
     Actor_Kill(&this->actor);
-    gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_DOOR_TRAP]++;
+    GameInteractor_ExecuteOnEnemyDefeat(&this->actor);
 }
 
 /**

soh/src/overlays/actors/ovl_En_Am/z_en_am.c

@@ -7,6 +7,7 @@
 #include "z_en_am.h"
 #include "objects/object_am/object_am.h"
 #include "overlays/actors/ovl_En_Bom/z_en_bom.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
 
 #define FLAGS (ACTOR_FLAG_TARGETABLE | ACTOR_FLAG_HOSTILE | ACTOR_FLAG_UPDATE_WHILE_CULLED | ACTOR_FLAG_CAN_PRESS_SWITCH)
 
@@ -884,8 +885,8 @@ void EnAm_Update(Actor* thisx, PlayState* play) {
                     func_8002836C(play, &dustPos, &zeroVec, &zeroVec, &dustPrimColor, &dustEnvColor, 200, 45, 12);
                     dustPosScale += 60.0f;
                 }
-
-                gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_ARMOS]++;
+                
+                GameInteractor_ExecuteOnEnemyDefeat(thisx);
 
                 Actor_Kill(&this->dyna.actor);
                 return;

soh/src/overlays/actors/ovl_En_Anubice/z_en_anubice.c

@@ -9,6 +9,7 @@
 #include "overlays/actors/ovl_En_Anubice_Tag/z_en_anubice_tag.h"
 #include "overlays/actors/ovl_Bg_Hidan_Curtain/z_bg_hidan_curtain.h"
 #include "vt.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
 
 #define FLAGS (ACTOR_FLAG_TARGETABLE | ACTOR_FLAG_HOSTILE | ACTOR_FLAG_UPDATE_WHILE_CULLED)
 
@@ -314,7 +315,7 @@ void EnAnubice_SetupDie(EnAnubice* this, PlayState* play) {
     }
 
     this->actionFunc = EnAnubice_Die;
-    gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_ANUBIS]++;
+    GameInteractor_ExecuteOnEnemyDefeat(&this->actor);
 }
 
 void EnAnubice_Die(EnAnubice* this, PlayState* play) {

soh/src/overlays/actors/ovl_En_Ba/z_en_ba.c

@@ -7,6 +7,7 @@
 #include "z_en_ba.h"
 #include "objects/object_bxa/object_bxa.h"
 #include "soh/frame_interpolation.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
 
 #define FLAGS (ACTOR_FLAG_TARGETABLE | ACTOR_FLAG_HOSTILE | ACTOR_FLAG_UPDATE_WHILE_CULLED)
 
@@ -455,7 +456,7 @@ void EnBa_Update(Actor* thisx, PlayState* play) {
         this->actor.colChkInfo.health--;
         if (this->actor.colChkInfo.health == 0) {
             func_809B75A0(this, play);
-            gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_PARASITIC_TENTACLE]++;
+            GameInteractor_ExecuteOnEnemyDefeat(&this->actor);
         } else {
             func_809B7174(this);
         }

soh/src/overlays/actors/ovl_En_Bb/z_en_bb.c

@@ -7,6 +7,7 @@
 #include "z_en_bb.h"
 #include "objects/gameplay_keep/gameplay_keep.h"
 #include "objects/object_Bb/object_Bb.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
 
 #define FLAGS (ACTOR_FLAG_TARGETABLE | ACTOR_FLAG_HOSTILE | ACTOR_FLAG_UPDATE_WHILE_CULLED | ACTOR_FLAG_PLAY_HIT_SFX)
 
@@ -465,18 +466,7 @@ void EnBb_SetupDeath(EnBb* this, PlayState* play) {
     this->action = BB_KILL;
     EnBb_SetupAction(this, EnBb_Death);
 
-    if (this->actor.params == ENBB_GREEN || this->actor.params == ENBB_GREEN_BIG) {
-        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_GREEN]++;
-    }
-    if (this->actor.params == ENBB_BLUE) {
-        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_BLUE]++;
-    }
-    if (this->actor.params == ENBB_WHITE) {
-        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_WHITE]++;
-    }
-    if (this->actor.params == ENBB_RED) {
-        gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BUBBLE_RED]++;
-    }
+    GameInteractor_ExecuteOnEnemyDefeat(&this->actor);
 }
 
 void EnBb_Death(EnBb* this, PlayState* play) {

soh/src/overlays/actors/ovl_En_Bigokuta/z_en_bigokuta.c

@@ -1,5 +1,6 @@
 #include "z_en_bigokuta.h"
 #include "objects/object_bigokuta/object_bigokuta.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
 
 #define FLAGS (ACTOR_FLAG_TARGETABLE | ACTOR_FLAG_HOSTILE | ACTOR_FLAG_UPDATE_WHILE_CULLED | ACTOR_FLAG_DRAW_WHILE_CULLED)
 
@@ -648,7 +649,7 @@ void func_809BE26C(EnBigokuta* this, PlayState* play) {
             SoundSource_PlaySfxAtFixedWorldPos(play, &this->actor.world.pos, 50, NA_SE_EN_OCTAROCK_BUBLE);
             Item_DropCollectibleRandom(play, &this->actor, &this->actor.world.pos, 0xB0);
             Actor_Kill(&this->actor);
-            gSaveContext.sohStats.count[COUNT_ENEMIES_DEFEATED_BIG_OCTO]++;
+            GameInteractor_ExecuteOnEnemyDefeat(&this->actor);
         }
     }
 }