Commit Graph

2087 Commits

Author SHA1 Message Date
Dragorn421 761db13884 [cc0 oot] Keese (#2798)
* [cc0 oot] Keese

* bodyType -> bodyElementalType

* cleanup EnFirefly

* keese cleanup
2026-08-31 15:29:52 +00:00
Dragorn421 e9b8786fcb [cc0 oot] BgDyYoseizo (#2796)
* [cc0 oot] BgDyYoseizo

* BgDyYoseizo small cleanup

* bgdyyoseizo comment on D_80875440
2026-08-31 17:21:31 +02:00
Olvivi 6809439703 Useful Eventchkinf flag renames (#2807)
* Rename EVENTCHKINF 40, 45, 80, C7

* Rename EVENTCHKINF 40, 45, 80, C7 w format

* updated save.h comment for accuracy

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

* Applied 'Zelda' to 'Zeldas' & 'Pulled' to 'Obtained' adjustments

* EVENTCHKINF_INDEX_OBTAINED_ZELDA_LETTER -> EVENTCHKINF_INDEX_OBTAINED_ZELDAS_LETTER

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-08-30 10:22:27 +02:00
Dragorn421 63e2ae59ec Document some bugs (#2806)
* `@bug UB` in Item_Give and Item_CheckObtainability

* `@bug` on `envCtx->windSpeed` not initialized in Environment_Init
2026-08-29 16:14:49 +02:00
Gabriel Ravier b4c29fa50b Document z_eff_ss_stone1.[ch] (#2670)
* Document z_eff_ss_stone1.[ch]

* Incorporate feedback from PR review.

From https://github.com/zeldaret/oot/pull/2670:
- Shortened excessively verbose
  suppressRTransFadeFlashAlphaStepAfterTwoFrames name to
  suppressFadeFlash
- Fixed up comment that went waaaaaay beyond the column limit in
  z_eff_ss_stone1.h
- Shortened comparison with 0 of variable bool semantics in
  z_eff_ss_stone1.c

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

* Fix misnaming from PR review and document some more

From https://github.com/zeldaret/oot/pull/2670:
- shortenFadeFlash is incorrect - renamed to freezeFadeFlash
- Used `false` instead of 0 in EnArrow_Fly
- Elaborated comments about what exactly freezeFadeFlash does

Also added a few extra comments to z_eff_ss_stone1.c

* Ran clang-format

* More feedback from PR review, clarified comment

From https://github.com/zeldaret/oot/pull/2670:
- Change 0 to false in header comment
- Remove verbose speculation about former use of unused variable
- Made comment on use of viewDepth clearer
- Separated matrix and gfx code with a newline

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

* Marked the "1500" as being in units

---------

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>
2026-08-19 14:04:49 +02:00
Jordan Longstaff 58d06849af Document EnIn (AKA the hard-working Ingo) (#2778)
* Document `EnIn` (AKA the hard-working Ingo)

* Fix variable references

* Revert switch

* Rename race outcome functions for clarity

* Apply suggestions
2026-08-19 14:03:48 +02:00
Dragorn421 e8d2d26431 [cc0 oot] kanji_tex (#2784)
* [cc0 oot] "kanread"

* format

* document kanji_tex

* fixup
2026-08-19 14:03:21 +02:00
Dragorn421 05e9046417 [cc0 oot] z_memory_utils (#2783)
* [cc0 oot] z_memory_utils

* format

* doc

* MemCopy: The memory regions must not overlap.
2026-08-05 18:32:30 +02:00
Dragorn421 a883cd019a [cc0 oot] gameplay_keep (#2781)
* [cc0 oot] gameplay_keep

* gFishIn{Air,Water}Anim
2026-08-05 18:32:02 +02:00
Dragorn421 c24098a6f4 [cc0 oot] object_tp and z_en_tp (#2785)
* [cc0 oot] object_tp and z_en_tp

* docs

* fixup
2026-08-04 06:49:47 +02:00
Jordan Longstaff aa1a86708f Finish EnNutsball documentation (#2763)
* Finish `EnNutsball` documentation

* Rename things
2026-05-31 17:47:06 +02:00
Jordan Longstaff e560ff093a Document EnSa (#2744)
* Document `EnSa`

* Rename INFTABLE entries

* Animation set -> group

* Remove trailing commas

* Rename textState field

* Remove trailing comma

* Rename EVENTCHKINF flag

* Correct frowning/closed swap of enum

* Rename INFTABLE flag
2026-05-27 18:28:49 +00:00
Jordan Longstaff 3af589ba3b Document DemoSa (Saria's cutscene actions) (#2669)
* Document DemoSa (Saria's cutscene actions)

* Add missing include

* Add another missing include

* Change struct to enum

* add action enum comments to action funcs array

* comment on `DemoSa_InitChamberOfSages` not setting action and relying on the struct being zerod

* fixup demosa action enum numbering formatting

* Rename Unknown -> Unused

* Rename init function

* Missed rename

* Use `ANIMMODE` enum

Co-authored-by: Copilot <copilot@github.com>

* Remove redundant includes

* Rename Ganon actions to SageAction

* Rename sage-related actions

* More renames

* SageAction -> SageMagic

* Restore duplicate eye/mouth enums

* Minor style fixes

* Better action function name matching

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: Copilot <copilot@github.com>
2026-05-25 06:25:11 +02:00
Jordan Longstaff 2b29808f8d Document EnHs and EnHs2 (Carpenter's son) (#2758)
* Document `EnHs` and `EnHs2` (Carpenter's son)

* focusOffset -> sFocusOffset

* Rename tracking flag fields

* Roll back subrepo changes

* Remove comment on trackingFlags

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

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-05-23 09:00:29 +02:00
Jordan Longstaff 9776710a4f Child Ruto Actions Part 6: Sitting (#2623)
* Child Ruto Actions Part 6: Sitting

* Format

* Enum indices in comments

* Remove trailing whitespace

* Rename room number fields

* Rename to EnRu1_UpdateBgCheckInfo

* Revert "Rename to EnRu1_UpdateBgCheckInfo"

This reverts commit 7926cfeeca.

* Rename to UpdateBouncing

* Rename INFTABLE flags

* Rename to actorIter

* Remove unneeded parentheses

* Rectify comments in `EnRu1_UpdateSittingAction`

* Reformat

* Proposed name changes

* Change comment

* Multiple reversions
2026-05-06 23:33:59 +02:00
Nathan Casabieille 70701b8ac9 BgSpot11Oasis: name functions and static variables (#2751)
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-05-06 08:25:57 +00:00
Nathan Casabieille 7c5ea40cf7 EnBox: name unknown functions and struct fields (#2749)
* EnBox: name unknown functions and struct fields

* ovl_En_Box: name ENBOX_TYPE_9/10, rename render mode DList functions

* ovl_En_Box: formatting

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-05-06 07:52:18 +00:00
Nathan Casabieille 1b6ff388ef BgSpot09Obj: document params type enum (#2747)
* BgSpot09Obj: document params type enum

* Address review comments

- Remove "objects" from description (has specific meaning in Zelda64 engine)
- Move BgSpot09ObjType enum to .h for use by external files
- Replace return 0/1 literals with false/true in func_808B1AE0
- Fix enum comments: remove "visible" terminology, correct tent is adult-only

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-05-06 07:35:25 +00:00
Tharo 18d73ff374 Document CIC6105 (#2739)
* Document CIC6105

* Changes, AUDIOMGR_DEBUG_LEVEL -> AUDIOMGR_ACTIVITY_LEVEL
2026-05-06 09:25:34 +02:00
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 7054e8fe79 Fixups around textboxSegment (#2743) 2026-05-03 19:05:10 +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 9c0dafe8d2 Rename NoteSubEu -> NoteSampleState (#2738) 2026-04-24 21:15:28 +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
Dragorn421 177951c4db oot-gc-eu-dbg-2 OK (#2714)
* oot-gc-eu-dbg-proto OK

* add gc-eu-dbg-proto to readme

* mention overdump trimming for all debug roms

* rename gc-eu-dbg-proto to gc-eu-dbg-2

Rationale: first version to make it into decomp (which should also be the first one that surfaces) gets an un-numbered version name, then the second version gets -2, and so on
2026-04-07 11:18:17 +02:00
Tharo b50e208d60 Document bug where fog factors are not restored upon switching back from S2DEX2 after drawing a room background (#2725) 2026-03-22 23:38:40 +01:00
Tharo 67f3588e54 Comment more original names for audio functions from animal crossing (#2721)
* Comment more original names for audio functions from animal crossing

* Drop delayparam, not original
2026-03-21 05:58:16 +01:00
Dragorn421 34a40816fa Add @bug comment on an Actor_Spawn printf (#2717) 2026-03-12 13:30:17 +01:00
Dragorn421 e66e6f8f1d gc-eu-dbg OK (#2700)
* gc-eu-dbg OK

* cleanup/fortify makefile and line_numbers.h changes

* fill segments.csv

* add gc-eu-dbg to Jenkinsfile

* cleanup/fortify dmadata_table.h

* add gc-eu-dbg to readme

* fix checksum check and compressed checksum
2026-03-02 16:45:07 +01: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
Gabriel Ravier 5ab42786f4 Document src/n64dd/n64dd_error_headers.c (#2667)
* Document src/n64dd/n64dd_error_headers.c

* Incorporate feedback from PR review.

(see also https://github.com/zeldaret/oot/pull/2667)

* Put translation of gN64DDLocalizedErrorNumberHeaders[0] in a line comment

(From feedback to https://github.com/zeldaret/oot/pull/2667)
2026-02-21 09:17:30 +01: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
mzxrules 95495d221f Document SysCfb_GetFbPtr bug (#2586)
* Document SysCfb_GetFbPtr bug

* cleaner comment

* fixes

* change wording again
2026-02-17 10:31:54 +01:00
Josh Moody 834b443bbb Document spin attack (#2694) 2026-02-17 00:09:47 +01:00