Commit Graph

1521 Commits

Author SHA1 Message Date
Jordan Longstaff e48b2d954d Finish EnDivingGame documentation (#2733)
* Finish `EnDivingGame` documentation

* Rupee phase enum

* Fix overlooked field rename

* Shorten some field names for formatting

* Reformat

* Revert "unthrown Rupees" rename

* Parenthesize textId conditions

* Rename `GiveScale` functions

* Rename `nextTextState`

* Clang-format

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-05-03 20:04:27 +02:00
Dragorn421 55cdfccdd9 Format extracted params: ObjSwitch (#2722)
* ObjSwitch params macros

* format extracted ObjSwitch params
2026-04-25 05:31:44 +09:00
Dragorn421 189baf8e79 Item_DropCollectibleRandom: params macro and drop tables enum (#2707)
* `Item_DropCollectibleRandom`: params macro and drop tables enum

* fixup
2026-04-24 21:55:03 +02:00
Tharo 67f8c8ca7b Simplify or comment on the remaining complex render mode settings (#2713)
* Simplify or comment on the remaining complex render mode settings

* Suggested changes

* Format
2026-04-17 16:24:45 +09:00
Tharo b1ba2b3997 Macro-ify access to pauseCtx->playerSegment regions (#2693)
* Macro-ify access to pauseCtx->playerSegment regions.

Using macros to indicate which region in the player segment is being
accessed makes the memory layout more obvious and indicates the
intended level of memory ownership, particularly in the case of the
texture image at the start of the segment.

* Add clarifications for gameplay_keep details

* Uniform macro name for the render texture

* Comment
2026-04-16 22:33:07 +02:00
Jordan Longstaff 92e3c14272 Finish EnExRuppy documentation (#2732)
* Finish `EnExRuppy` documentation

* Rename throw distance field

* Move comments to enum type

* Use `EnHeishi1` type for guard

* Add comment on `EnHeishi1` supposition
2026-04-13 07:14:45 +09:00
Philip Dubé 63df17a235 Correct field offsets in header files (#2730) 2026-04-12 12:26:20 +02:00
Jordan Longstaff 3d51e21020 Finish EnMThunder documentation (#2702)
* Finish `EnMThunder` documentation

* Boolean conversion

* Hex to decimal conversions

* Rename static variables
2026-02-26 09:59:16 +01:00
Tharo d80da36cff Make bool return values of SkelAnime_Update and LinkAnimation_Update clear (#2706)
* Make bool return values of SkelAnime_Update and LinkAnimation_Update clear

* formatting: empty line after decl

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-02-25 13:03:13 +01:00
Dragorn421 0491c21475 Use OOT_NTSC instead of OOT_REGION to check for ntsc in gkeep (#2703)
* Use `OOT_NTSC` instead of `OOT_REGION` to check for ntsc in gkeep

* bss
2026-02-24 21:48:21 +01:00
Dragorn421 0d4dbb61a0 Fix F3DEX2 ucode name on N64 versions (not PosLight) (#2701)
* Fix F3DEX2 ucode name on N64 versions (not PosLight)

* put the not-PosLight / PosLight differences under F3DEX_GBI_PL

* revert bss changes
2026-02-22 22:50:27 +01:00
Dragorn421 abdae818bd Fix misc 23 (#2699)
* remove noop macros Fault_SetFontColor Fault_SetCharPad under PLATFORM_N64

* remove duplicate declarations in sfx.h

* use render mode presets more

* decimal for alpha values

* fix some z_camera comments typos

* fix references to preprocess.sh (used to be preprocess.py)

* remove outdated comment on deps in makefile

* code_800AD920 was renamed to z_viszbuf

* fix capitalization typo: gOcarinaofTimeDesignTex -> gOcarinaOfTimeDesignTex

* fix typo: gLinkAdultEyesClosedfTex, gLinkChildEyesClosedfTex -> remove extra f

* fix typo: gCrstalSwitchRedTex, gCrstalSwitchBlueTex -> gCrystal

* fix PARAMS_GET_U amount of bits
2026-02-22 19:08:12 +01:00
Dragorn421 f2cb5ecb2f Assets system: format extracted actor params (and EnDoor params) (#2698)
* Assets system: format extracted actor params (and EnDoor params)

* and actor list too...

* and actor list required inclues too...

* ENDOOR_PARAMS_GENERAL, ENDOOR_PARAMS -> ENDOOR_PARAMS, ENDOOR_PARAMS_NODATA
2026-02-22 18:48:27 +01:00
mzxrules 8b30a77346 z_bg_haka_meganebg documentation pass (#2685)
* document z_bg_haka_meganebg

* Dragorn suggestions and @bug documentation

* i swear i was good at grammar as a child
2026-02-22 09:35:51 +01:00
Jordan Longstaff 6f9b62bd4a Child Ruto Actions Part 5: Speakable (#2619)
* Child Ruto Actions Part 5: Speakable

* Rename to "Speakable Jabu"
2026-02-22 05:21:41 +09:00
Jordan Longstaff 155e957634 Child Ruto Actions Part 4: Sapphire platform (#2618)
* Child Ruto Actions Part 4: Sapphire platform

* One more function rename
2026-02-21 08:51:38 +01:00
Dragorn421 7e445cde73 EnBox params macros (#2696) 2026-02-20 09:23:49 +01:00
Gabriel Ravier 42242bdf88 Document sys_freeze.[ch] (#2666) 2026-02-18 12:36:07 +01:00
mzxrules b0a03cc1a4 bg_haka_megane documentation pass (#2684)
* document bg_haka_megane

* BGHAKAMEGANE_TYPE_MAX

* dragorn suggestion
2026-02-18 08:15:05 +01:00
mzxrules 1884569a98 bg_haka_trap documentation pass (#2683)
* document pass on bg_haka_trap

* formatting

* suggestions

* dragorn suggestions
2026-02-17 16:09:54 +01:00
mzxrules 3d4e8e32c3 z_bg_haka_zou documentation pass (#2687)
* document z_bg_haka_zou

* suggestions

* dragorn suggestions
2026-02-17 13:39:53 +01:00
Josh Moody 834b443bbb Document spin attack (#2694) 2026-02-17 00:09:47 +01:00
Tharo dbe1a80541 Commit and split gameplay_keep (#2612)
* Commit and split gameplay_keep

* Remove debugging bits

* format

* bss

* merge gameplay_keep_0x400 into link_textures

* Name some unused NTSC stuff

* Rename files for some of the newly named unused NTSC stuff

* name more gkeep files

* format

* spin_attack

* name fish anims files

* name some eff_ files

* name a bunch more files

* Add underscore in not-final names

* cleanup limb enum names (remove g prefix)

* split gameplay_keep_0x34020.c into gBugCrawlAnim.c + bug_skel.c

* door.h -> door_skel.h

* gArrowNAnim -> gArrowN_Anim

* split arrow_anims into gArrow1_Anim + gArrow2_Anim

* fix merge

* bss

* bss

* Fix bss

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-02-16 15:32:37 +01:00
Jordan Longstaff 014eca05fe Fix wrong BGM entry names (#2671) 2026-02-15 08:49:46 +01:00
Jordan Longstaff 5e89618c2e Label EnEiyer as Stinger (#2681)
* Label `EnEiyer` as Stinger

* Change to Ground
2026-02-15 00:48:10 +01:00
Gabriel Ravier bf7af1746d Document EnPubox (#2668) 2026-02-14 16:36:58 +01:00
Jordan Longstaff ebbabb7d91 Document EnWeiyer (#2686)
* Document `EnWeiyer`

* Rename function
2026-02-12 23:22:21 +00:00
Jordan Longstaff fd299cc72b Document BgSpot18Basket (#2688) 2026-01-25 23:39:59 +00:00
Pepe20129 b204d6c089 Document Dampé's ghost (#2656)
* Document Dampé

* Format

* Address review

* Format
2025-08-20 10:30:08 +02:00
Dragorn421 41adadd85d Pause docs: UIOverlay L/R buttons details (#2650) 2025-07-15 07:10:34 +02:00
Jordan Longstaff 4d2bc68bac Child Ruto Actions Part 3: Boss room (#2602)
* Child Ruto Actions Part 3: Boss room

* Rename action enum members

* Subtle rename of enum members
2025-07-03 16:08:42 +02:00
Jordan Longstaff fd7e88af1e Child Ruto Actions Part 2: First encounter (#2601)
* Child Ruto Actions Part 2: First encounter

* Rename action enum entries

* Rename to Sfx

* Rename "first encounter" to "meeting"
2025-07-03 09:49:27 +02:00
Jordan Longstaff 80c4f33da5 Child Ruto Actions Part 1: Zora's Fountain (#2600)
* Child Ruto Actions Part 1: Zora's Fountain

* Oops, forgot sound effects

* Reformat

* Rename action enum entries

* Suggested changes
2025-06-30 08:41:47 +02:00
Dragorn421 d45353ee33 Cleanup extracted colliders 3: Use HIT_SPECIAL_EFFECT_, HIT_BACKLASH_ names (#2646)
* Cleanup extracted colliders 3: Use `HIT_SPECIAL_EFFECT_`, `HIT_BACKLASH_` names

* revert removing FLARE_DANCER_BODY_DMG (oops)
2025-06-28 18:06:42 -04:00
Dragorn421 b5f980570c Pause docs: UIOverlay quads dimensions (#2644) 2025-06-28 15:23:00 +09:00
Dragorn421 88f452af10 Reevaluate player hit response names (#2640)
* PlayerHitResponseType

* PLAYER_HIT_RESPONSE_ICE_TRAP -> FROZEN

* PLAYER_KNOCKBACK_LARGE_SHOCK, PLAYER_HIT_RESPONSE_ELECTRIC_SHOCK -> PLAYER_KNOCKBACK_LARGE_ELECTRIFIED, PLAYER_HIT_RESPONSE_ELECTRIFIED

* damageResponseType -> hitResponseType
2025-06-27 04:45:44 +09:00
Dragorn421 b7935dad12 Cleanup extracted colliders 2: ARRAY_COUNT (#2643) 2025-06-25 21:20:55 +09:00
Dragorn421 affb39624f Pause docs: "uiOverlay" quads (renamed from "InfoPanel") (#2635)
* Pause docs: "InfoPanel" quads

* bss

* rename infoPanelVtx to decorVtx

* rename to uiOverlayVtx / UI_OVERLAY_QUAD_

* fixup
2025-06-25 00:08:26 +02:00
Dragorn421 d52ba1ed26 Cleanup extracted colliders 1 (#2641) 2025-06-24 17:53:55 +02:00
Dragorn421 ad7ef14b5d Name HIT_BACKLASH_ and HIT_SPECIAL_EFFECT_ values (#2639)
* Name HIT_BACKLASH_ and HIT_SPECIAL_EFFECT_ values

* SHOCK -> ELECTRIC
2025-06-22 17:36:09 +02:00
Dragorn421 04a92708cf Rename AT effect to hitSpecialEffect (#2637)
* Rename AT `effect` to `hitSpecialEffect`

* bss
2025-06-20 10:12:45 +02:00
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
Dragorn421 e8c59385bc Rename acDmgInfo.effect -> hitBacklash (#2555)
* CollisionCheckInfo.atHitEffect -> atHitBacklash

* ColliderElementDamageInfoAC.effect -> hitBacklash

* add HIT_BACKLASH_ enum

* bss

* bss

* bss

* bss

* bss

* Update comments
2025-06-17 05:23:49 -04:00
Dragorn421 fc2992abf6 Pause docs: misc docs (#2636)
* doc `KaleidoScope_SetCursorPos`

* doc bug in `KaleidoScope_DrawWorldMap`

* fix anonymous enum

* `D_808321A8` -> `sSavedButtonStatus`

* s16 decimal for `sVtxPageMapDungeonQuads``X/Y/Width/Height`

* Use `LANGUAGE_` enum for indexing language-indexed regs
2025-06-16 13:13:31 +02:00
Dragorn421 fd1ea6bc1a Macroify PlaySfxGeneral calls: introduce SFX_PLAY_CENTERED and SFX_PLAY_AT_POS (#2633)
* Add `SFX_PLAY_CENTERED`

* Add `SFX_PLAY_AT_POS`
2025-06-15 18:28:37 -04:00
Dragorn421 05a2818557 Assets: Move limb enums into xmls 4 (#2631) 2025-06-15 14:32:54 -04:00
Dragorn421 d3ed137878 Assets: Move limb enums into xmls 3 (#2630) 2025-06-15 13:55:11 -04:00
Dragorn421 7547603989 Pause doc: DrawInfoPanel textures (#2628)
* Pause doc: DrawInfoPanel textures

* plural Widths
2025-06-14 22:06:53 +02:00
Dragorn421 e4e14a6bcf Assets: Move limb enums into xmls 2 (#2626) 2025-06-12 17:23:47 -04:00
Dragorn421 1df6a3ee12 Assets: Move limb enums into xmls 1 (#2625) 2025-06-12 15:46:13 -04:00