Rando: More Misc. Hints #2930

stratomaster64 · 2023-05-31T02:47:35Z

Adds:

Saria as an NPC to receive a hint on where the progressive magic meter would be.
- The ability to utilize Saria's song to get this hint if you don't see her at her usual spots.
Hint for frog ocarina game by stepping on the platform near them in Zora's River.
Sheik as an NPC to receive the light arrows hint, when trials are required.
- You can see her in the Temple of Time and Ganon's Castle as adult.
- Ganondorf will only say the funny line, but this should allow light arrow hint to only need the rainbow bridge.
A function within randomizer.cpp to allow for context-sensitive message replacement...I'm guessing? It just ended up that way.
Hopefully we should hit hint parity once this makes it in.

Build Artifacts

soh/soh/Enhancements/randomizer/randomizer.cpp

Retain Saria's "face-to-face" text in rando if you're too close

stratomaster64 · 2023-07-07T01:06:58Z

May want to make this PR dependent on #2981 just so I can handle Sheik's MS hint text all in one go, rather than make a follow-up PR.

aMannus

Initial quick scan from me. Looks like it follows the same pattern as many other existing hints, so that's great. I do have some questions.

soh/soh/Enhancements/randomizer/3drando/hints.cpp

soh/soh/Enhancements/randomizer/randomizer.cpp

Malkierian · 2023-09-13T00:00:25Z

Other than what's been mentioned already by others, the code looks good to me. If I get around to actually playtesting it, I'll drop an approving review.

garrettjoecox

A few comments, solid wooooork

soh/soh/Enhancements/randomizer/randomizer.cpp

garrettjoecox · 2023-09-14T14:17:31Z

soh/soh/Enhancements/randomizer/randomizer.cpp

@@ -5229,6 +5274,70 @@ CustomMessage Randomizer::GetWarpSongMessage(u16 textId, bool mysterious) {
    return messageEntry;
 }

+CustomMessage Randomizer::GetMiscMessage(s16 scene, u16 originalTextId) {


I don't see much benefit to this being one function that splits into 3 blocks vs just 3 different functions personally. And the scene argument only seems relevant for the middle block

That being said, I think a lot of these custom message handlers could be cleaned up so up to you if you want to make the switch, I think this system will look a bit different for v3/v4 ™️

i also think splitting it into 3 makes sense
GetFrogMessage
GetSheikMessage
GetSariaMessage

we're already making calls for each from separate places in CustomMessage_RetrieveIfExists, so we might as well call into different methods.

it could be cool to see a bunch of the logic in CustomMessage_RetrieveIfExists moved out and cleaned up, but that feels like it should be its own PR

soh/soh/Enhancements/randomizer/randomizer.cpp

soh/soh/SaveManager.cpp

soh/src/code/z_play.c

Sheik no longer cheats with room transitions; Enforced text IDs on saria msg function

Co-authored-by: Garrett Cox <garrettjcox@gmail.com>

…ipwright into yet-more-hints

garrettjoecox

Noice.

soh/soh/Enhancements/mods.cpp

Co-authored-by: Garrett Cox <garrettjcox@gmail.com>

briaguya-ai

overall this is looking really good! couple little comments in there but nothing major.

briaguya-ai · 2023-09-14T22:35:20Z

soh/soh/Enhancements/mods.cpp

+void RegisterRandomizerSheikSpawn() {
+    GameInteractor::Instance->RegisterGameHook<GameInteractor::OnSceneSpawnActors>([]() {
+        if (!gPlayState) return;
+        bool canSheik = OTRGlobals::Instance->gRandomizer->GetRandoSettingValue(RSK_TRIAL_COUNT) != RO_GANONS_TRIALS_SKIP;


does it make sense to spawn sheik even when the light arrow hint is turned off? i think i'd vote to have sheik only appear when the setting is on.

It should be a combination of the two, as Sheik relies on LA hint and there being trials (otherwise you go to Ganondorf for LA hint).

briaguya-ai · 2023-09-14T22:39:13Z

soh/soh/Enhancements/randomizer/randomizer.cpp

@@ -5229,6 +5274,70 @@ CustomMessage Randomizer::GetWarpSongMessage(u16 textId, bool mysterious) {
    return messageEntry;
 }

+CustomMessage Randomizer::GetMiscMessage(s16 scene, u16 originalTextId) {


i also think splitting it into 3 makes sense
GetFrogMessage
GetSheikMessage
GetSariaMessage

we're already making calls for each from separate places in CustomMessage_RetrieveIfExists, so we might as well call into different methods.

it could be cool to see a bunch of the logic in CustomMessage_RetrieveIfExists moved out and cleaned up, but that feels like it should be its own PR

briaguya-ai · 2023-09-14T22:43:31Z

soh/soh/OTRGlobals.cpp

+            if (INV_CONTENT(ITEM_ARROW_LIGHT) == ITEM_ARROW_LIGHT || !Randomizer_GetSettingValue(RSK_LIGHT_ARROWS_HINT) ||
+                Randomizer_GetSettingValue(RSK_LIGHT_ARROWS_HINT) && Randomizer_GetSettingValue(RSK_GANONS_TRIALS)) {


i don't think we need this change. the point of light arrow hint outside of trials is people need the lights to get past the trials. it would be out of logic to get to dorf without them, and i guess i see no reason to not give the light arrow hint to someone who decides to trial skip past the sheik hint without lights.

briaguya-ai · 2023-09-14T22:50:27Z

soh/src/overlays/actors/ovl_En_Xc/z_en_xc.c

+         this->actor.flags |= ACTOR_FLAG_TARGETABLE | ACTOR_FLAG_FRIENDLY;
+        if (gSaveContext.n64ddFlag && gPlayState->sceneNum == SCENE_TEMPLE_OF_TIME) {
+            if (!CHECK_DUNGEON_ITEM(DUNGEON_KEY_BOSS, SCENE_GANONS_TOWER)) {
+                this->actor.textId = 0x700F;    


it'd be nice to use #defines or an enum for these instead of having them as magic numbers

I agree, although this file had the original text IDs as magic numbers.

briaguya-ai · 2023-09-14T22:50:43Z

soh/src/overlays/actors/ovl_En_Xc/z_en_xc.c

@@ -2401,6 +2432,9 @@ void EnXc_Init(Actor* thisx, PlayState* play) {
        case SHEIK_TYPE_0:
            EnXc_DoNothing(this, play);
            break;
+        case -1: //Special rando case


let's make this not a magic number

soh/soh/Enhancements/mods.cpp

garrettjoecox · 2023-09-15T03:22:40Z

soh/src/overlays/actors/ovl_En_Xc/z_en_xc.h

@@ -10,6 +10,7 @@ typedef void (*EnXcActionFunc)(struct EnXc*, PlayState*);
 typedef void (*EnXcDrawFunc)(struct Actor*, PlayState*);

 typedef enum {
+    /*-1 */ SHEIK_TYPE_RANDO = -1,


I don't think this really makes any real difference, but typically when I've added to source enums I'll add it to the end. Not sure if one is preferable over the other

I only really placed it there because of the number ordering.

what's the reasoning behind using -1 instead of 10 here? just curious

Weird that I have to do it from a specific tab in GH (thanks Microsoft), but see the comment below.

It's possible for the type to be something not in the enum with vanilla play but not negative?

I don't think so, but my reasoning was more along the lines of "this is intentionally meant for randomizer." Either -1 or 10 wouldn't matter anyway, as Sheik will kill her actor if the rando enum is used outside randomizer anyway.

Malkierian · 2023-09-15T18:15:44Z

soh/soh/Enhancements/randomizer/randomizer.cpp

+CustomMessage Randomizer::GetSariaMessage(u16 originalTextId) {
+    if (originalTextId == TEXT_SARIA_SFM || originalTextId == TEXT_SARIAS_SONG_FOREST_SOUNDS || TEXT_SARIAS_SONG_FOREST_TEMPLE) {
+        CustomMessage messageEntry = CustomMessageManager::Instance->RetrieveMessage(Randomizer::hintMessageTableID, TEXT_SARIAS_SONG_FACE_TO_FACE);
+        CustomMessage messageEntry2 = messageEntry;


Why do you instantiate a second messageEntry here? Why not operate on the first one in the rest of this function?

I remember having issues replacing the control character with the first custom message...maybe that's not the case anymore?

briaguya-ai

there are still a couple magic numbers in there (specifically in saria) but that can be a part of a bigger magic number cleanup effort later (and not part of this PR)

couple tiny naming/formatting nits but nothing blocking. i say we

soh/soh/Enhancements/randomizer/3drando/hints.cpp

soh/soh/Enhancements/randomizer/3drando/hints.hpp

soh/src/code/z_play.c

briaguya-ai · 2023-09-16T09:34:06Z

soh/src/overlays/actors/ovl_En_Xc/z_en_xc.h

@@ -10,6 +10,7 @@ typedef void (*EnXcActionFunc)(struct EnXc*, PlayState*);
 typedef void (*EnXcDrawFunc)(struct Actor*, PlayState*);

 typedef enum {
+    /*-1 */ SHEIK_TYPE_RANDO = -1,


what's the reasoning behind using -1 instead of 10 here? just curious

stratomaster64 · 2023-09-16T20:59:28Z

@briaguya-ai For some reason I'm not able to add to or reply to the comment regarding the rando type on Sheik. The theory was that the specific would never occur in gameplay unless intentionally set.

Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>

aMannus

I'd like to see the duplicate messageEntry that Malk mentioned be removed, and the -1 enum be changed, but those are both minor and not dealbreakers to me.

Nicely done 👍

stratomaster64 added 2 commits May 30, 2023 22:38

commit constipation

696e31f

Merge branch 'develop' into yet-more-hints

926073b

etreff reviewed May 31, 2023

View reviewed changes

soh/soh/Enhancements/randomizer/randomizer.cpp Outdated Show resolved Hide resolved

stratomaster64 added 2 commits May 31, 2023 09:49

fix inconsistencies between 3d and soh settings

78e2887

Add RSK check for Saria; Sheik now tells you other reqs for ganon

b040c2f

stratomaster64 marked this pull request as ready for review May 31, 2023 18:14

stratomaster64 and others added 5 commits June 1, 2023 18:46

Translations (thanks Purple and Timmy_GamerNepgear);

6472ae9

Retain Saria's "face-to-face" text in rando if you're too close

Merge branch 'develop' into yet-more-hints

694b85c

Merge branch 'HarbourMasters:develop' into yet-more-hints

142504f

Merge branch 'HarbourMasters:develop' into yet-more-hints

5058941

Merge branch 'HarbourMasters:develop' into yet-more-hints

9bc5cea

leggettc18 added this to the MacReady milestone Jun 21, 2023

Merge branch 'HarbourMasters:develop' into yet-more-hints

a8793e3

stratomaster64 added 3 commits July 6, 2023 21:10

Merge branch 'HarbourMasters:develop' into yet-more-hints

01ac7e3

Merge branch 'HarbourMasters:develop' into yet-more-hints

9716c1f

Merge branch 'develop' into yet-more-hints

4cf2354

stratomaster64 requested review from garrettjoecox, Archez and leggettc18 August 14, 2023 00:55

stratomaster64 and others added 5 commits August 29, 2023 20:49

Merge branch 'HarbourMasters:develop' into yet-more-hints

e9eb312

Merge branch 'develop' into yet-more-hints

dc34ad7

fix scene renames for sheik

aade4d1

whoops

2975251

Undo LA hint setting erasure from conflict

ec9421d

aMannus reviewed Sep 12, 2023

View reviewed changes

stratomaster64 added 3 commits September 12, 2023 21:20

Clarified Sheik text IDs; Clarified final frogs hint

0e6ace0

Fixed Sheik text ID assignment; Fixed Saria's messages in OTRGlobals

55e2603

Added hint locs for sheik and saria

f34a5fb

garrettjoecox reviewed Sep 14, 2023

View reviewed changes

stratomaster64 and others added 4 commits September 14, 2023 12:46

Set up hook for Sheik spawn;

5065b94

Sheik no longer cheats with room transitions; Enforced text IDs on saria msg function

Set up hook for Sheik spawn;

9337475

Sheik no longer cheats with room transitions; Enforced text IDs on saria msg function

Update soh/soh/SaveManager.cpp

271a649

Co-authored-by: Garrett Cox <garrettjcox@gmail.com>

Merge branch 'yet-more-hints' of https://github.com/stratomaster64/Sh…

2d8a553

…ipwright into yet-more-hints

garrettjoecox approved these changes Sep 14, 2023

View reviewed changes

soh/soh/Enhancements/mods.cpp Outdated Show resolved Hide resolved

stratomaster64 and others added 3 commits September 14, 2023 14:33

nice.gif

6dae3d1

Co-authored-by: Garrett Cox <garrettjcox@gmail.com>

got ahead of myself

90815ed

Merge branch 'HarbourMasters:develop' into yet-more-hints

891cd80

briaguya-ai reviewed Sep 14, 2023

View reviewed changes

Archez reviewed Sep 14, 2023

View reviewed changes

soh/soh/Enhancements/mods.cpp Show resolved Hide resolved

Conquered and divided; simplified stuff

9ab565b

garrettjoecox reviewed Sep 15, 2023

View reviewed changes

Malkierian reviewed Sep 15, 2023

View reviewed changes

briaguya-ai approved these changes Sep 16, 2023

View reviewed changes

stratomaster64 and others added 4 commits September 16, 2023 17:00

Merge branch 'develop' into yet-more-hints

89edd30

nitpicking

88e7e79

Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>

Apply suggestions from code review

9cd28d3

Co-authored-by: briaguya <70942617+briaguya-ai@users.noreply.github.com>

the little things i stg

6787868

aMannus approved these changes Sep 17, 2023

View reviewed changes

garrettjoecox merged commit c3a1eb2 into HarbourMasters:develop Sep 19, 2023
8 checks passed

stratomaster64 deleted the yet-more-hints branch November 8, 2023 02:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rando: More Misc. Hints #2930

Rando: More Misc. Hints #2930

stratomaster64 commented May 31, 2023 •

edited by github-actions bot

Loading

stratomaster64 commented Jul 7, 2023

aMannus left a comment

Malkierian commented Sep 13, 2023

garrettjoecox left a comment

garrettjoecox Sep 14, 2023

briaguya-ai Sep 14, 2023

garrettjoecox left a comment

briaguya-ai left a comment

briaguya-ai Sep 14, 2023

stratomaster64 Sep 14, 2023

briaguya-ai Sep 14, 2023

briaguya-ai Sep 14, 2023

briaguya-ai Sep 14, 2023

stratomaster64 Sep 14, 2023

briaguya-ai Sep 14, 2023

garrettjoecox Sep 15, 2023

stratomaster64 Sep 15, 2023

briaguya-ai Sep 16, 2023

stratomaster64 Sep 16, 2023

briaguya-ai Sep 16, 2023

stratomaster64 Sep 17, 2023

Malkierian Sep 15, 2023

stratomaster64 Sep 15, 2023

briaguya-ai left a comment

briaguya-ai Sep 16, 2023

stratomaster64 commented Sep 16, 2023

aMannus left a comment

		if (INV_CONTENT(ITEM_ARROW_LIGHT) == ITEM_ARROW_LIGHT \|\| !Randomizer_GetSettingValue(RSK_LIGHT_ARROWS_HINT) \|\|
		Randomizer_GetSettingValue(RSK_LIGHT_ARROWS_HINT) && Randomizer_GetSettingValue(RSK_GANONS_TRIALS)) {

Rando: More Misc. Hints #2930

Rando: More Misc. Hints #2930

Conversation

stratomaster64 commented May 31, 2023 • edited by github-actions bot Loading

Build Artifacts

stratomaster64 commented Jul 7, 2023

aMannus left a comment

Choose a reason for hiding this comment

Malkierian commented Sep 13, 2023

garrettjoecox left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

garrettjoecox left a comment

Choose a reason for hiding this comment

briaguya-ai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

briaguya-ai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stratomaster64 commented Sep 16, 2023

aMannus left a comment

Choose a reason for hiding this comment

stratomaster64 commented May 31, 2023 •

edited by github-actions bot

Loading