Commit Graph

2105 Commits

Author SHA1 Message Date
Reonu a94d414c96 Document bg_hidan_sima actor (#2830)
* Document bg_hidan_sima actor

Use the enum added for the params everywhere

Address review changes + fix typo

Address review

Update src/overlays/actors/ovl_Bg_Hidan_Sima/z_bg_hidan_sima.c

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

Update src/overlays/actors/ovl_Bg_Hidan_Sima/z_bg_hidan_sima.c

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

Address latest review

remove "it works like this"

* Update src/overlays/actors/ovl_Bg_Hidan_Sima/z_bg_hidan_sima.c

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

* Update src/overlays/actors/ovl_Bg_Hidan_Sima/z_bg_hidan_sima.c

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

* Address review

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-10-07 09:27:22 +02:00
Dragorn421 52a510f379 [cc0 oot] dekubaba (#2797)
* [cc0 oot] dekubaba

* EnDekubabaActionFunc

* EnDekubaba cleanup

* dekubaba: more cleanup

* dekubaba more cleanup
2026-09-30 12:18:54 +00:00
Dragorn421 83cb14d821 [cc0 oot] object_wf and z_en_wf (#2786)
* [cc0 oot] object_wf and z_en_wf

* docs

* EnWfActionFunc

* EnWf cleanup

* enwf review
2026-09-30 12:10:44 +00:00
Dragorn421 d90d9750b6 Fix misc 25 (#2829)
* #ifndef ENVIRONMENT_H_ -> #ifndef ENVIRONMENT_H (remove trailing underscore)

* rm from makefile suggestion about additional assets/ folder (just use assets/)

* BgCheck_AnyLineTest 1-3 : change 0/1 args in calls to false/true

* func_8083C6B8 returns bool

* parens cleanup

* fix typos

* cleanup UNK_TYPE uses

* fix ACTOR_ID_MAX value comment

* EnDh.limbRotTable -> morphTable

* some xml formatting

* bool -> s32

* shadowAlpha = 0xFF -> 255

* EnRu1_SetPlatformCamSetting/EnRu1_GetPlatformCamSetting: use CAM_SET_

* rm leading & in extracted references to jfif data arrays

* remove references to zapd

* gPoeComposerFlatHeadDL_000060E0_Tex -> object_po_composer_000060E0_Tex in HACK_no_warn_bad_dims_Texs

* correct SKYBOX_CUTSCENE_MAP comment
2026-09-30 14:02:57 +02:00
Tharo 1bef952ff6 Unused variable/parameter cleanup (#1321)
* UNUSED attribute for variables and parameters in static segments and for all stack padding variables

* No more unused variable warnings

* Make pad variable names consistent

* Small cleanup

* Macro-ify stack padding

* Use stack padding for more variables not previously named pad

* Format

* Check unused parameter on gamestate overlays and pause menu

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

* Merge 2x u8 stack pads into 1x s16 stack pad in en_ik

* Remove UNUSED from function prototypes

* Suggested changes

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

* More unused variables

* Fix merge, updated for new versions

* Format

* questionable UNUSED and STACK_PAD more usage

* format

* format

* one more STACK_PADS in z_kaleido_map.c

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-09-24 06:29:19 +02:00
Dragorn421 39070bb9dd Fix misc 24 (#2760)
* rm PROJECT_DIR var from makefile

* fix tlutoffset missing 0x prefix

* fix FTOFIX32 redef warning

* `@bug:` -> `@bug`

* playerFloorPoly -> sPlayerFloorPoly

* fix settingChangeSuccessful use as bool

* fix broken english

* osEPiStartDma: use OS_MESG_PRI_HIGH

* EffectSsHahen_SpawnBurst: pass OBJECT_ for objId

* remove extra parens

* fix trailing comma warnings in enums

* EnRu1: decimal alpha

* fix parens

* fix ATELEM_SFX_NORMAL comment (collider "type" was renamed to material)

* fix comment in Math3D_TriChkPointParaYImpl

* use ANIMMODE_ more

* Remove leading 0s from enum comments (as they indicate octal in C)
2026-09-24 05:56:15 +02:00
Dragorn421 5d80451f31 Remove src/ from include path and consider src/ includes in includes style (#2823)
* Remove src/ from include path

* Define includes ordering for src/ includes

* Update includes.md
2026-09-17 12:23:15 +02:00
Dragorn421 cbe814b254 Apply includes style to src/code/z_[r-z].*.c (#2824)
* Apply includes style to `src/code/z_[r-z].c`

* fixup
2026-09-04 19:12:50 +00:00
djevangelia 749e232dc3 z_scene Some comments and function names (#2808)
* z_scene Some comments and function names

* review changes

* further fixing from comments

* vromAddr

---------

Co-authored-by: djevangelia <djevangelia>
2026-09-02 18:59:35 +02:00
Dragorn421 6c29db8fa6 Document an includes style, apply to z_demo.c and z_play.c (#2803)
* Document an includes style, apply to z_demo.c and z_play.c

* "reverse" style includes

* bss

* clarify what a "main header" is

* Update docs/includes.md

Co-authored-by: Tharo <tharo10600@gmail.com>

* Update docs/includes.md

---------

Co-authored-by: Tharo <tharo10600@gmail.com>
2026-09-01 18:58:33 +02:00
Dragorn421 d01089e81a [cc0 oot] object_zf and z_en_zf (#2791)
* [cc0 oot] object_zf and z_en_zf

* fixups

* ENZF_TYPE_LIZALFOS_PAIRED_ -> ENZF_TYPE_LIZALFOS_PAIRED_MINIBOSS_

* EnZf cleanup
2026-08-31 16:59:24 +00:00
mzxrules 176a0bc02a Document pass on WaterBox code (#2695)
* Document pass on WaterBox code

* implement suggestions, missing comment

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-08-31 18:46:13 +02:00
Dragorn421 6bc695cc14 [cc0 oot] z_vis* (#2782)
* [cc0 oot] z_vis*

* bss

* docs

* fixup

* further vis docs

* add FbFilterType enum

* bss

* gfxP
2026-08-31 18:36:25 +02:00
Dragorn421 7dbd31ab0b [cc0 oot] EnFish (#2792)
* [cc0 oot] EnFish

* bring changes to external files

* EnFish actionFunc typedef

* EnFish move variable assigns into decls

* format
2026-08-31 18:22:17 +02:00
Dragorn421 1e2bd9e46a [cc0 oot] Biri (#2794)
* [cc0 oot] Biri

* name biri anims (by usage, Z64Utils cant preview them)

* fixup bari/biri mixup

* EnBili cleanup

* biri cleanup

* biri: merge var ini with decl
2026-08-31 16:03:49 +00:00
Derek Hensley aceaa1325d gActorSetupDls (#2802)
* gActorSetupXluDL

* gActorSetupOpaDL

* ACTOR_SETUP_OPA_DL

* BSS

* Some more usages of ACTOR_SETUP_OPA_DL

* docs

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2026-08-31 15:55:26 +00:00
Dragorn421 e5daae2850 [cc0 oot] bowling things (#2793)
* [cc0 oot] bowling things

* bowling fixups

* bowling things cleanup
2026-08-31 15:46:12 +00:00
Dragorn421 fe068a1396 [cc0 oot] Bari (#2795)
* [cc0 oot] Bari

* revert using biri params

* EnVali cleanup

* bari cleanup

* bari cleanup
2026-08-31 15:37:51 +00:00
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