Wrong section of “Void Creep” played when returning to grappling_hook_start

[wjt]

Threadbare version

v0.1.11-38-g9866dd86

Affected scene

res://scenes/quests/lore_quests/quest_002/2_grappling_hook/grappling_hook_start.tscn

Description

Void Creep is played through quest_002/2_grappling_hook. The music is split into three clips and the progression is meant to be as follows:

1. Player enters grappling_hook_start. The opening dialogue plays and the background music switches to Creep Intro
2. Creep Intro auto-advances to Creep Loop
3. Every other scene of this section sets the clip to "Creep Loop", so it keeps playing
4. When the player returns to the starting area after collecting the power-up, queue up a transition to "Creep Outro". This transitions waits for the end of Creep Loop (up to 106 seconds) then switches cleanly to Creep Outro, which is a 10-second outro. The hope is that this will happen around the time the player reaches the collectible.
5. Creep Outro auto-advances to Still, setting things up for 3_void_grappling.

Prior to #2032 this was very simple: step 4 was actually not the same scene as step 1, but a copy, grappling_hook_end.tscn, so the BackgroundMusic node was just set to play Creep Outro.

Since #2032 the copy was eliminated and the player actually does return to the same scene. There is some custom logic to skip the opening dialogue. However the Creep Outro logic was lost. As a result the music abruptly cuts back to Creep Intro at step 4.

Checklist

• I've reviewed and agree to follow the code of conduct

[wjt]

As an aside: in theory you can set a loop region of an AudioStream so that rather than splitting the Intro from the Loop, we could just have one stream that plays through and then, when it loops, jumps to bar 5 (start of current Creep Loop) rather than the beginning.

I didn't do this because I remembered that I previously found that loop_offset doesn't work with sample playback mode, which is how audio is played on the web by default: godotengine/godot#100955

If we could use this, it would be much easier to fix this bug:

1. Combine Creep Intro and Creep Loop clips into "Creep 5000"
2. Set all 2_grappling_hook scenes to play the new "Creep 5000" clip
3. Add a ClipSwitcher, triggered by the player entering some area in grappling_hook_start that can't be reached without the powerup, which switches to Creep Outro

As I type this, I realise: I think that because we are using AudioStreamInteractive, in effect we are forcing the "stream" playback type, and so I think this should work. I'll try this.

(And if not… how hard can it possibly be to implement loop_offset for the sample playback mode.)

[wjt]

As I type this, I realise: I think that because we are using AudioStreamInteractive, in effect we are forcing the "stream" playback type, and so I think this should work. I'll try this.

Nope - sadly not.