Document enum PauseState game over parts
#2283
Conversation
also, as previously, i've rerun the "make" to check integrity
in case it helps to rename them later, if the need ever arises
also i've noticed, that `z64pause.h` doesn't comply fully with the `.clang-format` temporary changing a couple of setting to - ColumnLimit: 0 - AlignTrailingComments: false fixes the issue. i don't want to push unrelated formatting here
include/z64pause.h
Outdated
| /* 15 */ PAUSE_STATE_15, | ||
| /* 16 */ PAUSE_STATE_16, | ||
| /* 17 */ PAUSE_STATE_17, | ||
| /* 8 */ PAUSE_STATE_GAME_OVER_REQUEST, |
There was a problem hiding this comment.
PAUSE_STATE_GAME_OVER_REQUEST
Not sure request totally fits here. To me when I hear request Im expecting a request to be sent somewhere, processed, and then a response sent back. This just sets a couple things and moves on to the next stage instantly.
My gut instinct would be to call this "init", but I see that state 10 is also called init, and it has more symmetry with the pause menu's init. So maybe just "_START", idk. thoughts @Dragorn421
There was a problem hiding this comment.
there's a pattern between them
PAUSE_STATE_WAIT_LETTERBOX // start
PAUSE_STATE_WAIT_BG_PRERENDER // wait single frame
PAUSE_STATE_GAME_OVER_START
PAUSE_STATE_GAME_OVER_WAIT_BG_PRERENDER
but normal pause counterpart is currently called PAUSE_STATE_WAIT_LETTERBOX...
There was a problem hiding this comment.
Its called "wait letter box" because it is waiting for this condition to be met
if (Letterbox_GetSize() == 0) {
Youll notice that in the game over variant there is no condition like that, it doesnt have to wait for anything. Its just initializing a few things right away and then continuing.
There was a problem hiding this comment.
may i suggest renaming
PAUSE_STATE_WAIT_LETTERBOX -> PAUSE_STATE_START
so that it matches with potential PAUSE_STATE_GAME_OVER_START?
because normal pause STARTS with the following code
// z_kaleido_setup.c
// if (CHECK_BTN_ALL(input->press.button, BTN_START))
// pauseCtx->state = PAUSE_STATE_WAIT_LETTERBOX;
pauseCtx->state = PAUSE_STATE_START;
current name was based off of the comment
/* 1 */ PAUSE_STATE_WAIT_LETTERBOX, // Request no letterboxing and wait for it.
There was a problem hiding this comment.
Im not sure symmetry is strictly required here. In the pause case, this state is spending most of its time waiting for the letterbox state to update appropriately. I think it makes sense to name if after this. Meanwhile, the gameover equivalent does not have to wait for anything in this manner.
More opinions welcome though, I believe @Dragorn421 you named the pause ones initially
reverified with > `check_format.py ...` > `make ...`
renamed a set of pause states related to game over sequence
P.S.:
hi, new here 🌞
thank you for the titanic work you've accomplished so far! i've been rummaging around and studying the repo and thought to try and join
also i see there's a quite old kaleido_scope PR, which explicitly didn't touch game over pause states, thus this one should not conflict; much at least