Enhancement: Better Debug Warp MQ toggle

[stratomaster64]

Resolves #2860.
I don't think using SceneContext->opt for determining the MQ toggle is harmful considering that a) it does nothing in vanilla and b) this option is only available with better debug warp, maintaining the stance of keeping things authentic when possible.

Build Artifacts

• soh.otr.zip
• soh-linux-compatibility.zip
• soh-linux-performance.zip
• soh-mac.zip
• soh-switch.zip
• soh-windows.zip

[Archez]

Part of me wonders if this MQ selection behavior should be restricted to fileNum 255 (when using debug warp from title screen/file select, instead of within a valid save).

As it stands gBetterDebugWarpScreenMQFlag behaves one way when in a vanilla save, and behaves the opposite for a MQ save, which feels odd to me..
The other thing is this doesn't account for randomizer saves with mixed MQ and vanilla dungeons.

If we wanted the MQ toggle to work within saves too, I think the MQ toggle should automatically update and match the default status of the save (defaults to MQ in MQ saves, and defaults to the correct dungeon type in mixed rando saves). Then when navigating up/down between the dungeons itll update to match the correct default status.

This way someone testing warping to dungeons in a rando save will always be directed to the expected dungeon without having to read the spoiler log.

I'm curious to hear others thoughts on this.

[stratomaster64]

As it stands gBetterDebugWarpScreenMQFlag behaves one way when in a vanilla save, and behaves the opposite for a MQ save, which feels odd to me.. The other thing is this doesn't account for randomizer saves with mixed MQ and vanilla dungeons.

I'm currently looking at that now. It seems that on vanilla saves, it works properly but on MQ saves, it just forces MQ no matter what,

If we wanted the MQ toggle to work within saves too, I think the MQ toggle should automatically update and match the default status of the save (defaults to MQ in MQ saves, and defaults to the correct dungeon type in mixed rando saves). Then when navigating up/down between the dungeons itll update to match the correct default status.

This shouldn't be too hard to implement, I think,

[Archez]

As it stands gBetterDebugWarpScreenMQFlag behaves one way when in a vanilla save, and behaves the opposite for a MQ save, which feels odd to me.. The other thing is this doesn't account for randomizer saves with mixed MQ and vanilla dungeons.

I'm currently looking at that now. It seems that on vanilla saves, it works properly but on MQ saves, it just forces MQ no matter what,

It might be easier to have two CVars, one that says which type to load, and one that says to override the scene loading process.

[stratomaster64]

Upon further investigation, there doesn't seem to be a good way to grab gRandomizer's MQ dungeon list and bring it over to z_select.

[Archez]

Upon further investigation, there doesn't seem to be a good way to grab gRandomizer's MQ dungeon list and bring it over to z_select.

You should be able to use ResourceMgr_IsSceneMasterQuest. But you will need to remove the gPlayState check from the IsSceneMasterQuest method. Historically, we pulled the current scene value of play state hence the need of a null check, but it has since then been changed to accept the scene num as a param to the method. This renders the play state null check unneeded now.

Item tracker and Check tracker have an example of using extern C to expose ResourceMgr_IsSceneMasterQuest into a .cpp file.
And you will probably need to set the scene IDs somewhere in the data structs.

[briaguya-ai]

@stratomaster64 is this ready for another review?

[stratomaster64]

@stratomaster64 is this ready for another review?

Go for it!

[Archez]

You should be able to use ResourceMgr_IsSceneMasterQuest. But you will need to remove the gPlayState check from the IsSceneMasterQuest method.

Item tracker and Check tracker have an example of using extern C to expose ResourceMgr_IsSceneMasterQuest into a .cpp file.

And you will probably need to set the scene IDs somewhere in the data structs.

I'm still interested in this being done to make the warping more intelligent based on my original comment above. Is this something you'd be willing to do in this PR @stratomaster64 ? Otherwise I could handle it in a follow up PR.

[stratomaster64]

You should be able to use ResourceMgr_IsSceneMasterQuest. But you will need to remove the gPlayState check from the IsSceneMasterQuest method.
Item tracker and Check tracker have an example of using extern C to expose ResourceMgr_IsSceneMasterQuest into a .cpp file.
And you will probably need to set the scene IDs somewhere in the data structs.

I'm still interested in this being done to make the warping more intelligent based on my original comment above. Is this something you'd be willing to do in this PR @stratomaster64 ? Otherwise I could handle it in a follow up PR.

You can make a follow-up PR to this, I'm working on a few other things so I probably wouldn't be able to get to it on time.

[leggettc18]

I think this could do with some future cleanup about hiding the MQ option when it's not applicable (only one OTR) but I don't want to consider it a blocker since picking the "incompatible" option does correctly just do nothing right now.