Amend button descriptions in game selection menu#51
Open
BenHetherington wants to merge 7 commits intoOffBroadway:custom-loader-menufrom
Open
Amend button descriptions in game selection menu#51BenHetherington wants to merge 7 commits intoOffBroadway:custom-loader-menufrom
BenHetherington wants to merge 7 commits intoOffBroadway:custom-loader-menufrom
Conversation
This makes the ‘Control Stick: Select’, ‘B: Cancel’, and ‘A: Confirm’ descriptions appear while in the game selection menu, while still keeping just ‘B: Cancel’ when on the ‘Press Start’ screen. To do this, this patches the function that updates the button descriptions, replacing two jump table entries, allowing our own code to be run (and determine which descriptions to display) while within the gameplay menu.
Compared to just using `asm()` in the .c file, this seems a bit more readable to me, and allows the assembly code to use the `r3` alias in `asm.h`.
BenHetherington
commented
Apr 10, 2025
patches/source/button_descriptions.c
Outdated
| update_element_alpha(&all_element_alphas->text.three_columns.centre_finish, true); | ||
|
|
||
| // Show 'B: Cancel' on both the loader and start screens | ||
| update_element_alpha(&all_element_alphas->text.three_columns.centre_cancel, false); |
Author
There was a problem hiding this comment.
Oh, one difference from the original is that even 'B: Cancel' was conditional on something there, but I wasn't able to work out what that something was. I haven't replicated that condition here, but it could be worth double-checking if we should.
Author
There was a problem hiding this comment.
I think I later found that this hid itself if the 'an error has occurred' message is displayed. I don't think I'll lose much sleep if we just don't replicate that 😛
Rather than patching jump tables to point to unrelated addresses, and then having to jump back to the original code, this just replaces the code at the original jump target instead.
Based on the element alpha code for the disc/FlippyDrive selection UI, this: - Wraps `update_button_alphas()` - for now just calling the original function - Moves element alpha structs and functions to its own file - Updates the `element_alpha_state_t`, to name more members - Updates `update_element_alpha` to take a `element_alpha_update_state_t` enum, rather than the `bool` that was there before (as this function also supports a ‘dimmed’ state)
This replaces the patches-within-a-jump-table with straightforward C calls in the `patch_update_button_alphas()`. Either we run the original code, or we call our custom update functions.
The standard `update_button_alphas` has some additional code on PAL systems to update the button alphas for the different languages. This reimplements this behaviour when using custom button description updates.
Author
|
While looking at re-adding disc drive support (and UI for switching between the disc/FlippyDrive), I ended up touching a fair bit of related code. So, I've updated this review to include those updates. Additionally, I've simplified how this works by wrapping the entire function, rather than patching specific parts of jump tables in the original assembly 🙂 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This makes the ‘Control Stick: Select’, ‘B: Cancel’, and ‘A: Confirm’ descriptions appear while in the game selection menu, while still keeping just ‘B: Cancel’ when on the ‘Press Start’ screen.
To do this, this patches the function that updates the button descriptions, replacing two jump table entries, allowing our own code to be run (and determine which descriptions to display) while within the gameplay menu.
Note that I've only been able to test on PAL 1.0, so please do test on other versions before merging! Cc: @trevor403