Skip to content

Documentation pass on WaterBox code#1860

Open
mzxrules wants to merge 2 commits into
zeldaret:mainfrom
mzxrules:waterbox_bug
Open

Documentation pass on WaterBox code#1860
mzxrules wants to merge 2 commits into
zeldaret:mainfrom
mzxrules:waterbox_bug

Conversation

@mzxrules
Copy link
Copy Markdown
Contributor

@mzxrules mzxrules commented Feb 17, 2026

As I was attempting to document the newly found waterbox bug, I found a few mistakes and improvements to make in my old documentation.

I've implemented a similar pr in Ocarina of Time, and would like there to be a consensus reached between both games before merging.

The sister PR can be found here:

zeldaret/oot#2695

Comment thread include/z64bgcheck.h
(((roomIndex) & 0x3F) << 13) | \
(((isDisabled) & 1) << 19))

#define WATERBOX_LIGHT_INDEX_NONE 0x1F // Generates warning when built for debug and defaults to 0
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

What warning??

Copy link
Copy Markdown
Contributor Author

@mzxrules mzxrules Feb 18, 2026

Choose a reason for hiding this comment

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

In Environment_EnableUnderwaterLights in z_kankyo.c, there is a PRINTF in Ocarina that generates an error message when DEBUG_FEATURES is enabled. It is unlikely this message has been removed in og source, but it currently does not appear in MM decomp

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Ah, you mean a printf. I thought you meant a compilation warning.
I think we should word this part a bit different to avoid confusion, specially because that printf is not in this repo (yet?)

@mzxrules
Copy link
Copy Markdown
Contributor Author

mzxrules commented Mar 9, 2026

Contributions past, current, and future made to this repository are licensed under CC0. I couldn't find the thread, i'm in a rush.

@AngheloAlf
Copy link
Copy Markdown
Collaborator

@mzxrules here's the thread: louist103/mm-licensing#1
Could you post it there please. It is a lot nicer to have everything centralized in a single place.

@hensldm hensldm added documentation Improvements or additions to documentation Needs-second-approval Second approval Needs-first-approval First approval labels Apr 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Needs-first-approval First approval Needs-second-approval Second approval

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants