Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Save.cutsceneIndex and adjacent data / code #2286

Open
wants to merge 33 commits into
base: main
Choose a base branch
from

Conversation

Feacur
Copy link
Contributor

@Feacur Feacur commented Nov 5, 2024

while studying the game logic flow, i saw there's a pattern between

  • Save.entranceIndex
  • Save.cutsceneIndex
  • SaveContext.sceneLayer

but values weren't yet described. so, it's time to cleanup my notes and shape them in a proper PR.
(UPD: not anymore) it's a WIP, but i'll start with a draft for visibility

P.S.:
the closest thing i see here is #1300, but

  • documented SaveContext.sceneLayer
  • it's merged already

so that it doesn't clutter previous commit. still, allowing `clangd LSP` to run format-on-save yields inconsistent results for me with the project's tooling, especially for header files
include/z64cutscene.h Outdated Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
Feacur and others added 10 commits November 5, 2024 11:26
and some additional observations
reverified with
> `check_format.py ...`
> `make ...`

additionally:
- current clang-format lacks a rule for trailing commas
- compiler says about them `cfe: Warning 624`
zeldaret#2286 (comment)

reverified with
> `check_format.py ...`
> `make ...`
it gets assigned to the `nextCutsceneIndex`,
so `CS_INDEX_NONE` name was misleading
the purpose of `CS_INDEX_BARRIER` is not quite clear still
@Feacur Feacur marked this pull request as ready for review November 5, 2024 18:05
Copy link
Contributor

@cadmic cadmic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few comments in the resolved threads, could you un-mark them as resolved? I don't have permission to unresolve them myself

include/z64cutscene.h Outdated Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
src/overlays/gamestates/ovl_opening/z_opening.c Outdated Show resolved Hide resolved
src/code/z_scene.c Outdated Show resolved Hide resolved
src/code/z_horse.c Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
include/z64cutscene.h Outdated Show resolved Hide resolved
@fig02
Copy link
Collaborator

fig02 commented Nov 27, 2024

(unresolved as needed)

@Feacur Feacur force-pushed the doc/cutscene_index branch from c91e8c0 to 6efea0a Compare November 29, 2024 10:10
src/code/z_scene_table.c Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants