Merge pull request #1283 from leggettc18/color-coded-keys

Implements Color Coded Keysanity keys and easier custom draw functions

libultraship/libultraship/ImGuiImpl.cpp

@@ -2014,6 +2014,9 @@ namespace SohImGui {
                     Tooltip(
                         "Replace Navi's overworld quest hints with rando-related gameplay hints."
                     );
+                    PaddedEnhancementCheckbox("Key Colors Match Dungeon", "gRandoMatchKeyColors", true, false);
+                    Tooltip(
+                        "Matches the color of small keys and boss keys to the dungeon they belong to. This helps identify keys from afar and adds a little bit of flair.");
                     ImGui::EndMenu();
                 }
 

soh/CMakeLists.txt

@@ -184,6 +184,7 @@ set(Header_Files__soh__Enhancements__randomizer
     "soh/Enhancements/randomizer/randomizer_item_tracker.h"
     "soh/Enhancements/randomizer/adult_trade_shuffle.h"
     "soh/Enhancements/randomizer/randomizer_check_objects.h"
+    "soh/Enhancements/randomizer/draw.h"
 )
 source_group("Header Files\\soh\\Enhancements\\randomizer" FILES ${Header_Files__soh__Enhancements__randomizer})
 
@@ -291,6 +292,7 @@ set(Source_Files__soh__Enhancements__randomizer
     "soh/Enhancements/randomizer/randomizer_item_tracker.cpp"
     "soh/Enhancements/randomizer/adult_trade_shuffle.c"
     "soh/Enhancements/randomizer/randomizer_check_objects.cpp"
+    "soh/Enhancements/randomizer/draw.cpp"
 )
 source_group("Source Files\\soh\\Enhancements\\randomizer" FILES ${Source_Files__soh__Enhancements__randomizer})
 

soh/include/functions.h

@@ -859,6 +859,7 @@ void Cutscene_HandleEntranceTriggers(GlobalContext* globalCtx);
 void Cutscene_HandleConditionalTriggers(GlobalContext* globalCtx);
 void Cutscene_SetSegment(GlobalContext* globalCtx, void* segment);
 void GetItem_Draw(GlobalContext* globalCtx, s16 drawId);
+void GetItemEntry_Draw(GlobalContext* globalCtx, GetItemEntry getItemEntry);
 void SoundSource_InitAll(GlobalContext* globalCtx);
 void SoundSource_UpdateAll(GlobalContext* globalCtx);
 void SoundSource_PlaySfxAtFixedWorldPos(GlobalContext* globalCtx, Vec3f* pos, s32 duration, u16 sfxId);

soh/soh/Enhancements/item-tables/ItemTableTypes.h

@@ -7,12 +7,20 @@
 #define CHEST_ANIM_LONG 1
 
 #define GET_ITEM(itemId, objectId, drawId, textId, field, chestAnim, modIndex, getItemId) \
-    { itemId, field, (chestAnim != CHEST_ANIM_SHORT ? 1 : -1) * (drawId + 1), textId, objectId, modIndex, getItemId, drawId, true }
+    { itemId, field, (chestAnim != CHEST_ANIM_SHORT ? 1 : -1) * (drawId + 1), textId, objectId, modIndex, getItemId, drawId, true, NULL }
 
 #define GET_ITEM_NONE \
-    { ITEM_NONE, 0, 0, 0, 0, 0, 0, 0, false }
+    { ITEM_NONE, 0, 0, 0, 0, 0, 0, 0, false, NULL }
 
-typedef struct {
+#define GET_ITEM_CUSTOM_DRAW(itemId, objectId, drawId, textId, field, chestAnim, modIndex, getItemId, drawFunc) \
+    { itemId, field (chestAnim != CHEST_ANIM_SHORT ? 1 : -1) * (drawId + 1), textId, objectId, modIndex, getItemId, drawId, true, drawFunc }
+
+typedef struct GlobalContext GlobalContext;
+typedef struct GetItemEntry GetItemEntry;
+
+typedef void (*CustomDrawFunc)(GlobalContext* globalCtx, GetItemEntry* getItemEntry);
+
+typedef struct GetItemEntry {
     /* 0x00 */ uint16_t itemId;
     /* 0x01 */ uint16_t field; // various bit-packed data
     /* 0x02 */ int16_t gi;     // defines the draw id and chest opening animation
@@ -22,4 +30,5 @@ typedef struct {
     /* 0x08 */ int16_t getItemId;
     /* 0x0A */ uint16_t gid; // Stores the GID value unmodified for future reference.
     /* 0x0C */ uint16_t collectable; // determines whether the item can be collected on the overworld. Will be true in most cases.
-} GetItemEntry;                   // size = 0x0F
+    CustomDrawFunc drawFunc;
+};                   // size = 0x0F

soh/soh/Enhancements/randomizer/draw.cpp

@@ -0,0 +1,109 @@
+#include "draw.h"
+#include "z64.h"
+#include "macros.h"
+#include "functions.h"
+#include "randomizerTypes.h"
+#include <array>
+#include "objects/object_gi_key/object_gi_key.h"
+#include "objects/object_gi_bosskey/object_gi_bosskey.h"
+#include "objects/object_gi_hearts/object_gi_hearts.h"
+
+extern "C" void Randomizer_DrawSmallKey(GlobalContext* globalCtx, GetItemEntry* getItemEntry) {
+    s32 pad;
+
+    s16 color_slot = getItemEntry->getItemId - RG_FOREST_TEMPLE_SMALL_KEY;
+    s16 colors[9][3] = {
+        { 4, 195, 46 },    // Forest Temple
+        { 237, 95, 95 },   // Fire Temple
+        { 85, 180, 223 },  // Water Temple
+        { 222, 158, 47 },  // Spirit Temple
+        { 126, 16, 177 },  // Shadow Temple
+        { 227, 110, 255 }, // Bottom of the Well
+        { 221, 212, 60 },  // Gerudo Training Grounds
+        { 255, 255, 255 }, // Theive's Hideout (unused)
+        { 80, 80, 80 }     // Ganon's Castle
+    };
+
+    OPEN_DISPS(globalCtx->state.gfxCtx);
+
+    func_80093D18(globalCtx->state.gfxCtx);
+
+    gSPMatrix(POLY_OPA_DISP++, Matrix_NewMtx(globalCtx->state.gfxCtx, (char*)__FILE__, __LINE__),
+              G_MTX_MODELVIEW | G_MTX_LOAD);
+
+    gsDPSetGrayscaleColor(POLY_OPA_DISP++, colors[color_slot][0], colors[color_slot][1], colors[color_slot][2], 255);
+    gsSPGrayscale(POLY_OPA_DISP++, true);
+
+    gSPDisplayList(POLY_OPA_DISP++, (Gfx*)gGiSmallKeyDL);
+
+    gsSPGrayscale(POLY_OPA_DISP++, false);
+
+    CLOSE_DISPS(globalCtx->state.gfxCtx);
+}
+
+extern "C" void Randomizer_DrawBossKey(GlobalContext* globalCtx, GetItemEntry* getItemEntry) {
+    s32 pad;
+    s16 color_slot;
+    color_slot = getItemEntry->getItemId - RG_FOREST_TEMPLE_BOSS_KEY;
+    s16 colors[6][3] = {
+        { 4, 195, 46 },   // Forest Temple
+        { 237, 95, 95 },  // Fire Temple
+        { 85, 180, 223 }, // Water Temple
+        { 222, 158, 47 }, // Spirit Temple
+        { 126, 16, 177 }, // Shadow Temple
+        { 210, 0, 0 }     // Ganon's Castle
+    };
+
+    OPEN_DISPS(globalCtx->state.gfxCtx);
+
+    func_80093D18(globalCtx->state.gfxCtx);
+
+    gSPMatrix(POLY_OPA_DISP++, Matrix_NewMtx(globalCtx->state.gfxCtx, (char*)__FILE__, __LINE__),
+              G_MTX_MODELVIEW | G_MTX_LOAD);
+
+    if (color_slot == 5) { // Ganon's Boss Key
+        gsDPSetGrayscaleColor(POLY_OPA_DISP++, 80, 80, 80, 255);
+        gsSPGrayscale(POLY_OPA_DISP++, true);
+    }
+
+    gSPDisplayList(POLY_OPA_DISP++, (Gfx*)gGiBossKeyDL);
+
+    if (color_slot == 5) { // Ganon's Boss Key
+        gsSPGrayscale(POLY_OPA_DISP++, false);
+    }
+
+    func_80093D84(globalCtx->state.gfxCtx);
+
+    gSPMatrix(POLY_XLU_DISP++, Matrix_NewMtx(globalCtx->state.gfxCtx, (char*)__FILE__, __LINE__),
+              G_MTX_MODELVIEW | G_MTX_LOAD);
+
+    gsDPSetGrayscaleColor(POLY_XLU_DISP++, colors[color_slot][0], colors[color_slot][1], colors[color_slot][2],
+                            255);
+    gsSPGrayscale(POLY_XLU_DISP++, true);
+
+    gSPDisplayList(POLY_XLU_DISP++, (Gfx*)gGiBossKeyGemDL);
+
+    gsSPGrayscale(POLY_XLU_DISP++, false);
+
+    CLOSE_DISPS(globalCtx->state.gfxCtx);
+}
+
+extern "C" void Randomizer_DrawDoubleDefense(GlobalContext* globalCtx, GetItemEntry getItemEntry) {
+    s32 pad;
+    OPEN_DISPS(globalCtx->state.gfxCtx);
+
+    func_80093D84(globalCtx->state.gfxCtx);
+   
+    gSPMatrix(POLY_XLU_DISP++, Matrix_NewMtx(globalCtx->state.gfxCtx, (char*)__FILE__, __LINE__), G_MTX_MODELVIEW | G_MTX_LOAD);
+
+    gsDPSetGrayscaleColor(POLY_XLU_DISP++, 255, 255, 255, 255);
+    gsSPGrayscale(POLY_XLU_DISP++, true);
+
+    gSPDisplayList(POLY_XLU_DISP++, (Gfx*)gGiHeartBorderDL);
+
+    gsSPGrayscale(POLY_XLU_DISP++, false);
+
+    gSPDisplayList(POLY_XLU_DISP++, (Gfx*)gGiHeartContainerDL);
+
+    CLOSE_DISPS(globalCtx->state.gfxCtx);
+}

soh/soh/Enhancements/randomizer/draw.h

@@ -0,0 +1,13 @@
+#ifndef RANDODRAW_H
+#define RANDODRAW_H
+#pragma once
+
+#include "../item-tables/ItemTableTypes.h"
+
+typedef struct GlobalContext GlobalContext;
+
+extern "C" void Randomizer_DrawSmallKey(GlobalContext* globalCtx, GetItemEntry* getItemEntry);
+extern "C" void Randomizer_DrawBossKey(GlobalContext* globalCtx, GetItemEntry* getItemEntry);
+extern "C" void Randomizer_DrawDoubleDefense(GlobalContext* globalCtx, GetItemEntry getItemEntry);
+
+#endif

soh/soh/Enhancements/randomizer/randomizer.cpp

@@ -19,6 +19,7 @@
 #include <stdexcept>
 #include "randomizer_check_objects.h"
 #include <sstream>
+#include "draw.h"
 
 using json = nlohmann::json;
 using namespace std::literals::string_literals;
@@ -4049,6 +4050,14 @@ void InitRandoItemTable() {
         ItemTableManager::Instance->AddItemEntry(MOD_RANDOMIZER, extendedVanillaGetItemTable[i].getItemId, extendedVanillaGetItemTable[i]);
     }
     for (int i = 0; i < ARRAY_COUNT(randoGetItemTable); i++) {
+        if (randoGetItemTable[i].itemId >= RG_FOREST_TEMPLE_SMALL_KEY && randoGetItemTable[i].itemId <= RG_GANONS_CASTLE_SMALL_KEY
+            && randoGetItemTable[i].itemId != RG_GERUDO_FORTRESS_SMALL_KEY) {
+            randoGetItemTable[i].drawFunc = (CustomDrawFunc)Randomizer_DrawSmallKey;
+        } else if (randoGetItemTable[i].itemId >= RG_FOREST_TEMPLE_BOSS_KEY && randoGetItemTable[i].itemId <= RG_GANONS_CASTLE_BOSS_KEY) {
+            randoGetItemTable[i].drawFunc = (CustomDrawFunc)Randomizer_DrawBossKey;
+        } else if (randoGetItemTable[i].itemId == RG_DOUBLE_DEFENSE) {
+            randoGetItemTable[i].drawFunc = (CustomDrawFunc)Randomizer_DrawDoubleDefense;
+        }
         ItemTableManager::Instance->AddItemEntry(MOD_RANDOMIZER, randoGetItemTable[i].itemId, randoGetItemTable[i]);
     }
 }

soh/src/code/z_draw.c

@@ -395,6 +395,20 @@ void GetItem_Draw(GlobalContext* globalCtx, s16 drawId) {
     sDrawItemTable[drawId].drawFunc(globalCtx, drawId);
 }
 
+/**
+ * Draw "Get Item" Model from a `GetItemEntry`
+ * Uses the Custom Draw Function if it exists, or just calls `GetItem_Draw`
+ */
+void GetItemEntry_Draw(GlobalContext* globalCtx, GetItemEntry getItemEntry) {
+    // RANDOTODO: Make this more flexible for easier toggling of individual item recolors in the future.
+    if (getItemEntry.drawFunc != NULL && 
+        (CVar_GetS32("gRandoMatchKeyColors", 0) || getItemEntry.getItemId == RG_DOUBLE_DEFENSE)) {
+        getItemEntry.drawFunc(globalCtx, &getItemEntry);
+    } else {
+        GetItem_Draw(globalCtx, getItemEntry.gid);
+    }
+}
+
 // All remaining functions in this file are draw functions referenced in the table and called by the function above
 
 /* 0x0178 */ u8 primXluColor[3];

soh/src/code/z_en_item00.c

@@ -1293,7 +1293,7 @@ void EnItem00_CustomItemsParticles(Actor* Parent, GlobalContext* globalCtx, GetI
                     color_slot = 0;
                     break;
                 case RG_DOUBLE_DEFENSE:
-                    color_slot = 1;
+                    color_slot = 8;
                     break;
                 default:
                     return;
@@ -1305,14 +1305,14 @@ void EnItem00_CustomItemsParticles(Actor* Parent, GlobalContext* globalCtx, GetI
 
     s16* colors[9][3] = {
         { 34, 255, 76 },   // Minuet and Magic Upgrades Colors
-        { 177, 35, 35 },   // Bolero and Double Defense Colors
+        { 177, 35, 35 },   // Bolero Colors
         { 115, 251, 253 }, // Serenade Color
         { 177, 122, 35 },  // Requiem Color
         { 177, 28, 212 },  // Nocturne Color
         { 255, 255, 92 },  // Prelude Color
         { 31, 152, 49 },   // Stick Upgrade Color
         { 222, 182, 20 },  // Nut Upgrade Color
-        { 255, 255, 255 }  // White Color placeholder
+        { 255, 255, 255 }  // Double Defense Color
     };
 
     s16* colorsEnv[9][3] = {
@@ -1381,7 +1381,7 @@ void EnItem00_DrawCollectible(EnItem00* this, GlobalContext* globalCtx) {
         GetItemEntry randoGetItemEntry =
             Randomizer_GetRandomizedItem(this->getItemId, this->actor.id, this->ogParams, globalCtx->sceneNum);
         EnItem00_CustomItemsParticles(&this->actor, globalCtx, randoGetItemEntry);
-        GetItem_Draw(globalCtx, randoGetItemEntry.gid);
+        GetItemEntry_Draw(globalCtx, randoGetItemEntry);
     } else {
         s32 texIndex = this->actor.params - 3;
 
@@ -1443,7 +1443,7 @@ void EnItem00_DrawHeartPiece(EnItem00* this, GlobalContext* globalCtx) {
         GetItemEntry randoGetItemEntry =
             Randomizer_GetRandomizedItem(GI_HEART_PIECE, this->actor.id, this->ogParams, globalCtx->sceneNum);
         EnItem00_CustomItemsParticles(&this->actor, globalCtx, randoGetItemEntry);
-        GetItem_Draw(globalCtx, randoGetItemEntry.gid);
+        GetItemEntry_Draw(globalCtx, randoGetItemEntry);
     } else {
         s32 pad;
 

soh/src/code/z_player_lib.c

@@ -1170,7 +1170,11 @@ void Player_DrawGetItemImpl(GlobalContext* globalCtx, Player* this, Vec3f* refPo
     Matrix_RotateZYX(0, globalCtx->gameplayFrames * 1000, 0, MTXMODE_APPLY);
     Matrix_Scale(0.2f, 0.2f, 0.2f, MTXMODE_APPLY);
 
+    if (this->getItemEntry.drawFunc != NULL && CVar_GetS32("gRandoMatchKeyColors", 0)) {
+        this->getItemEntry.drawFunc(globalCtx, &this->getItemEntry);
+    } else {
         GetItem_Draw(globalCtx, drawIdPlusOne - 1);
+    }
 
     CLOSE_DISPS(globalCtx->state.gfxCtx);
 }

soh/src/overlays/actors/ovl_Demo_Effect/z_demo_effect.c

@@ -2089,6 +2089,10 @@ void DemoEffect_DrawGetItem(Actor* thisx, GlobalContext* globalCtx) {
         if (gSaveContext.n64ddFlag && globalCtx->sceneNum == SCENE_BDAN) {
             GetItemEntry getItemEntry = Randomizer_GetItemFromKnownCheck(RC_BARINADE, RG_ZORA_SAPPHIRE);
             this->getItem.drawId = getItemEntry.gid;
+            func_8002EBCC(thisx, globalCtx, 0);
+            func_8002ED80(thisx, globalCtx, 0);
+            GetItemEntry_Draw(globalCtx, getItemEntry);
+            return;
         }
         func_8002EBCC(thisx, globalCtx, 0);
         func_8002ED80(thisx, globalCtx, 0);

soh/src/overlays/actors/ovl_En_Ex_Item/z_en_ex_item.c

@@ -524,6 +524,8 @@ void EnExItem_DrawItems(EnExItem* this, GlobalContext* globalCtx) {
         }
 
         EnItem00_CustomItemsParticles(&this->actor, globalCtx, randoGetItem);
+        GetItemEntry_Draw(globalCtx, randoGetItem);
+        return;
     }
 
     GetItem_Draw(globalCtx, this->giDrawId);
@@ -536,7 +538,7 @@ void EnExItem_DrawHeartPiece(EnExItem* this, GlobalContext* globalCtx) {
         GetItemEntry randoGetItem =
             Randomizer_GetItemFromKnownCheck(RC_MARKET_BOMBCHU_BOWLING_SECOND_PRIZE, GI_HEART_PIECE);
         EnItem00_CustomItemsParticles(&this->actor, globalCtx, randoGetItem);
-        GetItem_Draw(globalCtx, randoGetItem.gid);
+        GetItemEntry_Draw(globalCtx, randoGetItem);
     } else {
         GetItem_Draw(globalCtx, GID_HEART_PIECE);
     }

soh/src/overlays/actors/ovl_En_Si/z_en_si.c

@@ -184,7 +184,7 @@ void EnSi_Draw(Actor* thisx, GlobalContext* globalCtx) {
                 f32 mtxScale = 1.5f;
                 Matrix_Scale(mtxScale, mtxScale, mtxScale, MTXMODE_APPLY);
             }
-            GetItem_Draw(globalCtx, getItem.gid);
+            GetItemEntry_Draw(globalCtx, getItem);
         }
         
     }

soh/src/overlays/actors/ovl_Item_B_Heart/z_item_b_heart.c

@@ -99,8 +99,8 @@ void ItemBHeart_Draw(Actor* thisx, GlobalContext* globalCtx) {
     }
 
     if (gSaveContext.n64ddFlag) {
-        GetItem_Draw(globalCtx, Randomizer_GetRandomizedItem(GI_HEART_CONTAINER_2, 
+        GetItemEntry_Draw(globalCtx, Randomizer_GetRandomizedItem(GI_HEART_CONTAINER_2, 
-            this->actor.id,this->actor.params, globalCtx->sceneNum).gid);
+            this->actor.id,this->actor.params, globalCtx->sceneNum));
     } else {
         if (flag) {
             func_80093D84(globalCtx->state.gfxCtx);

soh/src/overlays/actors/ovl_Item_Etcetera/z_item_etcetera.c

@@ -233,7 +233,7 @@ void ItemEtcetera_DrawThroughLens(Actor* thisx, GlobalContext* globalCtx) {
             GetItemEntry randoGetItem = GetChestGameRandoGetItem(this->actor.room, this->giDrawId, globalCtx);
             EnItem00_CustomItemsParticles(&this->actor, globalCtx, randoGetItem);
             if (randoGetItem.itemId != ITEM_NONE) {
-                GetItem_Draw(globalCtx, randoGetItem.gid);
+                GetItemEntry_Draw(globalCtx, randoGetItem);
                 return;
             }
         }
@@ -257,7 +257,10 @@ void ItemEtcetera_Draw(Actor* thisx, GlobalContext* globalCtx) {
         EnItem00_CustomItemsParticles(&this->actor, globalCtx, randoGetItem);
 
         if (randoGetItem.itemId != RG_NONE) {
-            this->giDrawId = randoGetItem.gid;
+            func_8002EBCC(&this->actor, globalCtx, 0);
+            func_8002ED80(&this->actor, globalCtx, 0);
+            GetItemEntry_Draw(globalCtx, randoGetItem);
+            return;
         }
     }
 

soh/src/overlays/actors/ovl_Item_Ocarina/z_item_ocarina.c

@@ -218,7 +218,7 @@ void ItemOcarina_Draw(Actor* thisx, GlobalContext* globalCtx) {
     if (gSaveContext.n64ddFlag) {
         GetItemEntry randoGetItem = Randomizer_GetItemFromKnownCheck(RC_HF_OCARINA_OF_TIME_ITEM, GI_OCARINA_OOT);
         EnItem00_CustomItemsParticles(&this->actor, globalCtx, randoGetItem);
-        GetItem_Draw(globalCtx, randoGetItem.gid);
+        GetItemEntry_Draw(globalCtx, randoGetItem);
         return;
     }