Loadless timer, death counter, R menuing

[eddynya]

Features

---

Loadless Timer (storytimer.cpp)

Main new features/changes

• breakdown screen now shows death counts per world
• breakdown screen has a totals row
• smarter resetting (more on that below)
• less code duplication
  • using format_time_to_buffer() in timerdisp.cpp to create the rows for the breakdown screen now
  • instead of having massive bricks of submode checks, all that is handled by functions in mode.cpp
• nicer looking timer incrementing between worlds/stages
  • the timer no longer stops for a frame, then skips a frame to capture every frame of the 10 ball screen spin in
  • now I just hook mkb::g_handle_storymode_stageselect_state
  • no longer incrementing the timer during the two 1 frame long submodes that sandwich each stage (game first init, and game scenario return) for cosmetic reasons

Death Counter (deathcounter.cpp)

• tracks savestate deaths now
• per-world deaths are tracked so that info can be used by the breakdown screen

R Menuing (menu_accel.cpp)

• QOL for story mode runs

Util files

---

Timer Disp (timerdisp.cpp)

Rewrote the main draw_timer() function using format_time_to_buffer(), which includes lots of different formatting options with leading 0s. For specific situations where we want to draw 2 timers at once (like the breakdown screen), you'd want to combine format_time_to_buffer() with draw::debug_text(), and those situations should be handled on a per case basis in their respective file

Mode (mode.cpp)

Collects a lot of submode/main game mode/scenario mode checks in one place for convenience and reusability

Goal (goal.cpp)

Checks that happen on tape break go here (and won't be delayed like checking for the goal submodes). Story mode "status" functions that rely on tape break checks also go here (is_between_worlds(), is_run_complete()). It made more sense to make a new file and separate this from validate.cpp to try and decouple the responsibilities of each file

Story Reset (storyreset.cpp)

Common resetting logic used by deathcounter.cpp and storytimer.cpp. The timers/death counter no longer reset on entering the filescreen to account for accidental exit games to the menu. Resets are triggered by

• using gotostory
• completing a run and returning to the menus
• exit game-ing to the menus, and going to the wrong menu (challenge mode, practice mode, or the main menu)
• selecting the wrong file
• using the IW picker on the file the run was being done on

Other Changes

---

Savestates

Reverted to using the History struct, I do like this more since I feel like if the situation comes up where another file other than deathcounter.cpp needs to know if we loaded a state this frame, we'd have to duplicate the frame history logic. I can revert this if you'd prefer doing the frame history logic in the file itself

Story Validation Mark

I added a new setting that only shows at the end of the run; this functions as a way to show the prac mod/timer version you're on without having to show the mark on every single stage of the run

Additional Notes

---

These are my personal notes I started writing before making the PR and have more details than what's above; this is just a direct copy/paste of those with slight changes. I'm including these just in case they're helpful since my thought process for some things are explained as well as some ideas for different ways of doing things.

• Why certain files exist
  • goal.cpp
    • utility file, i started by stuffing this logic in validate.cpp but decided doing that was kinda bad. The reason being is that doing goal checks on tape break is generally a pretty useful thing, so it's very possible the following situation could happen in the future:
      • a new mod, newmod.cpp, gets added to prac mod
      • newmod.cpp, when enabled, would invalidate il runs
        • So validate might need to include newmod.h (like how validate currently includes physics.h)
      • newmod.cpp also relies on doing goal checks at tape break
      • If goal.cpp didn't exist and we used validate::has_entered_goal(), then we would create the following circular include chain:
        • validate -> newmod -> validate
  • storyreset.cpp
    • I had to update the loadless timer to have smarter resetting on the menus (for if you fully exit game to the menu by accident since it happened to nambo in playtesting)
    • Since this logic is shared by both storytimer.cpp and deathcounter.cpp, it made sense to make this a common dependency for both of them
  • mode.cpp
    • really useful utility file i made for switch up's wsmod
    • this is mostly to avoid big bricks of submode checks, just like to make things more concise but (i hope) still be readable/clear
    • I didn't remove all unused functions in there since I more or less ported it from my wsmod. I decided to keep a lot of the stuff in there since it could be useful in the future, but I can prune it more if you like tho
• Other notes per file
  • storytimer.cpp
    • I changed the behavior of the timer a bit, this was for cosmetic reasons and doesn't change whether or not the timer is loadless. Now, I don't include the game scenario return frame and the game first init frame in the timer.
    • The cosmetic reasons:
      • pressing A to stage select out of a stage to the first possible A press frame on the 10 ball screen now is a difference of exactly 2 seconds/120 frames on the timer (before it was 121)
      • pressing A on the 10 ball screen to holding A and dropping into the next stage is now a difference of 240 frames on the timer (before it was 241)
  • menu_accel.cpp
    • Option for story mode R menuing tech
    • gone are the days of tape and rubber bands (thank u rehtrop for helping me find where this was in ghidra)
    • there might have to be discussion at some point on if this would be ok being added, there was a discussion at some point and it seemed like a lot of people were on board but not everyone was
      • (i personally see no issue it's effectively the same thing as perma taping down your R button in a story mode run, but it's probably good to be sure it's ok)
  • ppcutil.h
    • ported some things from switch up's wsmod and euc's wsmod
  • ilmark.cpp
    • I added an option to the story IL mark pref, the options now are:
      • Off, always on in story, at the end of a story run
    • I moved the snippet of logic for romhack validation marks above just to emphasize a lil more that it's a blanket statement, ie turning off romhack il marks makes the other settings not matter in a romhack
  • gotostory.cpp
    • added a getter so storyreset.cpp can know when we use go to story
  • timerdisp.cpp
    • the main addition here is the format_time_to_buffer() function, really useful for avoiding code duplication when drawing the formatted breakdown screen that the loadless timer uses
    • I ported this from switch up's wsmod and there I had already added several different formatting options with leading 0s and stuff. Feel free to remove the unused formats, I just kept them there since they may be nice to have in the future
    • i also rewrote draw_timer() using format_time_to_buffer()
    • there's still a potential simplification i can make to draw_timer(), namely i could get rid of the text_offset argument entirely, and have pos_x refer to the position where the numbers get drawn (and not the left side of the text)
      • in all use cases of the function, we want our timers to be aligned according to the left side of the numbers (and not the left side of the prefix)
      • the text would be automatically positioned based on the length of the text and draw::DEBUG_CHAR_WIDTH
      • the reason i held off on doing this is that this creates a bit of an inconsistency, pos_x when using draw_timer() would refer to where the numbers are drawn, but when using draw::debug_text(), it would refer to the left side of the entirety of the text
      • (if you think i should go through with this change i can do so)
  • savest.cpp
    • i reverted back to the version of the file with the History struct, this was mostly because i feel like this avoids potentially repeating logic in the future if we want to know if we loaded a state this frame (if more than one file needs to do this)
    • i can go back to the version without the history struct if you'd prefer i do that logic in deathcounter.cpp
  • storyreset.cpp
    • Honestly the stuff with trying to be minimal with displaying the reset run message when the pref for hiding it is off might be overcomplicated?
    • tldr how it works when we have the hide reset message pref off,
      1. if all timer/counter prefs off, don't show a message
      2. if used go to story, or if you already completed the run, no need to display a message since those are clear reset triggers
      3. only display a message if the run gets reset and no timers/counters are visible on the screen (except in case (1) above)
    • idk, just displaying a message on any reset event when the hide message pref is off might be worth out of simplicity even if it results in a lot more "redundant" reset messages
  • validate.cpp
    • this was a one line change i had to make bc of going back to an earlier version of savest.cpp
    • important note: checking if the current action is a load allows for pressing the create state button for 1f to be considered valid
      • Old prac mod versions didn't do this, but this is what the version of validate I started off of does. I decided to make my version consistent with the older behavior. To revert to the new behavior, I would use state_changed_gameplay() instead of interacted_with_state()
      • Now, pressing the create state button for 1f shouldn't change gameplay at all since you're not freezing the game, so my personal opinion is that it's fine allowing this, but i think this is the kind of thing that would need discussion with other ppl
  • Misc
    • Sorry for the big comment bricks in places, I don't know if that's bad style or something. For example in goal.cpp, the code got to where it is after several iterations and so there were a number of things in my head that were relevant to why I decided to do things that way, I don't know if the long comments there fully explain everything.
  • Complete list of newly added or changed prefs/menu stuff (NOTE: I wrote this before the pref system was updated and bool pref/u8 prefs were combined)
    • Loadless timer
      • fullgame timer options (u8 pref)
      • segment timer options (u8 pref)
      • show run breakdown (bool pref)
      • hide run reset message (bool pref)
    • Death counter
      • death counter display options (u8 pref)
      • count stage 1 deaths (bool pref)
    • R menuing
      • u8 pref
    • IL mark
      • story il mark is now a u8 pref