* [document] `enum PauseState`, game over parts
* apply Jenkins fixes (automatic code formatting)
also, as previously, i've rerun the "make" to check integrity
* add `PAUSE_STATE_GAME_OVER_*` comments
in case it helps to rename them later, if the need ever arises
* improve `PAUSE_STATE_GAME_OVER_SAVE_*` comments
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
* remove redundant comments
https://github.com/zeldaret/oot/pull/2283#discussion_r1827652667
* apply PR naming suggestions
reverified with
> `check_format.py ...`
> `make ...`
* Pause docs: Songs playback
* `VREG(21-25)` -> `VREG(21) to VREG(25)`
* comments on quest-song related main states
* make `sPlayedSongBtns` `+1`-sized to account for trailing INVALID button note in a 8-btn-notes song
* name main fields and regs for pages drawing
* comments
* format
* more comments
* roll -> pitch (oops)
* Document `PauseContext.offsetY`, `R_PAUSE_OFFSET_VERTICAL` as "y origin 1/2"
* copypaste comment on page pitches fields
* "offset depth" -> "depth offset"
* review
* Document pause page switching
* document initial scroll left setup, when opening the pause menu
* `PAUSE_MAIN_STATE_1` -> `PAUSE_MAIN_STATE_SWITCHING_PAGE`
* try a diagram of the pages layout in world space as a comment
* expand `nextPageMode` comment
* touch up pause camera header comments
* expand comment on irrelevant init `mainState = PAUSE_MAIN_STATE_SWITCHING_PAGE`
* expand doc on `sKaleidoSetup*` data
* expand docs on `gPageSwitchNextButtonStatus`
* add some doc on `sPageSwitch*` arrays
* SwitchPage -> PageSwitch
* add `PAGE_SWITCH_NSTEPS`
* `SWITCH_PAGE_*_PT` -> `PAGE_SWITCH_PT_*`
* peepoArtist
---------
Co-authored-by: fig02 <fig02srl@gmail.com>
* Document PauseContext.state
* Very light docs surrounding pause states
* PAUSE_STATE_UNPAUSE -> PAUSE_STATE_RESUME_GAMEPLAY and comment on purpose in the enum
* PAUSE_STATE_MAIN -> PAUSE_STATE_6
* format
* Player_InitDrawPause -> Player_InitPauseDrawData
* Split z64.h more
* Cleanup
Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
* forward declare `OcarinaStaff` struct for pointer members in message and pause structs
* define `struct OcarinaStaff`, not just the `OcarinaStaff` type
* PauseBgPreRenderState back to z64.h
* Move PauseBgPreRenderState and TransitionTileStatus near the PlayState struct definition
Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
