1
0
Fork 0
mirror of https://github.com/zeldaret/oot.git synced 2025-08-08 15:30:14 +00:00
oot/include
Leonid Kapitonov b11fdab792
Document Save.cutsceneIndex and adjacent data / code (#2286)
* introduce `enum CutsceneIndex` as a first step

* crudely rename `enum CutsceneIndex` entries

* run `check_format.py ...` separetely

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

* apply a draft PR suggestion

Co-authored-by: mzxrules <mzxrules@gmail.com>

* rename `CS_INDEX_*` with PR suggestions

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`

* improve `CS_INDEX_*` naming, rem `ENTRANCE` suffix

https://github.com/zeldaret/oot/pull/2286#discussion_r1829165205

reverified with
> `check_format.py ...`
> `make ...`

* apply Jenkins fixes

https://jenkins.deco.mp/job/OOT/job/PR-2286/4/console

hmm, i do need this automation locally to

* apply a PR suggestion

https://github.com/zeldaret/oot/pull/2286#discussion_r1829219841

* remove redundant comments, fix the header comment

and add a comment chunk from https://github.com/zeldaret/oot/pull/2286#discussion_r1829108940

* rename the flag for freeing `nextCutsceneIndex`

* rename the flag for automatic `sceneLayer` calc

it gets assigned to the `nextCutsceneIndex`,
so `CS_INDEX_NONE` name was misleading

* use explicit scene layer names instead of numbers

* ok, now the last two `CS_INDEX_*` are less unknown

the purpose of `CS_INDEX_BARRIER` is not quite clear still

* apply Jenkins fixes

https://jenkins.deco.mp/job/OOT/job/PR-2286/14/console

* run `fix_bss` locally

`ntsc-1.2` refused to comply though

* revert all local to the branch bss shifts

* ugh, use defines instead of an enum

probably size of enum entries doesn't match well? originally these were
just numbers. besides, not like it's a real enumeration from zero to a
value or some bit flags

* still, add a BSS pragma for `z_demo.c`

* apply review changes

* factor out a cutscene layer formula

* give scene layers names throughout code

* apply Jenkins fixes

https://jenkins.deco.mp/job/OOT/job/PR-2286/32/console

* tweak `CS_INDEX` descriptions

* apply PR review suggestions

* rename "auto" -> "default"

* apply PR review suggestions

https://github.com/zeldaret/oot/pull/2286#discussion_r1868693980

essentially reverts 106cb1021b, except for 2 generic `z_scene.c` lines

* apply Jenkins fixes

https://jenkins.deco.mp/job/OOT/job/PR-2286/77/console

* Apply suggestions from code review

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: mzxrules <mzxrules@gmail.com>

* apply Jenkins fixes

https://jenkins.deco.mp/job/OOT/job/PR-2286/175/console

* Move CS_INDEX_* macros to z64save.h, with the definition of gSaveContext.save.cutsceneIndex

* `#define CS_INDEX_D 0xFFFD` and co.

Co-authored-by: cadmic <cadmic24@gmail.com>

* add comment on CS_INDEX_D

* review

* CS_INDEX_NONE is back

* bss

* expand comment about 0xFFFD

* fix comment about 0xFFFF usage

* review

---------

Co-authored-by: mzxrules <mzxrules@gmail.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: cadmic <cadmic24@gmail.com>
2025-06-17 15:54:52 +02:00
..
audio
libc
libc64
libu64
tables
ultra64
actor.h
actor_profile.h
alignment.h
animation.h
animation_legacy.h
array_count.h
attributes.h
audio.h
audiomgr.h
audiothread_cmd.h
avoid_ub.h
bgcheck.h
boot.h
buffers.h
build.h
camera.h Introduce CAM_DATA_SET_, CAM_ITEM_TYPE_ and name Player_SetTurnAroundCamera, Player_RequestCameraSetting (#2608) 2025-06-10 22:18:00 -04:00
carthandle.h
cic6105.h
collision_check.h fixup rename hitBacklash (#2638) 2025-06-17 14:01:13 +02:00
color.h
command_macros_base.h
console_logo_state.h
controller.h
curve.h
cutscene.h Document Save.cutsceneIndex and adjacent data / code (#2286) 2025-06-17 15:54:52 +02:00
cutscene_commands.h
cutscene_flags.h
cutscene_spline.h
db_camera.h
debug.h
debug_arena.h
debug_display.h
dma.h
draw.h
effect.h
environment.h
face_change.h
face_reaction.h
fault.h
file_select_state.h
flag_set.h
font.h
frame_advance.h
game.h
game_over.h
gamealloc.h
gfx.h
gfx_setupdl.h
gfxalloc.h
horse.h
ichain.h
idle.h
inflate.h
interface.h Commit do_action_static (#2597) 2025-06-07 21:31:57 -04:00
inventory.h
irqmgr.h
is_debug.h
item.h
jpeg.h
kaleido_manager.h
kanread.h
language_array.h
letterbox.h
lifemeter.h
light.h
line_numbers.h
listalloc.h
macro.inc
main.h
map.h
map_mark.h
map_select_state.h
memory_utils.h
mempak.h
message.h
message_data_fmt.h
message_data_static.h
mio0.h
n64dd.h
object.h
ocarina.h
olib.h
one_point_cutscene.h
padmgr.h
path.h
pause.h
play_state.h
player.h WeaponInfo docs (#1596) 2025-06-07 23:37:13 -04:00
prenmi_buff.h
prenmi_state.h
prerender.h
printf.h
quake.h
quest_hint.h
quest_hint_commands.h
rand.h
region.h
regs.h
romfile.h
room.h
rumble.h
sample_state.h
save.h Document Save.cutsceneIndex and adjacent data / code (#2286) 2025-06-17 15:54:52 +02:00
scene.h
sched.h
segment_symbols.h
segmented_address.h
seqcmd.h
sequence.h
setup_state.h
sfx.h Macroify PlaySfxGeneral calls: introduce SFX_PLAY_CENTERED and SFX_PLAY_AT_POS (#2633) 2025-06-15 18:28:37 -04:00
sfx_source.h
skin.h
skin_matrix.h
skybox.h
speed_meter.h
sram.h
ss_sram.h
stack.h
stackcheck.h
sys_cfb.h
sys_debug_controller.h
sys_freeze.h
sys_math.h
sys_math3d.h
sys_matrix.h
sys_ucode.h
terminal.h
tex_len.h
tha.h
thga.h
thread.h
title_setup_state.h
transition.h
transition_circle.h
transition_fade.h
transition_instances.h
transition_tile.h
transition_triforce.h
transition_wipe.h
translation.h
ucode_disas.h
ultra64.h
unk.h
versions.h
vi_mode.h
view.h
vis.h
yaz0.h
z_actor_dlftbls.h
z_en_a_obj.h
z_en_item00.h
z_game_dlftbls.h
z_lib.h
z_locale.h
z_math.h
zelda_arena.h