Summary screen

[emilyploszaj]

Replaces the old stats screen with the new and improved summary screen. Mostly functional, but slightly incomplete.

summary.mp4

I would not consider this ready to merge and be played (the way 9bit has an active playerbase) for mostly visual issues. It may be reasonable to have a short lived summary screen branch off of 9bit on this main repo so that multiple people can contribute to knocking out the last couple issues and get this out the door.

Code has been documented to the best of my ability when I was writing it, but it's been written over so many months at this point that multiple authors may as well have had their hands in it. Implementation ideas and reasons have been discussed over several long conversations that at this point it is probably easier to simply respond to questions than try to explain everything.

Outstanding TODOs in the summary screen file, copied for posterity

• use/make proper vblank routine to remove flicker due to music (other existing ones cause freezes, maybe because of GFX decompression requests?) (SafeCopyTilemapAtOnce would be great, but it causes hblanks to be missed, a dedicated routine would be required)
• entire egg page
• status indication (including palette allocation)
• nature indicators (red/blue stats)
• allow swapping move order
• replace move learning page
• remove party moves screen (by replacing it properly)
• fix artifacts when exiting PC or in battle summary

This is certainly not comprehensive, the summary screen has some artifacting and non-perfect transitions that would be good to polish over as well.

Some things I'd like to further do or seen done for the summary screen code wise that aren't necessarily functional

• Further remove all references to the "stats screen" in symbols, files, and documentation and otherwise and replace it with the "summary screen" to better reflect the change in game (reflecting modern games' usage of the term summary rather than stats)
• Adjust hblank routines to be usable elsewhere without major pain.
• Adjust summary window buffer to be usable elsewhere without major pain.

I'm sure there's more but I've lost it all in my head over the months, if I think of anything I'll make edits

[Rangi42]

Emi, this already looks great. Thank you for putting all your work into it! ^^

[Rangi42]

Also, I'd be happy to merge this as just a summary screen replacement. Meaning that the Moves screen and the move-learning page could stay, no need to implement move swapping in this for the initial merge. (Same goes for the "A/Info" functionality. ...Oh, you already did that! :D )

A couple of graphic observations:

• The Pokerus icon should have its magenta palette.
• The "Met" tab content should be shifted vertically a little.

The original mockups for comparison:

[Rangi42]

I haven't looked at the engine/pokemon/summary* files yet.

[vulcandth]

I know this is still a work-in-progress, and looks great!

My only comment is there are a lot of magic numbers.. particularly related to tile IDs and tile palettes, ect.

I know the other codebase is similar; but when we have the opportunity to rewrite systems; personally i'd like to define constants for things like the tile ID's that way if we need to reorder graphics we can update the tile ID defined in the constant.

Thoughts @Rangi42 ? I'm talking about like what I did at the top of engine/overworld/weather.asm

[Rangi42]

I definitely agree about using named constants in general. I haven't reviewed the "meat" of this PR yet so can't comment on how many magic numbers there are. But yeah, you can see how other engine files define constants for meaningful tile IDs.

[emilyploszaj]

Finally got around to resolving these issues and adding graphics constants.

@Rangi42 re the met tab contents, as a restriction of seamless page switching, the bottom of the screen's vertical aligns can't be adjusted iirc. The pokerus change would require some further palette adjustments that I'll look into.

[emilyploszaj]

I've updated the PR to include a fix for the hblank jittering, and feature inclusions for status, shiny and pokerus palettes, red/blue nature indicators on stats, and some other small things. The main blocking issue at this point is the graphical issues in the pc/in battle. Adding move swapping would also allow the moves screen to be removed.
I've significantly reworked a lot of the code to use a lot of structured constants to be more legible.