Skip to content

fix: Skip GetItem animation for externally received other-slot items #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
keraion wants to merge 1 commit into
base: Harkipellago
Choose a base branch
from
Open

fix: Skip GetItem animation for externally received other-slot items #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 44 additions & 11 deletions soh/soh/Enhancements/randomizer/hook_handlers.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,12 +226,24 @@ bool MeetsRainbowBridgeRequirements() {
}

// Todo Move this to randomizer context, clear it out on save load etc
static std::queue<RandomizerCheck> randomizerQueuedChecks;
// isExternal marks checks we didn't physically collect (e.g. an AP location checked off because another player
// released their items), so we can skip the GetItem animation for items that are only for other slots.
struct QueuedCheck {
RandomizerCheck rc;
bool isExternal;
};
static std::queue<QueuedCheck> randomizerQueuedChecks;
static RandomizerCheck randomizerQueuedCheck = RC_UNKNOWN_CHECK;
static GetItemEntry randomizerQueuedItemEntry = GET_ITEM_NONE;

// Set while RandomizerOnExternalCheckHandler runs. It finishes some checks by calling Flags_Set* for the current
// scene, which fires the flag-set hooks below; this lets those hooks know the check came from outside and not
// from the player walking into it. Main thread only. Relies on the flag-set hooks firing synchronously from
// within Flags_Set* (true today) - if they ever become deferred this flag would already be cleared when they run.
static bool sProcessingExternalCheck = false;

void ArchipelagoOnReceiveItem(const int32_t item) {
randomizerQueuedChecks.push(RC_ARCHIPELAGO_RECEIVED_ITEM);
randomizerQueuedChecks.push({ RC_ARCHIPELAGO_RECEIVED_ITEM, false });
Rando::Context::GetInstance()->AddReceivedArchipelagoItem(static_cast<RandomizerGet>(item));
}

Expand Down Expand Up @@ -282,7 +294,7 @@ void RandomizerOnFlagSetHandler(int16_t flagType, int16_t flag) {
}
}
SPDLOG_INFO("Queuing RC: {}", static_cast<uint32_t>(rc));
randomizerQueuedChecks.push(rc);
randomizerQueuedChecks.push({ rc, sProcessingExternalCheck });
}

void RandomizerOnSceneFlagSetHandler(int16_t sceneNum, int16_t flagType, int16_t flag) {
Expand Down Expand Up @@ -351,10 +363,19 @@ void RandomizerOnSceneFlagSetHandler(int16_t sceneNum, int16_t flagType, int16_t
return;

SPDLOG_INFO("Queuing RC: {}", static_cast<uint32_t>(rc));
randomizerQueuedChecks.push(rc);
randomizerQueuedChecks.push({ rc, sProcessingExternalCheck });
}

void RandomizerOnExternalCheckHandler(uint32_t randomizerCheck) {
// Flag anything queued during this call as external, including checks the Flags_Set* calls below bounce back
// through the flag-set hooks. The guard clears it however we return.
sProcessingExternalCheck = true;
struct ExternalCheckGuard {
~ExternalCheckGuard() {
sProcessingExternalCheck = false;
}
} externalCheckGuard;

RandomizerCheck rc = static_cast<RandomizerCheck>(randomizerCheck);
Rando::Location* loc = Rando::StaticData::GetLocation(rc);
s32 flagID = loc->GetCollectionCheck().flag;
Expand All @@ -371,7 +392,7 @@ void RandomizerOnExternalCheckHandler(uint32_t randomizerCheck) {
// happens, leading to a double chest spawn.
if (rc == RC_HF_OCARINA_OF_TIME_ITEM || rc == RC_ICE_CAVERN_IRON_BOOTS_CHEST || rc == RC_FOREST_TEMPLE_BOW_CHEST ||
rc == RC_TOT_MASTER_SWORD) {
randomizerQueuedChecks.push(rc);
randomizerQueuedChecks.push({ rc, true });
return;
}

Expand All @@ -383,15 +404,15 @@ void RandomizerOnExternalCheckHandler(uint32_t randomizerCheck) {
Flags_SetTreasure(gPlayState, flagID);
} else {
gSaveContext.sceneFlags[scene].chest |= 1 << flagID;
randomizerQueuedChecks.push(rc);
randomizerQueuedChecks.push({ rc, true });
}
break;
case SPOILER_CHK_COLLECTABLE:
if (inSameArea) {
Flags_SetCollectible(gPlayState, flagID);
} else {
gSaveContext.sceneFlags[scene].collect |= 1 << flagID;
randomizerQueuedChecks.push(rc);
randomizerQueuedChecks.push({ rc, true });
}
break;
case SPOILER_CHK_RANDOMIZER_INF:
Expand All @@ -407,7 +428,7 @@ void RandomizerOnExternalCheckHandler(uint32_t randomizerCheck) {
Flags_SetInfTable(flagID);
break;
case SPOILER_CHK_GOLD_SKULLTULA:
randomizerQueuedChecks.push(rc);
randomizerQueuedChecks.push({ rc, true });
// Below doesn't work, temporarily disabled until a solution is found
// SET_GS_FLAGS((flagID & 0x1F00) >> 8, flagID & 0xFF);
break;
Expand Down Expand Up @@ -442,7 +463,8 @@ void RandomizerOnPlayerUpdateForRCQueueHandler() {
}

GetItemEntry getItemEntry;
RandomizerCheck rc = randomizerQueuedChecks.front();
QueuedCheck queuedCheck = randomizerQueuedChecks.front();
RandomizerCheck rc = queuedCheck.rc;
auto loc = Rando::Context::GetInstance()->GetItemLocation(rc);
uint8_t isGiSkipped = 0;

Expand Down Expand Up @@ -477,7 +499,18 @@ void RandomizerOnPlayerUpdateForRCQueueHandler() {
SPDLOG_INFO("Queuing Item mod {} item {} from RC {}", getItemEntry.modIndex, getItemEntry.itemId,
static_cast<uint32_t>(rc));

if (
// Items only meant for other slots have no value here, so when they show up from an external check we just
// need the location flagged. Skip their GetItem animation no matter what the SkipGetItemAnimation setting is.
bool isItemForAnotherPlayer =
getItemEntry.modIndex == MOD_RANDOMIZER &&
(getItemEntry.getItemId == RG_ARCHIPELAGO_ITEM_PROGRESSIVE ||
getItemEntry.getItemId == RG_ARCHIPELAGO_ITEM_USEFUL || getItemEntry.getItemId == RG_ARCHIPELAGO_ITEM_JUNK);

if (queuedCheck.isExternal && isItemForAnotherPlayer) {
Item_DropCollectible(gPlayState, &spawnPos, static_cast<int16_t>(ITEM00_SOH_GIVE_ITEM_ENTRY | 0x8000));

isGiSkipped = 1;
} else if (
// Skipping ItemGet animation incompatible with checks that require closing a text box to finish
!(rc == RC_HF_OCARINA_OF_TIME_ITEM && gPlayState->sceneNum == SCENE_HYRULE_FIELD) &&
!(rc == RC_SPIRIT_TEMPLE_SILVER_GAUNTLETS_CHEST && gPlayState->sceneNum == SCENE_DESERT_COLOSSUS) &&
Expand Down Expand Up @@ -2875,7 +2908,7 @@ static void RandomizerRegisterHooks() {
// Add condition around this to only fire when loading into an Archipelago save file
ShipInit::Init("IS_ARCHIPELAGO");

randomizerQueuedChecks = std::queue<RandomizerCheck>();
randomizerQueuedChecks = std::queue<QueuedCheck>();
randomizerQueuedCheck = RC_UNKNOWN_CHECK;
randomizerQueuedItemEntry = GET_ITEM_NONE;

Expand Down