[BUGFIX] Fix Two Issues With Song Text on Freeplay Capsules

[VioletSnowLeopard]

Linked Issues

Fixes #4876. Fixes #2659.

Description

When switching song lists (changing filters or difficulties) from a song not in the new list, its text would remain highlighted when you switched back to the list it is in. This PR fixes the issue by setting the selected value of the capsule to false before the song list might change.

I also made an adjustment in SongMenuItem.hx to fix the squashed text. A detailed description of the change is in a comment below.

Screenshots/Videos

Video of song text not being highlighted:

song-text-not-highlighted.mp4

After the 0.6.4 update, there were three scenarios I found that would always result in a capsule having squished text which is shown below:

song-text-squish.mp4

Here, you can see these same scenarios no longer produce squished text:

no-text-squish.mp4

[Hundrec]

Could it really be? The one to fix the squashed text?

[VioletSnowLeopard]

Could it really be? The one to fix the squashed text?

Would be funny since it wasn't the issue I was originally trying to fix.

[Lasercar]

Now we just have to figure out why the capsules started sometimes getting that weird y offset in 0.6

Also, I find it funny that's despite the squashed text being unintentionally fixed, we still don't know how exactly it's caused in the first place

[trayfellow]

Could it really be? The one to fix the squashed text?

Hundrec. I Need A Compiled Build. I Need To Test This. Yeah I Can't Be Bothered To Waste 20GB On My Storage Space For Funkin'

[VioletSnowLeopard]

Could it really be? The one to fix the squashed text?

Hundrec. I Need A Compiled Build. I Need To Test This. Yeah I Can't Be Bothered To Waste 20GB On My Storage Space For Funkin'

If you want a compiled build for Windows, I can zip the one I have. You can download it here if you want to try it.

[JVNpixels]

thats it? just 2 lines? thats all it takes to fix 2 of my annoyances of the freeplay menu?

[Hundrec]

aw

I got this by entering and exiting Stress on Hard

(This does fix the highlighting though)

[Lasercar]

aw

I got this by entering and exiting Stress on Hard

(This does fix the highlighting though)

We've been foiled again by the squashed text

[VioletSnowLeopard]

aw
I got this by entering and exiting Stress on Hard

(This does fix the highlighting though)

Are you able to get this consistently? Did you do anything before entering Stress? Because I can't seem to get this to occur.

[trayfellow]

aw
I got this by entering and exiting Stress on Hard
(This does fix the highlighting though)

We've been foiled again by the squashed text

My worst enemy.... just like The Lich from Adventure Time, this stupid thing just wont go away no matter what

[VioletSnowLeopard]

With this PR, I have found a way to reliably reproduce the squashed text on one of the capsules. I can try to figure out how it happens through debugging later.

[Hundrec]

I left a comment under the squashed text issue outlining how to reproduce the bug by switching variations. Hopefully that's helpful!

[VioletSnowLeopard]

Using debugging, I have found the problematic function. Whenever a capsule has squashed text, its x scale has a value of 0.4 and its y scale has a value of 1.4. The function that sets the text's scale values to this is textAppear. It seems that sometimes the second FlxTimer fails to work so the text's scales aren't reset to 1.

The purpose of textAppear is to make the text do a little jump back and forth animation. You can see this whenever you hit confirm on a song. Apparently this also happens to all capsules whenever changing difficulties or entering the menu, although I've never noticed it. I believe it happens at a point before the capsules are visible again.

Considering textAppear is the function that causes this issue and its functionality isn't ever noticeable aside from hitting confirm on a song, I removed the call to the function in setVisibleGrp. To allow it to still work when hitting confirm on a song, I added a call to it inside the confirm function in SongMenuItem.

[AbnormalPoof]

It was that simple??

[VioletSnowLeopard]

I mean, at first I tried to call the song text's resetText function in various places to try and reset the scale of the text, but it didn't work. So I just decided that the song text scale should not be changed when switching difficulties.

[Hundrec]

Thanks for investigating! It's time to stress test this to the max!

[Hundrec]

I think you've done it!
You've finally freed us from this curse...

[VioletSnowLeopard]

I think you've done it! You've finally freed us from this curse...

The cursed function textAppear

[AbnormalPoof]

peak

[JackXson-Real]

Merge this PR immediately! 🗣️ 🔥

[Lasercar]

Thought I'd try making the timers a variable and only allow it to be set if it's null or finished to see if it'd fix it and nope!

It seems to do it the first time you letter switch, so yeah, just disable it entirely, I've had enough.

[Kade-github]

very good, will be merged in the next update.