Commit Graph

1147 Commits

Author SHA1 Message Date
Dragorn421 98ba7ad2ab
Add T macro for translated debug strings (#2064)
* Add T macro for translated debug strings

* Hyral -> Hyrule

* put some more care into z_std_dma
2024-08-22 22:33:50 +02:00
Dragorn421 942df45892
Match n64dd text in code (#2058)
* match n64dd text

* format

* fixups

* add n64dd segment using baserom

* cleanup syms 1

* cleanup symbols 2

* cleanup D_800FF4B0

* fix declaration usage and linking for D_800FF4B0
2024-08-20 19:20:11 -04:00
Dragorn421 ac2224f095
Add versions.h (#2060) 2024-08-20 17:19:16 -04:00
cadmic 3e516f48f3
Match more ntsc-1.2 overlay draw functions (#2061)
* Match more overlay draw functions

* Review
2024-08-20 16:22:05 -04:00
cadmic ec70295357
Move non-libultra libc functions to src/libc/ (#2055)
* Move non-libultra libc functions to src/libc/

* Add explicit nops in delay slots

* Don't rely on CPP expanding undefined macros to 0

* Delete old Makefile rules

* Fix type of memset()
2024-08-20 01:15:24 -04:00
cadmic d191e8714e
Allow building the Debug ROM without debug features (#2052)
* Allow building the Debug ROM without debug features

* Fix bss

* Add comment

* Reword again

* Fix bss
2024-08-19 23:58:31 +02:00
cadmic 46a5fa919b
Match ntsc-1.2 z_scene_table.c (#2050)
* Match z_scene_table.c

* Attempt to fix bss ordering

* Forward declare PlayState instead

* Untangle circular includes in z64scene.h
2024-08-19 10:24:02 +02:00
Tharo ba5574be6d
[Audio 5/?] Build the Samplebank Table (#2044) 2024-08-17 17:42:15 -04:00
Dragorn421 56ca23663a
Fixup printf args fake matches (#2049) 2024-08-17 22:42:09 +02:00
cadmic 7fb9fbb4a2
Match ntsc-1.2 z_skelanime.c, z_view.c, z_viszbuf.c (#2041) 2024-08-15 03:54:06 -04:00
Dragorn421 1649bf32d6
padutils.c, line numbers (#2040) 2024-08-14 22:13:23 -04:00
Dragorn421 fda0e6ad4b
[ntsc-1.2] Match z_construct.c, z_draw.c, z_kaleido_setup.c and partially z_actor.c (#2039)
* func_80033C30

* Interface_Init

* z_draw.c

* KaleidoSetup_Destroy , n64dd.h

* z_kaleido_setup.c

* add n64dd files to spec

according to tools/disasm/ntsc-1.2/files_code.csv , they're between irqmgr.o and fault.o
putting them before or after malloc_debug.o in the spec is an arbitrary choice
2024-08-14 22:05:41 -04:00
Tharo eaf955ad22
Generic actor params getters (#1359)
* Initial PARAMS_GET macros

* NOSHIFT macro

* Use number of bits rather than raw mask values

* Add descriptions for each generic macro

* Reformat

* Adjust comment

* format

* edit en_door macro names

* edit redead macro name

* edit bdan switch macro name, and remove unneeded comments in go2

* mizushutter macro names

* remove PARAMS_GET_S, rework ishi switch flag handling

* actually remove PARAMS_GET_S

* remove PARAMS_GET2_S

* PARAMS_GET_U and PARAMS_GET_S

* format

* fix merge

* format

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-08-14 21:29:43 +02:00
cadmic e6bc4bd8cb
Add names to all typedef'd structs, unions, and enums (#2028)
* Add names to all typedef'd structs, unions, and enums

* wtf vs code

* Use a better regex
2024-08-12 03:07:48 -04:00
Yanis 672728455d
Match ``z_fbdemo.c`` and ``z_fbdemo_fade.c`` for NTSC-1.2 (#2031)
* matched ntsc-1.2 fbdemo/fbdemo_fade

* remove ifdef for fbdemo

* remove macro for 's match
2024-08-11 21:12:27 -04:00
krm01 8df87038a0
[Doc] name function func_8002DBD0 to Actor_WorldToActorCoords (#2029)
* name function Actor_WorldToActorCoords

* clean up some misleading usages
2024-08-11 14:30:41 -04:00
cadmic 8366b8731e
Set up build system and disassembly for ntsc-1.2 (#2021)
* Set up build system for ntsc-1.2

* Set up disassembly for ntsc-1.2

* Add all unnamed functions to functions.txt

* Update docs/retail_versions.md for ntsc-1.2

* Format

* Update docs/retail_versions.md

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

* Remove mention of US

* OOT_N64 -> PLATFORM_N64, OOT_GC -> PLATFORM_GC

* Move mtxutil to libultra/gu

* Fix libultra/io bss splits

* Fix merge

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-08-11 06:20:43 -04:00
cadmic 9eec8af498
Add "do {} while (0);" to CLOSE_DISPS (#2025) 2024-08-10 18:48:27 -04:00
cadmic d495436190
Match remaining GC retail versions (#2019)
* Match the remaining GC retail versions

* Fix BSS ordering for existing versions

* Disable clang-format for #pragma increment_block_number

* sramResetCode -> sSramResetCode

* Replace 0xFF3F with or-ing all buttons together

* Revert "Disable clang-format for #pragma increment_block_number"

This reverts commit 406b6d26c9.

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-08-09 20:58:46 -04:00
cadmic 1021c482af
gc-us OK (#2018)
Match BSS order and delete disassembly data
2024-08-08 03:26:48 -04:00
cadmic feac688313
Match NTSC file select (#1998)
* Match NTSC file select

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

* nes -> eng in macros

* Duplicate more code but use less #ifs

* Format

---------

Co-authored-by: inspectredc <inspectredc@gmail.com>
2024-08-08 00:27:02 -04:00
cadmic 0186524300
Match NTSC z_kaleido_scope.c (#1988)
* Match NTSC z_kaleido_scope.c

* Use new REGs everywhere

* Add comments for YREG initialization

* Use new REGs everywhere for real

* Fix merge
2024-08-08 02:03:22 +02:00
blackgamma7 0a365f4467 Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-08-02 20:37:18 -04:00
cadmic 0da402b9de
Automate fixing BSS ordering (#2009)
* Automate fixing BSS ordering

* Typo

* Some cleanups

* Move pragma check after printing BSS info

* Some proofreading

* multiprocessing, require version, some colors

* Tweak output

* Black + mypy

* Move logging and sys.exit out of helper functions

* Use stdout instead of stderr in fix_bss.py

* Add suggestion to conflicting offsets error

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

* Remove var = list[T]()

* Improve error handling

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

* Add error if no pointers to BSS

* Add comment about process_file_worker

* Only print updates if stdout is a tty

* Use new binary-search-esque candidate generation algorithm

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

* Add Wikipedia link

* More comment tweaks

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-08-02 20:31:15 -04:00
fig02 078e21f6c6
`InitVars` -> `Profile` (#2011)
* rename ActorInit

* rename actorInit

* rename initInfo

* EffectSs Profile

* _InitVars -> _Profile

* format, loose ends

* revert tutorial
2024-08-02 17:50:02 -04:00
blackgamma7 a8d044664a Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-08-01 02:28:42 -04:00
cadmic 067d06bb56
Match NTSC loose ends (#2004)
* Match NTSC loose ends

* Add comment about giObjectSegment size
2024-07-28 00:09:05 -04:00
fig02 7fcbf3f4b2
Document `ANIM_FLAG_PLAYER_2` as `ANIM_FLAG_DISABLE_CHILD_ROOT_ADJUSTMENT` (#2001)
* name ANIM_FLAG_DISABLE_CHILD_ROOT_ADJUSTMENT

* reword

* typo
2024-07-27 23:47:58 -04:00
fig02 d905e08daf
Document bottle color bug (#2000)
* bottle color bug

* adjust wording

* format

* small thing

* reword

* missed a letter
2024-07-27 23:16:00 -04:00
cadmic 47fd023238
Match NTSC z_kanfont.c and z_message.c (#1997)
* Match NTSC z_kanfont.c and z_message.c

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

* Apply suggestions from code review

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

* Remove now-unnecessary padding

* Remove msgBufDecoded comment

* Use == NULL for fake match

* Rename Message_DrawText{JPN,NES} -> Message_DrawText[Wide]

* Font_LoadKanji -> Font_LoadCharWide

* Restore FONT_MESSAGE_OFFSET/FONT_MESSAGE_LENGTH

---------

Co-authored-by: inspectredc <inspectredc@gmail.com>
Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2024-07-21 21:50:20 -04:00
fig02 ab2ca85227
Rename `ANIM_FLAG_NO_MOVE` to `ANIM_FLAG_ADJUST_STARTING_POS` (#1981)
* rename flag and draft 1 of comment

* draft 2

* tweak wording

* format

* format
2024-07-21 19:27:25 -04:00
Tharo 17a88746e7
Fix a couple of render modes (#1994) 2024-07-17 19:45:22 -04:00
cadmic c83b93aae4
Match NTSC z_parameter.c and z_construct.c (#1987)
* Match NTSC z_parameter.c and z_construct.c

* Comment which REG collide

* Use new REGs everywhere

* Use new REGs everywhere for real
2024-07-17 18:52:38 -04:00
cadmic 4fbb48177f
Create FILENAME_ macros for NTSC filename encoding (#1986)
* Create FILENAME_ macros for NTSC filename encoding

* Add defines/comments for all filename characters

* FILENAME_EXCLAMATION_POINT -> FILENAME_EXCLAMATION_MARK to match kanji file

* hirigana -> hiragana
2024-07-17 18:36:17 -04:00
mzxrules 7eee97429f
Clean up custom LoadTextureBlock in z_map_mark.c and z_lmap_mark.c (#1896)
* experimental inc.c

* make it look proper

* make table types u32

* ZCONST -> COND_CONST

* Tharo suggestion and comment

* implement MM Decomp suggestions

* fix minor nits

* Update header guard
2024-07-17 17:35:37 -04:00
cadmic bf3339a16d
Set up build system and disassembly for gc-us (#1982)
* Build gc-us

* Set up gc-us disassembly

* Don't disasm unchanged overlays

* Fix gc-eu-mq BSS

* romalign link_animetion for NTSC

* Explicitly set CPP defines to 0/1

* Add #ifs to segment_symbols.h

* Add sButtonTextures now

* Fix message _SHIFTL usage

* Don't ifdef LANGUAGE_MAX
2024-07-06 21:38:31 +02:00
Tharo baf1e8c174
Reworked text extraction + add JP text extraction (#1980)
* Reworked text extraction + add JP text extraction

* Format

* Suggested changes

* Correct address for gc-us sJpnMessageEntryTable

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

---------

Co-authored-by: cadmic <cadmic24@gmail.com>
2024-07-02 22:42:52 -04:00
cadmic 24571203df
Remove global.h from z_fishing (#1977) 2024-06-25 18:48:24 -04:00
Anghelo Carvajal d8f2e9abc6
Move `PlayState` to a new `z64play.h` (#1966)
* ActorContext

* frameadvance

* SfxSource

* GameOverContext

* RoomContext

* TransitionActorContext

* fix bss

* Move PlayState

* Move play functions to new header

* SAC_ENABLE

* no longer needed

* SAC_ENABLE again

* z_demo being silly

* comment

* format headers

* fix retail bss

* actually fix bss

* Cutscene_ProcessScript comment

* bss again

* Update src/code/z_demo.c

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

* rename to frame_advance and remove it from z64.h

* move macros too

* review

* Rename SequenceContext to SceneSequences

---------

Co-authored-by: cadmic <cadmic24@gmail.com>
2024-06-25 15:13:31 -04:00
Dragorn421 2ce4742bf6
Fix misc 22 (#1971)
* remove trailing whitespace

* fix/docbug about dright for next page of fault menu

* // size = ...; -> // size = ...

* access `ColliderJntSph.elements` as an array

* fixup doc in PreRender.c

* empty line after decl

* gdSPDefLights1 xyz arguments for direction are signed 8bit values

* doc bug of bad use of free in EffDust actor

* decimal for Actor.colorFilterTimer

* shopItemEntries -> sShopItemEntries

* HEISHI4_AT_KAKRIKO_ENTRANCE -> HEISHI4_AT_KAKARIKO_ENTRANCE

* format
2024-06-24 18:39:08 -04:00
blackgamma7 a149df852c Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-06-22 23:52:06 -04:00
fig02 e4eb5e27b3
Rename `ANIM_FLAG_0` to `ANIM_FLAG_UPDATE_XZ` (#1964)
* rename anim flag 0

* review

* missed a word
2024-06-21 19:04:06 -04:00
Tharo 38921684a5
Add point lighting gbi features (#1962)
* Add point lighting gbi features

* Maybe fix bss ordering
2024-06-20 22:39:43 -04:00
blackgamma7 bc3faed1e4 Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-06-19 20:41:28 -04:00
mzxrules 8d83727429
Experiment: remove global.h dependency from sys_math, sys_math3d, z_lib (#1956)
* split sys_math, sys_math3d, z_lib from global.h

* suggestions

* forgot this

* more math stuff

* nit fix

* re-add ichain.h

* resolve tharo's comments
2024-06-19 00:00:23 -04:00
fig02 06bbdf88f1
Revamp "AnimationContext" Docs, now called "AnimTaskQueue" (#1941)
* start using task terminology

* more docs

* format

* cleanups

* MoveActor -> ActorMove

* missed a couple

* hopefully the last changes

* comment explaining the group change

* some review

* dragorn review

* remove accidental file

* fix matching issue, now use while loop
2024-06-18 23:46:36 -04:00
cadmic eb660765b1
Change linker script so gGameOverTimer can be in z_game_over.c (#1939)
* Change linker script so gGameOverTimer can be in z_game_over.c

* gGameOverTimer -> sGameOverTimer

* include_data_only_with_rodata -> include_data_only_within_rodata
2024-06-10 10:07:51 -04:00
inspectredc e88084fe65
Fix LensMode Enum Names (#1954) 2024-06-09 14:43:15 -04:00
Dragorn421 05c87518e7
Document pause page switching (#1550)
* Document pause page switching

* document initial scroll left setup, when opening the pause menu

* `PAUSE_MAIN_STATE_1` -> `PAUSE_MAIN_STATE_SWITCHING_PAGE`

* try a diagram of the pages layout in world space as a comment

* expand `nextPageMode` comment

* touch up pause camera header comments

* expand comment on irrelevant init `mainState = PAUSE_MAIN_STATE_SWITCHING_PAGE`

* expand doc on `sKaleidoSetup*` data

* expand docs on `gPageSwitchNextButtonStatus`

* add some doc on `sPageSwitch*` arrays

* SwitchPage -> PageSwitch

* add `PAGE_SWITCH_NSTEPS`

* `SWITCH_PAGE_*_PT` -> `PAGE_SWITCH_PT_*`

* peepoArtist

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2024-05-23 16:56:10 -04:00
blackgamma7 10d2aab3b5 Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-05-01 06:28:24 -04:00
cadmic b86e1774cf
Rename yDistToWater -> depthInWater (#1950)
* Rename yDistToWater -> yDistUnderWater

* yDistUnderWater -> depthInWater
2024-04-28 17:29:06 -04:00
blackgamma7 c6d6964f15 Formatting 2024-04-28 17:27:41 -04:00
blackgamma7 6d96b701bb Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-04-28 15:58:44 -04:00
fig02 7e8b9144c2
Player Docs: Control stick buffers (#1945)
* name vars and add enum

* name some spin attack stuff

* fix right and left

* forward/backward

* format

* fix retail bss

* sControlStickWorldYaw
2024-04-22 17:35:22 -04:00
cadmic 9cbd57d329
Fix miscategorized scenes (#1946)
* Fix miscategorized scenes

* Sort includes
2024-04-18 22:21:34 -04:00
cadmic d59ca6cea2
Set up gc-eu and match all code (#1938)
* Set up gc-eu and match all code

* Format

* Mark gc-eu-mq as WIP until it builds OK

* Move original/MQ map mark data to separate files

* Add #includes to .inc.c files to help out VS Code

* Use #if in spec instead of .inc.c files
2024-04-15 13:36:29 -04:00
cadmic f643499462
Match retail BSS ordering (#1927)
* Match retail BSS ordering

* Revert moving some global variables to headers

* Adjust block numbers after header changes

* Fix debug build

* Overlay bss ordering

* Fix BSS ordering after header changes

* gc-eu-mq OK

* Implement preprocessor for #pragma increment_block_number

* Transfer usage comment from reencode.sh

* Use temporary directory instead of temporary file

* Move ColChkMassType back
2024-04-14 23:51:32 +02:00
cadmic 8bd599588c
Match retail camera (#1917)
* Create CAM_DEBUG_RELOAD_PARAMS and CAM_DEBUG_RELOAD_PREG macros

* Create debug macros for camera OREGs

* Move static data into Camera_Demo5

* Match retail camera functions, except Camera_Battle1

* Match camera data and bss sizes

* Restore R_CAM reg names, remove OREG_DEBUG[_SCALED]

* CAM_DATA_n -> CAM_GLOBAL_n

* Remove old debug macros

* Add braces to CAM_DEBUG_RELOAD_PREG macro

* Hackily match Camera_Battle1

* Format

* Better Camera_Battle1 match

* Format

* Revert R_CAM_N comments for sOREGInit
2024-03-30 23:48:06 -04:00
cadmic 4e1b0f6694
Fix various data issues in gc-eu-mq (#1921)
* Fix various data issues

* D_80153D78 -> sMessageDebuggerTextboxCount
2024-03-29 11:19:55 -04:00
fig02 7445169e42
targetActor -> talkActor (#1933) 2024-03-24 12:27:45 -04:00
cadmic 872940d664
More data fixes (#1929) 2024-03-23 12:30:09 -04:00
fig02 bd0941405d
Document Player's Face and z_actor FaceChange functions (#1928)
* create some enums

* gonna try struct instead of array

* struct works. add docs too

* inline function comments

* fix function comment

* name faces, move enums

* rename textures

* outnames

* remove comments

* change comment slightly

* fixup face comments

* review

* offset comments

* add and use PLAYER_FACE_MAX

* typo

* more comment on blinkDuration

* another change to the comment
2024-03-23 12:21:45 -04:00
Dragorn421 68a86d2d00
Colliders: change "touch, bump" to AT and AC (elems) (#1637)
* toucherFlags, bumperFlags -> atElemFlags, acElemFlags

* TOUCH_ -> ATELEM_

* BUMP_ -> ACELEM_

* ColliderElementTouch,Bump -> ColliderElementDamageInfoAT,AC

* toucher,bumper -> atDmgInfo,acDmgInfo

* Update docs and zcolchk funcs names

* run formatter

* remove the last mentions of "bump" for colliders

* Update renamed functions in disasm
2024-03-04 19:33:08 -05:00
cadmic 9e5df5ba79
Remove reference to Cutscene_DrawDebugInfo in retail (#1913) 2024-03-02 16:14:48 -05:00
Dragorn421 a6f646dc65
Introduce extracted/VERSION, with text extracted there (#1730)
* Introduce assets/_extracted/VERSION, with text extracted there

* move to `extracted/text/`

* Update gitignore s

* rework args for msgenc.py

* put mkdir with others, until theyre all moved at once

* move 0xFFFC back to being extracted, making it use specific macro `DEFINE_MESSAGE_NES` to handle its special behavior

* prettier gitignore

* Move messages 0xFFFC, 0xFFFD to committed message_data.h
2024-03-01 22:09:57 -05:00
Derek Hensley 1b60dcf6dd
Use Romfile in place of vromStart and vromEnd in structs (#1742)
* KaleidoMgrOverlay

* GameStateOverlay

* ActorOverlay

* EffectSsOverlay

* MapMarkDataOverlay

* Missed DEFINE_ACTOR_UNSET

* ROM_FILE_UNSET

* DEFINE_OBJECT_EMPTY

* DmaEntry

* ACTOR_UNSET

* romfile.h

* newline

* Format
2024-02-29 14:15:04 +01:00
Tharo c521f1f8ae
Remove gSystemHeap and use _buffersSegmentEnd instead, make buffer alignments explicit for gcc (#1901)
* Remove gSystemHeap and use _buffersSegmentEnd instead, make buffer alignments explicit for gcc

* ALIGNEDn -> ALIGNED(n), reposition alignment attribute for PreNmiBuff

* Correct positioning of ALIGNED for filter data in audio/lib/data.c

* Add ALIGNED to TypenameMacros

* ALIGNED(4) on same line for PreNmiBuff

* Revert audio load.c change, to be submitted separately
2024-02-27 19:01:47 -05:00
Tharo 6e2ea18154
Add proper bug comment for gSaveContext.save.dayTime getting cleared as s32 when it is u16 (#1900)
* Add proper bug comment for gSaveContext.save.dayTime getting cleared as s32 when it is u16

* Formatting?
2024-02-27 17:48:22 -05:00
cadmic 350b82c675
Restore terminal colors in retail, except in __osMalloc.c (#1899) 2024-02-27 14:08:20 -05:00
Tharo dcf61174e9
Filename & line number args cleanup (#1891)
* Filename & line number args cleanup

* Use int for line number args over s32/u32

* Add missing const qualifiers from filename args

* Fix gcc warning in game.c

* Add comment to weird assignments in GameState_Init
2024-02-27 02:37:33 -05:00
cadmic c6e3ef4570
Match retail code data sizes (#1741)
* Match retail audio data

* Fix various small code data problems

* Disable terminal colors in debug builds

* Match z_actor_dlftbls.c .rodata

* Use _3 for unused nameString macro parameter

* Move sDebugCutsceneScriptBuf to be in-function static

* Comment on actor name being NULL

* Split out padding the fault_drawer.bss.s
2024-02-27 02:23:19 -05:00
Tharo 7f64ace8f0
RNG doc (#1892)
* RNG doc

* Add some missing note qualifiers in comments

* code_800FD970 -> rand in Makefile and disasm CSVs
2024-02-26 22:21:25 -05:00
cadmic 6c405b6ea3
Match retail PreRender_DivotFilter (#1740) 2024-02-10 11:38:04 -05:00
cadmic 097db907ca
Match the rest of z_onepointdemo.c (#1739) 2024-02-09 13:26:20 -05:00
cadmic ea17b9619e
Match OnePointCutscene_Init by inlining static data (#1738)
* Match OnePointCutscene_Init by inlining static data

* Inline what's left of z_onepointdemo_data.inc.c
2024-02-09 13:17:24 -05:00
cadmic 10ebdf9ff5
Match retail z_message_PAL.c (#1736) 2024-02-09 13:08:28 -05:00
blackgamma7 01ee3b64a7 Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-02-08 14:24:56 -05:00
engineer124 488b0e7783
Retail kankyo OK (#1735)
* only Environment_Update plus 1 fake match

* more WIP

* remove fake matches

* Environment_Update OK

* void

* add fake comment

* better match for update

* cleanup

* fix fake match

* more fixes

* add comment
2024-02-08 08:57:06 -05:00
engineer124 63f0033fe5
Match Retail BgCheck (#1734)
* 2 funcs left

* so close

* bgcheck OK
2024-02-08 08:47:07 -05:00
engineer124 e48cdaf598
Match Retail Kaleido Code Files (#1702)
* OK

* PR Review
2024-02-08 08:40:08 -05:00
Derek Hensley 92203011b8
Skelanime + Kanfont Retail OK (#1729)
* Skelanime retail OK

* kanfont retail OK

* PR review
2024-02-07 11:11:56 -05:00
cadmic bc9c1f2be2
Match more code files (#1724) 2024-02-07 11:03:55 -05:00
cadmic be4f3142e0
Match retail z_sram.c (#1722) 2024-02-07 10:41:12 -05:00
cadmic 300b3a8ffd
Match retail z_fbdemo.c and z_fbdemo_fade.c (#1727)
* Match retail z_fbdemo.c and z_fbdemo_fade.c

* Tweak macro arguments
2024-02-07 00:32:23 -05:00
cadmic e7b37c6d60
Reorder boot/code spec includes for retail (#1667)
* Shuffle spec segments for retail

* Remove z_text.o from retail

* Un-#if DebugCamera_ScreenTextColored
2024-02-06 21:48:02 -05:00
Derek Hensley a2945801d6
rcp retail OK (#1713)
* rcp OK

* Format
2024-02-05 11:35:27 -05:00
blackgamma7 d49f5bd2d0 Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2024-02-05 05:28:54 -05:00
Lucas Shaw 36d4756e59
z_construct.c retail OK (#1716) 2024-02-05 02:17:23 -05:00
Lucas Shaw 7d2b7bce50
PreRender.c retail 1 not matching (#1710)
* one more function in prerender

* one non matching

* ran format.py

* var name change
2024-02-05 06:19:02 +01:00
cadmic 178e95ae50
Give debug_malloc.c the same treatment as system_malloc.c and z_malloc.c (#1700) 2024-02-03 10:59:25 -05:00
cadmic d9a1148d13
Match retail __osMalloc.c (#1684)
* Match retail __osMalloc.c

* Add TODO about N64 ArenaNode debug info

* FLAG prefix -> FLAG suffix
2024-02-02 17:37:32 -05:00
cadmic 8db76a27da
Match retail system_malloc.c and z_malloc.c (#1683)
* Match system_malloc.c and z_malloc.c

* Rename CHECK_POINTER
2024-02-02 15:01:49 -05:00
Dragorn421 0444a6f094
`.clang-format`: break short enums, TypenameMacros (#1671)
* IndentPPDirectives: AfterHash

* AllowShortEnumsOnASingleLine: false

* IndentPPDirectives: BeforeHash

* format

* format

* TypenameMacros: [BAD_RETURN]

* IndentPPDirectives: None
2024-02-02 14:46:12 -05:00
cadmic a337416530
Match retail code_800D31A0.c (#1698) 2024-02-02 13:33:00 -05:00
cadmic 67d4f0f36a
Match retail z_skin.c, z_skin_awb.c, z_skin_matrix.c (#1697)
* Match retail z_skin_matrix.c

* Match retail z_skin_awb.c

* Match retail z_skin.c

* Remove same-line hacks
2024-02-02 13:29:58 -05:00
engineer124 f23a05eecd
Misc Small Retail Files Part 2 OK (#1696)
* z_draw.c OK

* more files
2024-02-02 13:15:38 -05:00
fig02 23de92d2f9
Match z_debug for retail (#1694)
* match z_debug for retail

* prototype

* directive
2024-02-02 12:44:31 -05:00
cadmic 4e2d2885bc
Match retail padmgr.c and sys_rumble.c (#1693)
* Match retail padmgr.c

* Match retail sys_rumble.c

* Poke jenkins
2024-02-02 12:25:44 -05:00
cadmic 8f481b648d
Match retail effects files in code (#1690)
* Match code effects files

* Poke jenkins
2024-02-02 11:45:50 -05:00
cadmic 3be307bf35
Match stackcheck.c and code_800FC620.c (#1656)
* Match stackcheck.c

* Match code_800FC620.c
2024-02-01 23:17:17 -05:00
fig02 c701a2181f
match z_actor_dlftbls (#1679) 2024-02-01 22:56:17 -05:00
fig02 8d0076b010
Match retail Title and Sample gamestates (#1692)
* match title and sample

* change to directive

* no bad return
2024-02-01 19:52:52 -05:00
engineer124 9289b0211d
Retail `z_player_lib.c` OK (#1689)
* z_player_lib OK

* space

* line break
2024-02-01 19:36:48 -05:00
engineer124 a6d5e00925
z_scene_table.c OK (#1691) 2024-02-01 19:07:37 -05:00
engineer124 1e21f69b37
z_play retail OK (#1688)
* z_play OK

* cleanup spacing

* PR
2024-02-01 17:00:27 -05:00
engineer124 e33d76568c
Misc Small Retail Files OK (#1687)
* shrink_window, z_lib, z_lights OK

* sys_cfb.c OK

* cleanup
2024-02-01 11:15:53 -05:00
cadmic 7c5ab8fcec
Use IDO_PRINTF_WORKAROUND everywhere (#1685) 2024-02-01 10:11:33 -05:00
cadmic 99fd784bc2
Match sys_matrix.c (#1682) 2024-02-01 09:13:24 -05:00
fig02 593a86014c
Retail z_scene matching (#1677)
* one left

* cursed match for Scene_CommandObjectList

* format

* revert printf modification for permuter

* more bad-returns

* format

* typedef scene command func
2024-02-01 09:29:02 +01:00
Tharo 5e8e01f110
z_view.c gc-eu-mq OK (#1681)
* z_view.c retail

* Replace PERSPECTIVE_EDITOR_ACTIVE, adjust PRINTF selection condition

* Macro-ify View_ErrorCheckEyePosition
2024-01-31 20:09:16 -05:00
Derek Hensley 2bc159e518
Irqmgr and Sched Retail OK (#1678)
* irqmgr OK

* sched OK

* PR review renames
2024-01-31 19:26:31 -05:00
Derek Hensley 06379c3109
Gamealloc, Graph, and Graphalloc retail OK (#1675)
* Gamealloc OK

* Graph + Graphalloc OK

* PR review

* gfxalloc

* new lines

* Remove imposter
2024-01-31 19:07:12 -05:00
engineer124 a0d31dba68
Document Audio Thread Commands (#1399)
* begin docs

* cleanup

* copy over progress

* cleanup

* small cleanup

* more docs, fill out cmds

* small touchup

* pan weight ganon comment

* fix specId

* seqcmd cleanup

* format

* small cleanup

* one more thing

* small feedback from MM

* partial PR

* some PR Suggestions

* small adjustments

* ticks, seqticks, frames, updates: term cleanup

* small fix

* PR Review

* PR Review

* PR Review

* rm param

* adjust comment

* update renamed functions

* format

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2024-01-31 18:25:23 -05:00
cadmic 87a886df5b
Match sys_math3d.c (#1674) 2024-01-30 21:42:15 -05:00
engineer124 8ae003b0d7
z_actor retail OK (#1670)
* actor ok

* cleanup

* cleanup

* cleanup

* player

* ACTOR_PRINTF

* PR Suggestion

* gcc

* c file

* ACTOR_DEBUG_PRINTF

* bool

* more review

* newline
2024-01-30 21:07:34 -05:00
cadmic 17da5e7bf9
z_collision_check.c OK (#1642)
* Match z_collision_check.c

* Disable function declarations

* Remove /* OOT_DEBUG */

* Remove newlines around ifdef

* Newlines

* Tweak z_actor.c #if to avoid merge conflicts
2024-01-30 19:43:10 -05:00
Derek Hensley 77c9c97ff9
Overlay_Relocate and Overlay_Load retail OK (#1662)
* Overlay_Relocate OK

* Overlay_Load

* format

* PR + better match for Overlay_Load
2024-01-30 19:30:27 -05:00
fig02 8be8848f85
z_demo retail code matched (#1655)
* match all functions

* format

* clarify between 'dest' and 'skip' debug features

* format

* better match for CutsceneHandler_RunScript

* review

* format

* remove macro
2024-01-30 18:52:04 -05:00
cadmic 18b7030534
Revert bad uses of `if (OOT_DEBUG)` (#1666) 2024-01-30 15:19:00 -05:00
Derek Hensley 7b770dc1e0
vr_box OK (#1663) 2024-01-30 14:22:55 -05:00
cadmic 9816f62129
Define OOT_DEBUG=0 in retail builds (#1658)
* Define OOT_DEBUG=0 in retail builds

* Fix ifndef

* Replace VI_MODE_EDITOR_INACTIVE

* Revert "Replace VI_MODE_EDITOR_INACTIVE"

This reverts commit f7c4cae7c3.

* Replace VI_MODE_EDITOR_INACTIVE, take 2

* Revert EnBom_Draw
2024-01-30 13:54:38 -05:00
engineer124 6d09437c21
Retail `z_quake.c` and `z_room.c` OK (#1661)
* quake OK

* z_room OK
2024-01-29 21:08:35 -05:00
Yanis42 9f169a67cd
Match ``game.c`` - OK (#1644) 2024-01-29 15:27:29 -05:00
cadmic 6e0d67f9ec
Check formatting in CI (#1652)
* Check formatting in CI

* Move deleteDir() to cleanup section

* Revert "Move deleteDir() to cleanup section"

This reverts commit 4b0dd80cac.

* Give up on check_format.txt

* Fix formatting
2024-01-29 07:25:58 -05:00
engineer124 795f7e5251
`z_parameter` retail OK (#1649)
* z_parameter okay

* no u32
2024-01-28 16:20:21 -05:00
Yanis42 8a8b6cf90b
Match ``main.c`` - OK (#1645)
* main.c OK

* removed comment

* better match

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2024-01-28 15:46:08 -05:00
blackgamma7 bbf5f0e041
Merge branch 'main' into EnGs_Doc 2024-01-27 18:05:14 -05:00
Dragorn421 5e406f754e
Small `Math_Vec3f_Yaw` doc (#1433)
* Small `Math_Vec3f_Yaw` doc

* remove actor from arg names

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2024-01-18 17:56:54 -05:00
cadmic 6b5533ccd9
Create debug macros for LogUtils functions (#1610) 2024-01-16 09:59:02 -05:00
cadmic a5fbfdba01
Move Scene_SetTransitionForNextEntrance to z_scene.c (#1609) 2024-01-16 09:50:28 -05:00
Dragorn421 4982f32384
Name actor flags 1: `ACTOR_FLAG_REACT_TO_LENS`, `ACTOR_FLAG_IGNORE_POINT_LIGHTS` (#1583)
* 7 -> `ACTOR_FLAG_REACT_TO_LENS`

* move comment above actor flag

* 22 -> `ACTOR_FLAG_IGNORE_POINT_LIGHTS`

* newlines between flags

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2024-01-12 10:48:54 -05:00
cadmic 324db1d578
Replace most osSyncPrintf calls with PRINTF macro (#1598)
* Replace most osSyncPrintf calls with PRINTF macro

* DEBUG -> OOT_DEBUG
2024-01-12 10:38:13 -05:00
Dragorn421 1a8772e540
Cleanup `z_collision_check` 1 (#1427)
* Cleanup `z_collision_check.c` and structs

* Revert `other*` names to master, split to other pr

* WIP/experimental: `ColliderCylinderElement`

* Revert "WIP/experimental: `ColliderCylinderElement`"

This reverts commit cfc8c32ace.

* ac/atHitInfo -> HitElem

* rename some collider elements to "elem" (instead of item, info, hurtbox...)

* cut down on more "hitbox" usage

* name all `ColliderElement*` temps properly

* rearrange colcheck structs

* add collider shape name descriptions

* reword collider shape descriptions

* jntsph first again

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2024-01-11 10:30:47 -05:00
cadmic cd917b0cb8
Create debug macros for common functions (#1597)
* Create debug macros for common functions

* Revert NDEBUG change

* MALLOCR -> MALLOC_R

* DEBUG -> OOT_DEBUG

* Use the same name for debug and non-debug matrix functions

* Fix file/line argument order

* Revert g[s]DPNoOp[Tag]

* Use SystemArena_MallocDebug directly in GameAlloc_MallocDebug

* MTXF_TO_MTX -> MATRIX_TO_MTX
2024-01-09 07:59:03 -05:00
engineer124 e146d7bc26
Introduce Face Reaction Enum (#1586)
* face reactions

* cleanup

* cleanup fake match

* PR Review

* while I'm here

* mask reaction

* small fix

* Small cleanup

* oops
2024-01-08 17:17:22 -05:00
blackgamma7 ec103a67ae Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2023-12-13 09:22:12 -05:00
hiisuya cc96184a96
Doc Actor: En_Ma1 (Child Malon) (#1584)
* started malon documentation

* docd all event and inf table checks

* doc cleanup

* ran formatter

* fixed misnamed eventcheck

* revert isNotSinging oops

* removed unnecessary comments

* changed from handle to update

* revert vec3f name change

* moved texture information

* isNotSinging to singingDisabled

* rename of inftable and eventchk

* small cleanup

* anim enum change

* enum names for child malon limbs
2023-12-10 14:36:12 -05:00
blackgamma7 357727ae4d Merge remote-tracking branch 'upstream/main' into EnGs_Doc 2023-12-03 01:49:40 -05:00
cadmic 2ab90bc517
Document a bug in Actor_ChangeCategory where actors may not be updated correctly (#1587)
* Document Actor_ChangeCategory bug

* Reword

* actor update function -> actor update
2023-11-30 20:18:00 -05:00
Tharo 5ce4670fd1
Documentation for audio_thread_manager.c (#1562)
* Documentation for audio_thread_manager.c

* Fixes

* Move AudioTask back to z64audio.h and include in audiomgr.h, adjust bug comment

* Adjust AudioMgrDebugLevel enum
2023-11-30 16:22:30 -05:00
blackgamma7 26ef4bf073
Merge branch 'main' into EnGs_Doc 2023-11-26 15:57:19 -05:00
engineer124 f2c06ce441
Misc Cleanup (#1585)
* misc cleanup

* more fake matches

* revert for sym
2023-11-22 04:19:31 -05:00
engineer124 aef0335681
Struct Returns (#1574)
* change args

* PR Review

* format
2023-11-19 11:17:31 -05:00
engineer124 3d1ee33d7b
Document Actor "OfferTalk" (#1567)
* OfferTalk

* rm comment

* exch to offer in comment

* reword again

* Partial PR Review

* Actor_AcknowledgeTalking

* Actor_TalkOfferAccepted

* PR Review

* rm part of comment

* rm comment
2023-11-19 11:11:59 -05:00
engineer124 81a3c3da32
More Camera Flags (#1453)
* Generic Camera Flags

* New flag names

* Add flags to functions

* Finish flag docs

* More docs

* More cleanup

* More clarity

* Better shrinkwindow flag docs

* Improve name

* CAM_INTERFACE_FLAGS

* Better approach to edge cases

* Change ordering for consistency

* Oops

* Add masks to macro

* PR/Discord discussions

* cleanup comment

* Oops

* PR Suggestions

* More PR Feedback

* More PR Suggestions

* More Camera Flags

* PR Suggestions

* More flag style change

* Small cleanup

* More flag docs

* Another flag

* Fix flags

* sync names with other PRs

* more fixes

* fix comments

* update with hud visibility mode docs

* missed one

* fix comments

* Roman PR Suggestions

* interfaceField

* small fix

* letterbox cleanup

* cleanup

* fix macro arg

* fix func declaration

* many more docs

* better docs?

* missed some

* oops, revert

* add flags to name

* cleanup

* flag

* double signal

* simplify cam func name

* more suggestions

* PR Suggestion
2023-11-19 02:17:32 +01:00
Dragorn421 4c75260097
Fix misc 21 (#1573)
* Make `sNew` in (unused) `code_800FC620.c` a string

It is passed as a filename to `__osMallocDebug` so should be a nul-terminated string, not a char[3] missing an explicit \0

* Fix gcc warning in `JpegDecoder_ParseNextSymbol` about SLL on negative value

-1U is an unsigned value, aka 0xFFFFFFFF
I keep -1 because it seems that's what a jpeg standard has too

References:
https://stackoverflow.com/questions/40508958/shifting-a-negative-signed-value-is-undefined
https://www.w3.org/Graphics/JPEG/itu-t81.pdf (page 105, figure F.12)

* Small cleanup

* Fix few mistakes (thanks gcc warnings)

* Add `@bug` in file select settings draw code, using the wrong array

* format

* format main

* rename arg for a happy formatter

* Move important function call out of a printf
2023-11-12 16:59:52 -05:00
Javarooster dc323052c3
Changed gLinkChildSlinghotStringDL to gLinkChildSlingshotStringDL (#1576) 2023-11-12 00:01:55 +01:00
fig02 836adb83ea
Rename "ITEM_LAST_USED" (#1572)
* rename

* format

* remove formatter changes

* change model group comments
2023-11-07 14:11:59 -05:00
Dragorn421 8718a5c8c0
Remove `(ActorFunc)` casts in initvars (#1571)
* Remove `(ActorFunc)` casts in initvars, use `/**/` trick for format

Achieved by using the following regex:

(ActorInit.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*)(\n\s+)(?:\(ActorFunc\))?(.*\n\};)

replaced with

$1$2/**/ $3$4/**/ $5$6/**/ $7$8/**/ $9$10/**/ $11$12/**/ $13$14/**/ $15$16/**/ $17$18/**/ $19

plus a change from /**/ to #if 0 #endif in docs/

* Manual fixes
2023-10-30 10:19:16 -04:00
fig02 4908b8b37c
Player Docs: public facing csAction things (#1561)
* name public csAction functions

* format

* adjust function comment

* format
2023-10-28 07:46:24 -04:00
Tharo 3475651701
libc cleanup (#1568)
* libc cleanup

* Suggested changes, small alloca tweak

* Remove printf include
2023-10-27 16:06:44 +02:00
Tharo a20163c6ab
Use `long` over `int` for s32/u32 types (#1546)
* long s32

* Suggested changes
2023-10-17 21:16:31 +02:00
cadmic b3486b57ef
Rename Math3D_CylOutsideCyl and Math3D_CylOutsideCylDist (#1557)
* Rename Math3D_CylOutsideCyl and Math3D_CylOutsideCylDist

* radix -> radii

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

* Make Math3D sphere/cylinder collision check function names more consistent

---------

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2023-10-07 19:42:28 -04:00
fig02 181b438393
Player Docs: Propose Named Unions For Shared Variables (#1560)
* make unions

* format

* adjust comment on halt thing
2023-10-07 19:25:45 -04:00
fig02 2cb4ff4fd3
Player Docs: csMode -> csAction (#1547)
* csmode -> cs action

* format
2023-09-26 12:48:41 -04:00
Derek Hensley 4d7558df0d
Speedmeter Small cleanup (#1554)
* Small cleanup

* x
2023-09-25 06:29:15 -04:00
Dragorn421 fefeb369dd
Name the main pause state and add placeholder enum for main (sub)states (#1551) 2023-09-22 14:48:09 -04:00
fig02 da3f4718f0
Player docs: Control Stick Input and Movement (#1539)
* document input stuff and movement speed+yaw

* curve -> curved, and other cleanups

* fix + format

* function declaration

* name arguments

* add mode descriptions

* fix typos

* move comment down
2023-09-19 21:37:03 -04:00
Dragorn421 57ce0cf8d9
Doc/Cleanup pass on object handling (#1227)
* `Object_InitBank` -> `Object_InitContext`

* Add and use `OBJECT_SPACE_SIZE_BASE`

* Remove `OBJECT_EXCHANGE_BANK_MAX` -> use `ARRAY_COUNT()` instead

* "object status" -> "object load entry"

* Misc. cleanup/renames

* Partial docs and way too much batch renaming and cleanup for a single commit

* ctrl shift h

* format

* format clang-11.1

* fix regressions

* Improve a `@bug` comment

* Move `OBJECT_SPACE_SIZE_BASE` from header to near `Object_InitContext`

* "objectID" -> "objectId"

* Revert iterator index to `i` in `Actor_KillActorsWithUnloadedObject`

* "object load entry index" -> "object entry"

* `Object_UpdateLoadEntries` -> `Object_UpdateEntries`

* Run format.sh

* "object entry" -> "object slot" (except internal usage)

* Proper `Object_SpawnPersistent` doc

Co-authored-by: fig02 <fig02srl@gmail.com>

* fixup one comment "object bank index" -> "object slot"

* Amend `Object_SpawnPersistent` comment to mention running out of free slots

* `Actor_KillActorsWithUnloadedObject` -> `Actor_KillAllWithMissingObject`

* Remove useless mention of what uses `Object_SpawnPersistent`

* Fix mistake on `Object_SpawnPersistent` doing sync dma, not async

* run formatter

* `Object_InitContext` -> `Object_Init`

* `waitObjectSlot` -> `requiredObjectSlot`

* `Object_Init` -> `func_80097DD8`

* one objectIndex -> objectSlot

* Remove `OBJECT_SPACE_SIZE_BASE`

* light fix on the merge (rm OBJECT_EXCHANGE_BANK_MAX)

* `func_80097DD8` -> `Object_InitContext`

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-09-19 14:10:12 -04:00
Tharo 9b207c356a
Document Framebuffer Filters, VisCvg and VisZbuf (#1534)
* Document z_viscvg and z_viszbuf

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>

* Few more notes

* Some more notes

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

* Review

* Americanisation, FB RGB

* Oops

* Review

* Minor documentation modifications

* Header, base struct and enums

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

* functions.h fix

* Suggested changes, further adjustments to file doc comments

* Further suggested changes, standardize capitalization of gfxP

* g

---------

Co-authored-by: Elliptic Ellipsis <elliptic.ellipsis@gmail.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2023-09-16 17:16:58 -04:00
Yanis42 239a172114
remove the extra ``CS_CMD_STOP`` (#1535) 2023-09-14 18:41:10 -04:00
fig02 7145bc346d
Document Camera Special9 (door) angle bug (#1525)
* document special9 angle bug

* Update src/code/z_camera.c

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

---------

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2023-09-13 20:21:54 -04:00
Tharo 7235af2249
Apply noreturn attribute where applicable (#1532) 2023-09-09 10:24:52 -04:00
Dragorn421 d314cfe923
Document pause states (excluding gameover) (#1483)
* Document PauseContext.state

* Very light docs surrounding pause states

* PAUSE_STATE_UNPAUSE -> PAUSE_STATE_RESUME_GAMEPLAY and comment on purpose in the enum

* PAUSE_STATE_MAIN -> PAUSE_STATE_6

* format

* Player_InitDrawPause -> Player_InitPauseDrawData
2023-09-06 11:14:15 -04:00
blackgamma7 6980105a1e Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2023-08-29 12:26:43 -04:00
Billy fc3e0f080b
En_Cow Doc (#1492)
* Add Documentation for Cows

* Better naming for cow unlock flag

* Update with MM solutions and PR suggestions

* Readable conditions

* Decimal cycle counter

* Replace params with cow type

* Clean up type usage and function names

* Clean up cylinders

* Fix collider enum

* Rename EnCow rear collider

* Fix spacing

* PR fixes:
COLL -> COLLIDER enum
static prefix
Missed MM function naming
Specific actor flags naming

* Rename of healRot and breathTimer

* Document Epona's song reset behavior

* anon review

* fig review

* whitespace

* rework milk interaction stuff

* changes to milk comment

---------

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-08-19 11:34:48 -04:00
Dragorn421 d6207b17c2
Doc/cleanup pass on effects 1 (#1421)
* Some doc/cleanup on `Effect_Ss_Fhg_Flash`

* Some doc/cleanup on `Effect_Ss_Blast`

* 11DA0 -> Billboard

* doc three lerp funcs in effectss

* Some doc/cleanup on `Effect_Ss_Bomb`

* `rTexIdx` -> `rTexIndex`

* lifespan

* `LIFESPAN` -> `EFFSSBOMB_LIFESPAN`

* --parentheses

* Add todo about "having zapd forward declare static variables"

* try rework comments on effects scale

* lightning -> "a ball of electrical arcs" ?
2023-08-15 20:28:12 -04:00
Dragorn421 4dea0bfb26
Placeholder names for skelanime moveflags (#1489)
* Add defines for all used animflags

* Use named constants (and add two) for players `func_80832F54` flags

* note which flags are player-only

* Attempt at documenting but too FeelsUnkMan again

* forgot something

* ANIM_FLAG_PLAYER_0 -> ANIM_FLAG_0 and amend comment from "player-only" to "no effect outside player"

* 1<<n flags
2023-08-15 22:23:53 +02:00
Dragorn421 9e9d62cf71
Cleanup/add bgcheck macros (#1478)
* Cleanup/add bgcheck macros

* vIA -> vI

* parentheses around bit&

* achivement get: formatter contrarian

* COLPOLY_VTX_FLAGS -> COLPOLY_VTX_FLAGS_MASKED

* & before << in WATERBOX_PROPERTIES packing macro

* & before << in SURFACETYPE* packing macro and fix parentheses
2023-08-15 22:12:50 +02:00
Dragorn421 ccae1f7387
Split z64.h: move various things, state, sram, gfx, jpeg, prerender, speedmeter (#1487)
* Split z64.h more

* fix speedmeter.h (expect this kind of issue resolution to pop up eventually)

* fix z64object.h

* fix z64state.h

* fix (probably only partially) z64play.h

* fix fix speedmeter.h :)

* revert making a play header (sadge), add/split transition & transition_instances

* move stuff to cutscene, interface

* Move `TransitionCircle%` enums to `z64transition_instances.h`

* z64state.h -> z64game.h with a "this is not final" comment

* forward declare GraphicsContext in z64game.h instead of including the header file for it

* don't comment on where the forward declarations are from

reasoning:
1) it's easy to go out of sync (like this comment, it was outdated anyway)
2) any IDE can easily find the struct anyway
2023-08-15 12:21:19 -04:00
engineer124 b8aa2a251e
Document z_lib Sfx Functions (#1470)
* document lib sfx

* rename functions
2023-08-15 01:44:20 -04:00
Tharo 18d609c1a3
Mention why PrimDepth is used in `PreRender_FetchFbufCoverage` (#1520)
* Mention why PrimDepth is used in PreRender_FetchFbufCoverage

* Clarify that this only affects the memory alpha blender input, not all alpha blender inputs

* Try to make the subtle difference between coverage and memory alpha more clear
2023-08-15 01:21:12 -04:00
Dragorn421 6e7a6d4181
Split `SaveContext` into sub-structs (#1393)
* Split SaveContext struct

* run formatter

* Remove temporary-until-split stuff in z_sram

* .

* run formatter
2023-08-13 15:24:26 -04:00
fig02 52e0b8549d
document bugs (#1519) 2023-08-13 17:32:18 +02:00
Dragorn421 b8c1440d1e
Cleanup?: Use gotos in z_play for large else blocks (#1486)
* remove else when using `goto Play_Draw_DrawOverlayElements`

* Add `goto Play_Draw_skip`, use on prerender save

* format
2023-08-13 10:35:38 -04:00
blackgamma7 6ca6a002d3 Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2023-07-29 10:31:41 -04:00
Dragorn421 5fa018106b
Prefer clang-format-14 (#1517)
* Change preferred clang version to 14 (for formatting)

* Add `--show-paths` arg to format.py for printing paths to clang-* binaries used

* Run formatter (clang-format-14)

* run formatter
2023-07-27 19:48:42 -04:00
blackgamma7 f2c0ea619a Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2023-07-13 14:16:28 -04:00
Roman971 232fdb75d8
Use intptr in most remaining code files (#1438)
* Use intptr in most remaining code files

* Fix missing uintptr_t in actor

* Use u8* casts for texture pointer arithmetic

* Use bg + 1 instead of casting in Room_DrawBackground2D
2023-07-10 15:03:01 -04:00
blackgamma7 3155041661 Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2023-07-07 02:11:51 -04:00
engineer124 d307a37233
Reorganize Audio Files & Name Remaining Audio Files (#1494)
* reorganize audio files

* audio code files

* split audio and libaudio

* audio_init_params to audio_configuration

* simplify file names

* move aisetnextbuf to libaudio

* move src/audio -> src/code/audio

* adjust makefile comment

* reorganize again into internal/external

* adjust comment

* restructure again
2023-07-06 17:55:10 -04:00
engineer124 0ce0313342
Minor Misc Cleanup 3 (#1502)
* more misc cleanup

* remove z64 conflicts

* undo ISVDbg
2023-07-05 18:36:19 -04:00
Tharo 54638f9768
Reduce hardcoded constants in Lights_GlowCheck, some more comments on the CPU driven depth test and z-buffer value conversion (#1506) 2023-07-05 00:37:31 +02:00
Tharo 47ffb59f68
Generate gamestate overlay table with an `include/tables/` header (#1504)
* Generate gamestate overlay table from an include/tables/ header

* GameStateIndex -> GameStateId, move to z64.h, add GameStateId enum name field to the gamestate table, adjust and improve gamestate table comment

* Shorten zeros in table definition

* Generate linker symbols, other suggested changes

* GAMESTATE_MAX -> GAMESTATE_ID_MAX like the others
2023-07-04 12:36:55 -04:00
Tharo 100576edc9
Documentation for skybox drawing (#1515) 2023-07-03 22:30:53 -04:00
Tharo d5410fa2b8
Fix comment about RM_VISCVG in PreRender_FetchFbufCoverage (#1514) 2023-07-03 19:14:31 -04:00
blackgamma7 62308f3c72 Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2023-03-17 03:18:41 -04:00
Tharo 12f67e108a
Further documentation for overlay relocation (#1498)
* Further documentation for overlay relocation

* Suggested changes

* Format

* REL_ -> RELOC_
2023-02-27 09:14:02 +01:00
engineer124 35887e25ee
Minor Misc Cleanup 2 (#1422)
* misc cleanup

* more cleanup

* more cleanup

* PR Suggestions

* cleanup cond
2023-02-26 21:48:42 +01:00
blackgamma7 cbb5d5714c `En_Sw`: wallpolynormal -> surfaceNormal 2023-01-21 15:16:17 -05:00
blackgamma7 b7bc02821b Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2023-01-13 21:34:07 -05:00
engineer124 905b7087de
Document OnePointCutscene Init Field (#1465)
* player csmode enum

* cleanup

* missed one, player2

* spell out enum name

* use CSMODE_MAX for data

* doc OnePointDemo Field

* PR Suggestions

* another suggestion

* duplicate word

* adjust comment

* cleanup comments

* oops
2023-01-12 20:30:41 -05:00
Dragorn421 985dd7f520
`EnHoll` docs (door-less transition between rooms) (#1419)
* some EnHoll cleanup

* some more EnHoll cleanup

* even more EnHoll cleanup

* EnHoll docs

* `enHollFillAlpha` -> `bgCoverAlpha`

* Dl -> DL

* one temp: action -> type

* Move static data out of `EnHoll_HorizontalVisibleNarrow`

* "fade" -> "bgcover"

* spread sentence over several lines

* tweak comments formatting

Co-authored-by: fig02 <fig02srl@gmail.com>
2023-01-12 17:08:38 -05:00
engineer124 1149530c92
DbCamera to DebugCamera (#1482)
* better dbCam prefix

* missed some

* PR Suggestions

* alignment

* more debug

* cleanup
2023-01-12 16:06:31 -05:00
Dragorn421 542012efa6
Fix misc 19 (#1488)
* "bgs sword" -> "biggoron sword"

* Animation_ChangeImpl: last arg is `ANIMTAPER_` enum

* TransitionTileStatus -> state

* Tiny gbi.h formatting fixups

* some cleanup on floormaster

* misc float ops cleanup

* sunsSongState = SUNSSONG_INACTIVE

* continueFlag == CS_CMD_STOP

* fix few camera names inconsistency

* textual 0 padding? not on my lawn

* libultra: construct address from end of dmem rather than oob from imem

* more free1 -> 2 fixup
2023-01-10 13:03:31 -05:00
blackgamma7 1c0d21f548 Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2023-01-03 02:17:03 -05:00
fig02 b4c97ce17e
Cleanup player speed and yaw variable names (#1480)
* initial changes

* add comments
2023-01-02 06:15:48 -05:00
Tharo e77b83cf1b
Import fault bss under NON_MATCHING (#1484)
* Import fault bss under NON_MATCHING

* Fix comments in data files

* Fix variable name
2023-01-02 05:52:56 -05:00
fig02 e37b993483
Name movement related functions in z_actor (#1476)
* rename functions

* dragorns name suggestions

* Revert "dragorns name suggestions"

This reverts commit dd4626ce5e.

* lets try that again

* reword comment

* comments

* projectile speed

* arg name

* more comments

* minVelY comment

* merge master and format
2022-12-30 13:55:14 -05:00
fig02 04641a6b69
Document debug text drawing functions in z_debug.c (#1472)
* name functions and clean up some stuff

* clean up function call args and use enum, format

* slightly change comment

* review

* make things more debug cam oriented

* rename buffer

* regs update comment

* move enum
2022-12-30 02:23:09 +01:00
Derek Hensley bd317dbb9d
Fbdemo Docs: `TransitionTile` (#1471)
* TransitionTile'

* Final clean up

* PR

* Header comment

* vtx_tn

* Name background DL

* row <-> col

* Rename update functions

* Update header

* Enum

* Done -> Ready + cleanups

* Update include/z64transition.h

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

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-12-28 22:29:59 +01:00
Dragorn421 89b42d0d3a
Misc. small cam doc (#1461)
* `Camera.posOffset` -> `Camera.playerToAtOffset`

* calcSlopeYAdj bool cleanup

* `Camera_CalcAtForLockOn` flags defines -> `CAM_LOCKON_AT_FLAG_`

* yOffset

* More cleanup

* isOffGround
2022-12-26 20:45:20 +01:00
fig02 7927e7b330
z_demo documentation (#1327)
* commit old stuff

* progress

* progress

* progress

* progress

* more progress, renaming cues next

* small changes

* enum values added for all actions

* hardcoded values removed when possible

* commands renamed

* first pass of action -> cue

* fix some matches

* some more cleanup

* scriptPtr

* forgot one

* remove cue rot union

* more changes

* some more stuff

* more stuff

* fix matching issues

* some more things

* progress, starting to rename destinations

* small changes

* name some destinations

* more names

* need to switch branch

* progress

* first pass of destination names

* usages fixed

* use destination enum

* fix csdis

* format

* command descriptions

* revert accidental zap changes

* forgot some things

* use a single macro for CutsceneCameraPoint (idk why i didnt think of this sooner)

* typo

* review1

* clarify ruby/sapphire comment

* remove endframe for commands that dont use it

* some more review

* most review, but not all

* scriptPtr -> script, and another small change

* ocarina action

* remove +1 from light settings command, change comment

* actionIndex -> cueIdTemp (i guess)

* _SetCueX -> _SetXFromCue

* format

* tweak fade out seq arg names

* use spline terminology

* more dragorn and engineer review

* misc start/end frame note

* cleanup StartPosRotFromCue vs PosRotFromCue

* cleanup spline terminology

* sPrevCamId -> sReturnToCamId

* comment on debug cs data address

* Cutscene_Init -> Cutscene_InitContext

* single point types are not a list

* remove todo comment

* some more review

* rumble struct names

* some review

* more review

* missed one

* reword pointer comment

* even more review

* match transition terminology with z_play

* change condition and format

* frame count

* command specific structs with alignment

* anon review

* remove unneeded arg from time macro

* yeet `CsCmdGeneric`

* remove unused from single point types

* typo

* compromise attempt -- name endFrame everywhere

* fixes

* fix again

* copied the wrong note

* cutscene data note

* review, format

* compat defines

* idk whats going on man

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-12-24 13:55:17 -05:00
fig02 92e03cf747
speedXZ -> speed (#1477)
* speedXZ -> speed

* +=

* revert arg in player function

* anon review

* engineer review

* forgot one

* last review

* revert decimal
2022-12-24 12:18:57 -05:00
Derek Hensley 4a9873775c
TransitionFade docs and clean up other transitions (#1459)
* TransitionFade docs

* PR suggestions

* Fix

* Fill

* Other transitions + enums

* Prefix transition assests with trans

* Fix end_title

* format

* OutNames

* nitpicks PR

* cleaner
2022-12-24 03:46:56 +01:00
fig02 1c6878b070
Name `Message_StartOcarina` and related things (#1473)
* name functions and msg ctx var

* start ocarina

* clarifying comments

* typo
2022-12-20 23:03:41 +01:00
Dragorn421 738268a79a
`R_PAUSE_MENU_MODE` -> `R_PAUSE_BG_PRERENDER_STATE` and docs (#1368)
* `R_PAUSE_MENU_MODE` -> `R_PAUSE_BG_PRERENDER_STATE` and document values and usage

* `SREG(33)` -> `R_GRAPH_TASKSET00_FLAGS`

* format

* `PAUSE_BG_PRERENDER_DRAW` -> `PAUSE_BG_PRERENDER_SETUP`

* `PAUSE_BG_PRERENDER_FILTER` -> `PAUSE_BG_PRERENDER_PROCESS`

* DList -> display list
2022-12-19 19:19:57 -05:00
blackgamma7 42e3e05328 Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2022-12-19 00:40:42 -05:00
engineer124 be22b836f6
Name `Actor_PlaySfx` and `Player_PlaySfx` (#1469)
* name two main actor sfx functions

* adjust comments

* fix double s in player

* fix commas
2022-12-18 23:18:21 -05:00
blackgamma7 d64fbe7e63 Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2022-12-18 21:09:25 -05:00
blackgamma7 4c38925381 `z_en_sw`: changes based on feedback 2022-12-18 21:09:18 -05:00
engineer124 70bbcebbfe
OnePointCutscene Cleanup (#1467)
* cleanup

* more cleanup

* attention cs

* remove comment
2022-12-19 02:09:13 +01:00
engineer124 934d488420
`z_play`: Camera Docs and Cleanup (#1460)
* begin docs

* More suggestions

* more docs

* timer to duration

* partial PR review

* init data with player

* consistent comments

* withPlayer to usingPlayer
2022-12-17 16:07:31 -05:00
blackgamma7 5c49da99be Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2022-12-16 18:16:05 -05:00
engineer124 aa48c66e10
Introduce Player csMode enum (#1462)
* player csmode enum

* cleanup

* missed one, player2

* spell out enum name

* use CSMODE_MAX for data
2022-12-12 22:22:56 -05:00
Dragorn421 880e7c937c
Some cleanup/doc on the item icons (#1263)
* Some cleanup/doc on the item enum and icons

* `gItemIconBigBottlePoeTex` -> `gItemIconBottleBigPoeTex`

* Biggoron sword / giant knife items (?)

* `SPSTONE_` -> `SPIRITUAL_` ?

* `gItemIconBrokenBiggoronSwordTex` -> `gItemIconBrokenGoronsSwordTex`

* `gQuestIcon...MedallionTex` -> `gQuestIconMedallion...Tex`

* `ITEM_MAGIC_` -> `ITEM_MAGIC_JAR_`small/big

* `ITEM_BOW_ARROW_` -> `ITEM_BOW_`

* `MASK_BUNNY` -> `MASK_BUNNY_HOOD`

* Update `GID_` enum from `ITEM_` enum

* ITEM/GID`_ARROW_`small/medium/large -> 5/10/30

* Run formatter

* .

* fix regressions and revert bad ideas

* chicken

* obey the newline police and also prevent the range police from intervening

* fixups

* dimensions -> dimension (singular)

* Note on inconsequential oddities about the `gItemIcons` mapping
2022-12-12 21:45:54 -05:00
Anghelo Carvajal c420885513
`z_actor` documentation pass (#1445)
* Actor_Offer* and Actor_SetClosestSecretDistance

* color filter stuff

* KillAll

* format

* comment

* Update src/code/z_actor.c

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

* review

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

* format

* COLORFILTER_INTENSITY_FLAG

* Remove -

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

* yeet COLORFILTER_GET_XLUFLAG

* bug

* frug

* Undo Actor_KillAllFromUnloadedRooms

* update Actor_OfferGetItem comment

* Update Actor_OfferGetItem description

* diving

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-12-12 21:23:14 -05:00
engineer124 da06e9a701
OnePointDemo ActionFlags Macros (#1451)
* actionflags

* more macros

* distinguish enums better

* PR Suggestions

* Update src/code/z_camera_data.inc.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

* Update src/code/z_camera_data.inc.c

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>

Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>
2022-12-11 22:18:36 -05:00
engineer124 2e9e895bf9
Good Camera Mode Names (#1455)
* better camera mode names

* cleanup

* improve aiming modes

* follow boomerang comment

* more mode docs

* cleanup

* hookshotFly, revert to still
2022-12-11 10:46:03 +01:00
blackgamma7 1045c637e6 Merge remote-tracking branch 'upstream/master' into EnGs_Doc 2022-12-07 10:31:31 -05:00
Dragorn421 9bad1d108e
Cleanup post good scene names (#1452)
* Cleanup scene names

* missing scene id use

* rename scene draw config functions

* remove now useless comments

* format

* fix double defense/magic swapped

* try precision on "from potion shop"

Co-authored-by: engineer124 <engineer124engineer124@gmail.com>
2022-12-05 13:37:40 -05:00
engineer124 8ff58118b3
Camera Flags (#1225)
* Generic Camera Flags

* New flag names

* Add flags to functions

* Finish flag docs

* More docs

* More cleanup

* More clarity

* Better shrinkwindow flag docs

* Improve name

* CAM_INTERFACE_FLAGS

* Better approach to edge cases

* Change ordering for consistency

* Oops

* Add masks to macro

* PR/Discord discussions

* cleanup comment

* Oops

* PR Suggestions

* More PR Feedback

* More PR Suggestions

* PR Suggestions

* More flag style change

* Small cleanup

* sync names with other PRs

* more fixes

* fix comments

* update with hud visibility mode docs

* missed one

* fix comments

* Roman PR Suggestions

* interfaceField

* small fix

* letterbox cleanup

* fix macro arg

* fix func declaration
2022-12-04 23:02:24 -05:00
Dragorn421 da2e8a8f2c
Skelanime/Animation header cleanup (#1434)
* Skelanime/Animation header cleanup

* touch up names of the two existing moveFlags macros

* formatter is a dum dum D:
2022-11-30 18:46:12 +01:00
engineer124 1587c5505a
Document Camera for Elevator Platforms (Camera_Special7) (#1448)
* document camera for vertical platforms

* cleanup

* another rename

* small

* another rename

* add comment

* PR Suggestions

* more cleanup

* oops

* adjust comment
2022-11-26 18:15:33 -05:00
engineer124 c7a61aa670
Document Surface Material (#1447)
* material

* cleanup

* iron boots

* climb

* more docs

* rename

* small fix

* comments

* adjust bug comment

* simplify comment
2022-11-26 18:11:06 -05:00
Dragorn421 92f081d7f3
Add skybox .h and cleanup, `SkyboxDraw_` -> `Skybox_` (#1435)
* Add skybox .h and cleanup

* move forward declared structs to top of file

* `SkyboxDraw_` -> `Skybox_`

* format

* move more forward declared structs to top of file
2022-11-26 17:53:41 -05:00
Dragorn421 186ecc72b5
Name scenes (scene enum, entrance enum, various identifiers) (#1343)
* Comment names on titled scenes

* Comment some more scene names

* Comment some map assets symbol prefixes

* Name collapse sequence scenes (from the non-collapse equivalent scene's name + `_COLLAPSE`)

* Name ganon/ganondorf boss scenes (symbol prefix suffixed with `Scene` to prevent confusion with boss actors)

* Fix symbol prefix for back alley night scene

* Name the two grave scenes (normal and fairy's fountain variant)

* Name most houses, name/update misc scenes

Co-authored-by: fig02 <fig02srl@gmail.com>

* (hakaana) `GRAVE` -> `REDEAD_GRAVE` to be more specific

Co-authored-by: fig02 <fig02srl@gmail.com>

* `miharigoya_scene`: `market_guard_house`

* `kakariko_scene` -> `kakariko_center_house`

* `richards_house` -> `dog_lady_house` (for localization differences)

* Revert "Comment some map assets symbol prefixes"

This reverts commit 210a38a628.

* remove other xml prefixes

* ganon_boss, ganondorf_boss

* comments to namefixer

* `KAKARIKO_CENTER_HOUSE` -> `KAKARIKO_CENTER_GUEST_HOUSE`

* two collapse sequence scenes -> `GANONS_TOWER_COLLAPSE_`interior/exterior

* Run namefixer

`find src include -type f -exec ./tools/namefixer.py {} \;`

* run formatter

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-11-26 16:15:41 -05:00
fig02 eb0a82c513
Document HREG debugging system (#1351)
* progress

* progress

* change

* named most

* name prerender things

* fix and format

* play prefix

* address most comments (still a few more things to do)

* fix error

* reword input test comments

* some more

* rework env draw flags

* add hilite

* merge and format

* init to proper values

* rename env draw flag names

* 7 to 6

* more small changes
2022-11-26 15:22:01 -05:00
Lauri Koskela b57f2162ee
Document NPC talking and player tracking (#1426)
* Rename npc dialog state variable

* Rename and doc NPC actor talking funtion

* Introduce NpcTalkState enum

* Rename NPC_TALK_STATE enum values

* Document NpcPlayerInteractionState and related functions

* Rename player tracking opt enum variants

* Rename npc functions, interact info

* Minor npc actor function tweaks

* Minor comment fixes for npc

* Generalize NPC player tracking to point tracking

* Change unused NpcInteractInfo field type and name

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Rename headRot and torsoRot

* Rename GetTalkState to UpdateTalkState

* Minor comment fixes

* Rename rotateActorShape and clarify related comments

* Remove unneeded parentheses in z_en_heishi4.c

* Reformat

* Remove unclear comment

* Rename yPosOffset to yOffset

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2022-11-25 12:52:28 -05:00
blackgamma7 586a8828e5 `z_en_Sw`: doc staring
- docing fields and funcs
- creating enums for Skultula types
- macro for getting type from params.
2022-11-22 14:05:53 -05:00
engineer124 9c35716fe2
Document Hud Mode (#1323)
* begin interface alpha docs

* more progress/docs

* First draft of docs done

* cleanup

* Consistency

* Display -> Mode

* Remaining display -> mode

* Better docs

* Small touchups

* Small Update

* Apply discord discussion

* small fix

* More discussions

* PR Suggestions

* Roman PR Suggestions

* better comments

* PR Suggestions

* another suggestion

* discord discussions

* cleanup comments

* more discord/pr suggestions
2022-11-22 04:01:44 +01:00
Dragorn421 9cdd1678e2
Small `Actor_UpdateAll` doc (#1432)
* Small `Actor_UpdateAll` doc

* improve, "freeze"

* rename "freeze category masks"

* shorten to "category freeze mask" everywhere
2022-11-20 19:58:20 -05:00
Tharo 7ecafcfe7d
More documentation for `z_std_dma.c` (#1415)
* More documentation for z_std_dma

* uintptr casts for rom symbols in z64animation.h and z_kanfont.c

* Format

* Suggested changes, more defines for static texture sizes

* PI Interface -> PI

* Further suggested changes

* Format

* Comments about item_name and map_name texture assumptions
2022-11-16 21:57:02 -05:00
engineer124 40639e698d
Document Timers (#1412)
* Document Timers, First Draft

* some progress

* more timer docs

* cleanup

* small cleanup

* more cleanup

* comments

* more cleanup

* extra comment

* more docs

* brackets

* PR Suggestions

* cleanup, missed some

* more suggestions

* more PR Suggestions

* small change

* environmental
2022-11-16 13:41:27 -05:00
Dragorn421 cc2409606e
Update item names (#1376)
* Reevaluate item names (`ItemID` enum)

* format

* Carry `ItemID` changes to `ExchangeItemID`

* format

* Add item enum comments on items to slots array

* Rename slots according to current item enum names

* Add item enum comments on items to PlayerItemAction array

* Rename PlayerItemAction enum names according to current item enum names

* gi, gid names...

* `QUEST_GERUDO_CARD` -> `QUEST_GERUDOS_CARD`

* `DUNGEON_KEY_BOSS` -> `DUNGEON_BOSS_KEY`

* `UPG_` sticks/nuts : +deku

* Fixed remove array enum comments in `sDebugSaveEquips`

* "magic beans" -> "magic bean" (singular)

* cucco -> chicken (the one from weird egg, "alarm clock bird" from literal japanese translation)
2022-11-16 13:23:27 -05:00
Tharo acc077a24c
Mempak doc (#1382)
* Mempak doc

* Format

* Suggested changes

* Further changes
2022-11-16 02:32:07 -05:00
Tharo 6d5287ff12
TwoHeadArena and TwoHeadGfxArena docs (#1349)
* TwoHeadArena and TwoHeadGfxArena docs, ALIGNOF macro

* AllocStart -> AllocHead , AllocEnd -> AllocTail

* Format

* Suggested changes

* Fix

* Further suggested changes
2022-11-13 18:29:50 -05:00
Tharo c165ed015c
Improvements to Video Interface related functions and data (#1332)
* Improvements to VI related functions

* Fix

* Suggested changes

* Comment enum values

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

* Suggested changes, plus comments in visetspecial.c

* Name gViConfigModeType

* Further suggested changes

* Format

* Fix comment on modeLPN2

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2022-11-13 18:07:27 -05:00
Dragorn421 abb4201e57
Fix misc 18 (#1423)
* two more ABS

* fixup item_name_static texs outnames

* fixup CollisionCheck_SetOCvsOC docs

* Cleanup int comments alignments

* collsion -> collision

* `SQ*` macros fixup

* use `LERP` more

* static -> `s` prefix

* grammar: dont -> don't

* 3
2022-11-13 23:47:25 +01:00
Tharo efe485f017
Improve rcp.h, remove `HW_REG` macro (#1425)
* Real rcp.h

* Correction to comment in initialize.c

* Try fix R4300.h

* Adjust rcp.h formatting, remove defines in other headers that are now in rcp.h

* Suggested changes, document a bug in the modified osAiSetNextBuffer

* More rcp.h formatting changes
2022-11-13 02:16:01 -05:00
Dragorn421 ab90300062
Rename `vt.h` to `terminal.h` (#1339)
* `vt.h` -> `terminal.h`

* `VT_` -> `T_` (as in Terminal)

* `vt.h` -> `terminal.h` in includes too Pepega

* Sort out tiny terminal.h include inconsistencies

* Format

* -> `TE_`

* format

* `TE_` -> back to `VT_` (parkour!)

* explicit VT
2022-11-01 19:17:11 -04:00
Dragorn421 d2191a5d48
Some doc on env light settings (#1307)
* remove `LightSettings` struct, typedef for zapd

* more decimal

* fog far -> z far

* `LIGHTCTX_FOGNEAR_MAX`, `LIGHTCTX_ZFAR_MAX`

* name sp88,sp8C in `Environment_Update`

* `EnvLightSettings.fogNear` -> `blendRateAndFogNear` and macros

* A different struct for `EnvironmentContext.lightSettings`

* Uniform zapd compat typedefs todos

* `LIGHTCTX_` -> `ENV_`

* Comment on `blendRateAndFogNear` + "fogFar"

* Move fogFar~1000 comment to zFar

* comment rewrite attempt

* move relevant macros down

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-11-01 19:00:38 -04:00
Dragorn421 451e855dbc
Move object table from `z_scene.c` to new file `object_table.c` (#1416)
* Move object table from z_scene to new file z_scene_dlftbls ("inspired by z_actor_dlftbls.c")

* -> `object_table.c`
2022-10-29 17:25:28 -04:00
Dragorn421 7453709cc1
Doc speed_meter timers and misc. low-ish level stuff (#1364)
* Misc docs (somewhat lower level)

* Run formatter

* Simplify comment

* `a = a +` -> `a +=` with pad removal

Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>

* `isPreNMIStateRunning` -> `inPreNMIState`

* line breaks

Co-authored-by: Roman971 <32455037+Roman971@users.noreply.github.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
2022-10-29 16:44:27 -04:00
Dragorn421 c0a0688dc5
Remove `const` from `ActorInit` initvars declarations (#1417) 2022-10-24 19:29:38 -04:00
Dragorn421 ce2e5e71c8
Documentation pass on `DoorShutter` (#1352)
* Documentation pass on `DoorShutter`

* lockTimer -> unlockTimer

* Add `DOORSHUTTER_STYLE_FROM_SCENE`

* `DoorShutter_SetupType` -> `DoorShutter_WaitForObject`

* perpendicularly -> perpendicular

* `DoorShutter_CheckShouldDraw` -> `DoorShutter_ShouldDraw`

* Improve comment on `DoorShutter_GetPlayerSide`

* `jabuDoorClosed`/`barsClosed` +`Amount`

* attempt to improve a comment

* fix shameful left-aligned numbers

* unname closing/opening

* action funcs names

* run formatter

* enums improvements

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-10-24 15:58:33 -04:00
engineer124 e4c1a4b512
Document Crawlspaces (#1286)
* Crawlspace docs, first draft

* Add wall docs

* OnePointDemo, fix

* format

* More player docs

* Document bgCamData

* Magic docs WIP

* More docs, first round finished

* Better docs

* More renaming

* Simpler name

* Another small adjustment

* rm if(1)

* Better names again after in-game testing

* Change comments

* change comment

* Big rename based on all the suggestions

* Small touch-up

* More PR Suggestions

* RESTORE_IDLE -> RESET

* More docs

* Capitalization

* PR suggestions

* Make declaration consistent

* Health_ChangeBy (amount)

* cleanup

* Document bgCamData

* More changes and cleanup

* More docs

* Clarify comments

* PR Suggestions

* Missed one

* More PR Suggestions

* Change comment

* Add another clarity comment

* format

* PR Feedback, rename bgcheck functions

* remove fallthrough cleanup (other pr that deals with that)

* PR Suggestions

* bug report

* sync with bgCamData PR

* small cleanup

* Another comment

* bgCamDataIndexBeforeUnderwater

* PR/Discord Discussions

* Missed some

* sync function header args

* Another suggestion

* cleanup

* Comments

* Change bgCamData to s16 for now

* PR suggestions

* the

* use "info"

* Missed a suggestion

* Discord Discussion

* Document playerFlag

* typo

* Revert bgCamFuncData to Vec3s

* format

* format

* First PR suggestion

* Some PR Suggestions, still need to test

* followup docs

* small cleanup

* target offset

* more PR

* forwardYaw

* crawlspace func/flag

* comment

* format

* Update include/z64player.h

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

* More PR Suggestions

* Update src/overlays/actors/ovl_player_actor/z_player.c

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-10-23 17:32:51 -04:00
engineer124 a715bf63d0
improve matches (#1413) 2022-10-21 18:57:30 -04:00
fig02 26d6028ff1
Rename scene lists (#1344)
* first pass

* revert unwanted zap change

* review

* name Actor_InitContext, change arg name

* change bzero to use type
2022-10-16 18:00:18 -04:00
Dragorn421 bea53e1cc3
Some `OREG` docs (camera data regs) (#1405)
* very wip oreg docs

* more

* more

* more

* more useful comment
2022-10-16 12:33:52 -04:00
engineer124 e4664b4750
Misc Sequence Docs (#1400)
* misc bgm and fanfare docs

* more docs

* function.h cleanup

* fix horse

* typo

* add comment to song of storms cutscene in windmill

* PR review

* woopsie

* seqId macros

* revert macro
2022-10-16 12:12:36 -04:00
Dragorn421 17073af8a3
Enum comments on some arrays (#1404)
* Comment enums on some big arrays

* z_camera_data too

* comment in get item table on own lines

* `sDebugSaveInventory.ammo`

* More in z_sram

* `0xFF` -> `ITEM_NONE` in `sNewSaveInventory.items`
2022-10-15 20:02:54 -04:00
Dragorn421 0283493db8
Lightweight trigonometry doc (#1356)
* Doc units of trig functions

* "Very simple" yet I made a mistake

* sins returns in [-0x7FFF,0x7FFF] as the [-1,1] range

* Also `sys_math_atan.c`

* Remove `@param`s without descriptions

* Add note on Math_Atan2S/F arguments being unlike atan2

* "from (1,0) to (x,y)" -> "from vector ..."

* arg names -> `angle`

* Improve `@return` comment on atans
2022-10-15 17:29:36 -04:00
Tharo 0b38f6e678
`gbi.h` and `ucode_disas.c` cleanups (#1267)
* Merge GfxMod and Gfx, various ucode_disas improvements, gdSPDefMtx, gbi.h formatting improvements

* Suggested changes

* Further suggested changes

* Fix matrix

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

* Formatting changes

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

* Clarify Gnoop callback

* the thing

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

* Switch spaces, uintptr

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-10-15 17:14:35 -04:00
fig02 fd24ad6e67
Document elf_message scripting system (#1398)
* `cUpElfMsgs` -> `cUpMsgs`

Motivation:
ElfMessage is the name of the system that handles c-up messages from navi, but also messages from child/adult saria
so it would make sense to name this after the system name like "ElfMsg"
but "cUpElf" primarily reads like (to me) "c up navi" since the actor implementing navi is EnElf

I think it'd be better to clear that confusion between "navi" and "elfmsg system" by just not using "elf" in the name

* Standardize c-up navi messages ElfMessage data to be named after "CUp"

* -> "Navi"

* Make symbols in `elf_message_` segments static

* new docs

* change commands, format

* introduce navi file id

* use enum

* remove concat

* add clarifying comment for skip

* concat cmd type

* Hints -> QuestHint

* rename command header

* s -> g

* missed enum name

* singular

* missed one

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-10-15 13:24:13 -04:00
engineer124 d42307561a
Improve match for `DbCamera_CalcUpFromPitchYawRoll`, add docs (#1408)
* improve match

* found solution without void
2022-10-15 11:51:55 -04:00
engineer124 a2d62eedb2
Cleanup `VecSph`: Better Distinguish Between "Spherical" vs. "Geographic" Coordinates (#1407)
* begin geo and sph docs

* cleanup

* cleanup

* cleanup struct

* PR suggestions

* spacing
2022-10-15 15:43:59 +02:00
Lauri Koskela b806ac0191
Document Talon (En_Ta) (#1348)
* Rename flags related to Talon

* Document Talon (ovl_En_Ta)

* Formatting

* ovl_En_Ta review fixes

* Add horse eventinf flag usage comments

* Rename TALON_STATE_FLAG_3

* Review fixes

* More review fixes

* Fix super-cucco zero-gravity time comment

* Fix formatting

* Talon review comment fixes

* Review comment fixes

* Rename waking up action funcs
2022-10-15 06:28:05 -04:00
engineer124 9675051377
Quake Documentation Pass (#1402)
* begin quake docs

* continue cleanup

* quake offset

* many more docs

* cleanup

* more cleanup

* cleanup headers

* move quake value to internal

* update, still need to test shake zoom/yaw

* more docs

* better docs

* add file descriptions

* fix comment

* explain random index

* cleanup comments

* better type 6 docs

* expand orientation comment

* fix old names, add comment

* remove comment, twas a mistake

* easy PR feedback

* duration in dec

* rm offset, clear up roll

* oops

* merge shakeInfo and QuakeCamData

* match order that always appears in code

* more PR suggestions

* adjust comment

* zeroVec

* rm extra space

* roman PR suggestions
2022-10-15 02:16:37 -04:00
Dragorn421 d1d946a197
`GameInfo` -> `RegEditor` (#1354)
* -> `RegsContext* gRegsContext`

* Name regs-related functions

* Revert naming `GameState_UpdateRegs`

* -> `gRegEditor`

* `Regs_InitContext` -> `Regs_Init`

* remove mistakenly added file
2022-10-15 01:40:00 -04:00
Dragorn421 22b78f169f
Fix misc 17 (#1392)
* Some cleanup on bgcheck waterbox y funcs

* Fix some typo/spelling

* EnFz_ApplyDamage match fixup

* Turn another sus construction into a switch

* Fixup comment on restoring MS as adult

* "doesnt, isnt" -> "doesn't, isn't"

* Hunt down whitespace at end of lines

* Format (clang-format does not like figs bug comment on bongo cutscene unskip sadge)

* Viewport z scale/translation: `0x1FF` -> `G_MAXZ/2` (see proman "9.7 Mixing CPU and SP Addresses", "12.7.6 Depth Source")

* static symbols: g -> s prefix

* Link young/old -> child/adult

* Fixups

* Get rid of signed vs unsigned comparison warning by changing room temps to s32

* waterbox search funcs consistency

* Revert "waterbox search funcs consistency"

This reverts commit 8f386e038f.

* `curWaterBox` -> `waterBox`
2022-10-13 04:06:49 -04:00
Tom Overton a6276fb5c1
Document object_bdoor (boss doors) (#1403) 2022-10-12 13:12:26 -04:00
Dragorn421 40a4abefa5
Doc dynapoly move flags (#1372)
* Doc dynapoly move flags

* Use `DYNAPOLYMOVE_UPD_` more

* remove `DynaPolyActor.unk_15A` (padding)

* `DYNAPOLYMOVE_UPD_` -> `DYNA_MOVE_`

* Remove `DYNA_MOVE_POS_AND_ROT_Y`

* Actual docs

* Update function names

* transformFlags and Carried names

Co-authored-by: fig02 <fig02srl@gmail.com>
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

* Fixup comment on `DynaPolyActor_UpdateCarriedActorPos`

* Format

* `DYNA_TRANSFORM_NONE` -> 0

* Touch up mentioning the `DYNA_TRANSFORM_` flags in docs

Co-authored-by: fig02 <fig02srl@gmail.com>
Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-10-12 00:47:33 +02:00
engineer124 3ee2190b8d
Document Malon's Singing (#1395)
* malon singing docs

* typo

* more cleanup

* more cleanup

* cleanup comments

* PR Suggestions

* add more comments for clarity

* grammar
2022-10-10 06:52:33 +02:00
engineer124 76803f1534
Document Scene Sequences and Remaining SeqFlags (#1308)
* Begin scene sequence docs

* Better docs

* cleanup

* Better Docs

* cleanup

* Move flag

* Off -> None

* Fix comment

* spacing

* address pr, spot -> resumePoint

* SEQ_IO_VAL_NONE

* missed one
2022-10-09 21:57:50 -04:00
Dragorn421 b6d9a8183b
`PlayerActionParam` -> `PlayerItemAction` (#1394)
* `PLAYER_AP_` -> `PLAYER_IA_`

* Change temps, args, comments, members to "item action"

* Format
2022-10-09 15:59:57 +02:00
engineer124 2fb27e6605
rename audio context (#1388) 2022-10-07 13:43:17 -04:00
engineer124 062f4d8e15
Document code_800F9280.c -> audio_seqcmd.c i.e. (Audio_QueueSeqCmd) (#1234)
* Document SoundSources

* PR Suggestions

* Duration timers to dec

* `PlaySfxByPosAndId` -> `PlaySoundByPosition`

* Begin importing docs from MM

* Finish cleanup using code from MM

* Start documenting commands

* First attempt at thorough AudioSeqCmd wrappers

* Improve names

* Merge branch 'master' into audio_seqCmd

fix name to minimize conflicts

* Combine macros, implement them through repo

* Improve docs

* More progress, begin sequence command docs

* seqcmd.h

* More documentation of seqcmd.h

* More docs

* cleanup

* More cleanup

* More docs

* VOL_SCALE_INDEX enum

* missed enums

* More Cleanup

* docs

* More docs

* Add comments about sfxChannelLayout

* More cleanup

* Even better docs

* Add a file description

* small touchups

* More cleanup of comments

* more

* More cleanup

* More cleanup

* Missing space

* typos

* Audio_SetVolumeScaleNow

* More cleanup

* Fill in enum

* one more cleanup

* Capitalize macros

* remove AUDIO_

* cleanup

* more cleanup

* Small Fix

* Add a lot of backticks for docs

* Restructuring docs

* More cleanup

* swap channel args, cleanup

* Typos

* Many suggestions, revert filename

* pr suggestions

* even more PR

* more pr suggestions

* pr suggestion
2022-10-07 13:29:33 +02:00
Dragorn421 9771afdc69
Some pause menu inputs doc (#1370)
* `PauseContext.pageSwitchTimer` -> `delaySwitchPageInputTimer`

* Document stick input repeat in the pause menu

* format

* `delaySwitchPageInputTimer` -> `pageSwitchInputTimer`

* Fix swapped delay and delay_first, oops

* Move timer incrs on their own lines

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
2022-10-04 13:13:40 -04:00
Roman971 1cb00350d9
Skip compiling C-included files during the build (#1386)
* Update the makefile to skip .inc.c files when building

* Rename all C-included source files to .inc.c
2022-10-04 12:36:25 +02:00
Roman971 2f4c25da53
Fix many missing NULLs (#1389)
* Fix many missing NULLs

* Fix a raw actor id in en_horse
2022-10-04 01:18:50 -04:00
Roman971 78e528d6fb
Various minor fixes (#1383)
* Swap REGION_US and REGION_JP

* Fix a few missing EXCH_ITEM enum values

* Remove unnecessary casts on alloc functions

* Fix a double slash in the spec file

* Swap top and bottom args in StackCheck_Init

* Remove some unnecessary & in array references

* Run formatter

* Fix the comments for US and JP codes
2022-10-02 17:40:09 -04:00
Roman971 f5a7c5612b
Use intptr types in more code files (#1385)
* Use intptr types for segments and a few system files

* Use intptr types for more dma rom addresses

* Use intptr types in data referring to rom files

* Update and cleanup a few message casts

* Change sys_cfb functions and debugHeapStart to use pointers

* Update graph.c for the sys_cfb return type change
2022-10-02 11:38:09 -04:00
Tharo 4f65d08eb5
Rumble doc (#1375)
* Rumble doc

* Fixes, suggested changes

* Improve padmgr retrace callback related code

* Name some rumble-adjacent things, further suggested changes

* Further suggested changes

* Suggested changes
2022-09-27 12:40:26 -04:00
Tom Overton 82e04ede5f
Replace player animation names with original names derived from OoT3D (#1369)
* Name every player animation after the original name from OoT3D

* Also update link_animetion with original names
2022-09-12 20:43:06 +02:00
Tharo 6b77ddba5a
More documentation for padmgr.c (#1336)
* More documentation for padmgr.c

* Update comments

* Further suggested changes

* Suggested changes

* LOG_SEVERITY_INFO -> LOG_SEVERITY_CRITICAL

* Adjust PadMgr_RequestPadData comment

* Avoid array notation for args, adjust comment, rename the FaultMgr padInput field to inputs to better reflect it's an array
2022-09-03 02:52:13 +02:00
Dragorn421 c0cf83a814
Doc room drawing (#1283)
* (wip) some doc on room draw2

* doc room_draw2

* do what can be done for `func_80095AA0`

* wip

* more cleanup around Room_DrawBackground2D

* format"

* commit to naming things

* move forward declarations of draw handlers to draw handlers array

* two z_room regs

* `R_MESH2_` -> `R_ROOM_CULL_`

* offset -> quakeOffset

* kb -> kB

* Improve cull mesh type doc

* `Sphere16` MeshHeaderCullEntry.bounds

* Revert "`Sphere16` MeshHeaderCullEntry.bounds" (ZAPD...)

This reverts commit cbe55e8090.

* Mesh header type: "cull" -> "cullable"

* Reword some Cullable doc

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>

* `boundsSphere*` for now for the can't-be-`Sphere16 bounds`

* Improve the PrerenderMulti bgCamInfo usage situation

* Comment on `overrideBgCamIndex`

* "are left" -> "remain"

* enum and defines for room draw debug regs

* drawBg -> drawBackground

* "mesh header all" -> "mesh header normal" 🤷

* array_count back to define

* Name some temps a lot less specifically

* "mesh header" -> "room shape"

* "Room shape prerender" -> "Room shape image"

* `ROOM_SHAPE_IMAGE_FORMAT_` -> `ROOM_SHAPE_IMAGE_AMOUNT_`

* `RoomShapeImageMultiBackgroundEntry` -> `RoomShapeImageMultiBgEntry`

* Remove references to "header" (old "mesh header" name)

* Axe variable names

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-08-31 19:28:51 -04:00
Dragorn421 2e18eb334b
Fix misc 16 (#1371)
* Replace tabs in exceptasm.s source

* Replace tabs with \t in strings

* Fix grammar in various comments

* Fix "initalize" typos in code

* (fix typo) `__osMallocIsInitalized` -> `__osMallocIsInitialized`

* Some Link -> Player

* Use `EXCH_ITEM_` more

* "bgm music" -> "background music"

* Fix typos in `place_title_cards.xml`

* `SkelAnime_Update` returns a boolean

* Run formatter
2022-08-30 17:35:00 -04:00
Dragorn421 881fe0ad0a
`OREG` cleanup & Doc `Camera_GetPitchAdjFromFloorHeightDiffs` (#1355)
* Doc `func_80044ADC` (draft)

* Replace `OREG` accesses with existing macros

* Small `Camera_GetPitchAdjFromFloorHeightDiffs` cleanup

* Simplify names with near/far

* Name regs used in `Camera_GetPitchAdjFromFloorHeightDiffs`

* Parentheses/misc cleanup

* update OREG names, except `R_CAM_YOFFSET_NORM` which looks too sketchy for this PR's scope
2022-08-30 17:20:23 -04:00
Dragorn421 1ab4e6ee5f
`stickRel` -> `stickAdj` (#1367)
* kaleido and filselect

* ocarina and KaleidoScope_UpdatePrompt
2022-08-30 14:55:37 -04:00
mzxrules 327a813b37
Fix RaycastFloor flags (#1328)
* fix raycast floor flags

* format.sh

* Name flags

* Rename RaycastFloor functions, clean up caller code, document z_bg_spot15_rrbox

* change comment to prevent format wrap

* change to "if BGCHECK_GROUND_CHECK_ON is set"

* roman suggestions
2022-08-30 17:49:51 +02:00
engineer124 0b531fd1ee
Improve match for `Camera_CalcUpFromPitchYawRoll`, add docs (#1361)
* doc Camera_CalcUpFromPitchYawRoll

* reword comments
2022-08-29 14:26:10 -04:00
Dragorn421 7cfee3d8a9
Doc pass on bgcheck-waterbox properties (#1288)
* Doc pass on bgcheck-waterbox properties

* `WATERBOX_ROOM_INDEX...` -> `WATERBOX_ROOM...`

* Fix `WATERBOX_PROPERTIES` macro (was completely wrong)

* `((setFlag19) & 1) << WATERBOX_FLAG_19_SHIFT` instead of ternary

* Fix `WATERBOX_PROPERTIES` macro (hopefully for good)
2022-08-29 13:52:42 -04:00
Tharo 0d52a4aebd
More documentation for PreRender.c (#1340)
* More documentation for PreRender.c

* Comment fix

* Suggested changes

* More on coverage reading functions

* Further comment changes

* Further suggestions
2022-08-28 12:18:20 -04:00
engineer124 e25bb1485a
Document the Haas Effect (#1302)
* Document Haas Effect

* More docs

* cleanup

* add comments

* Adjust comment

* More cleanup

* Fix

* Add description of the Haas Effect

* roman suggestion
2022-08-28 17:33:38 +02:00
engineer124 9e2aee3fa3
Minor Misc Cleanup (#1360)
* misc cleanup

* missed one

* EffectSsDust_UpdateFire

* revert change, needs more testing
2022-08-23 21:13:03 -04:00
fig02 fec5cd84af
Doc shrink_window, rename system to Letterbox (#1341)
* docs

* missed some hex

* document Gfx_SetupFrame

* review
2022-08-15 09:39:06 -04:00
EllipticEllipsis dda78f9e2c
Convert Blure to use array colours (#1347) 2022-08-13 09:57:58 -04:00
Derek Hensley 9c6461751d
sceneNum -> sceneId (#1338)
* sceneNum -> sceneId

* forgot to save play

* scene -> sceneId where appropriate

* Missed 1 + format

* Update src/code/z_sram.c

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

* Update src/code/z_sram.c

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

* PR

* Fix

Co-authored-by: mzxrules <mzxrules@gmail.com>
2022-07-31 19:44:47 -04:00
Dragorn421 706d5596bf
Doc, macros, enums for `SurfaceType.data` (#1293)
* `SURFACETYPE`0/1 getter macros

* Cleanup/assess/revert existing names

* `SURFACETYPE0_30` -> "soft"

* `SURFACETYPE0_`13/26 -> floortype/floorproperty

* Introduce `SURFACETYPE_FLOORTYPE_` enum

* Introduce `SURFACETYPE_FLOORPROPERTY_` enum

* `SURFACETYPE0_21` -> "wall type", and maps to "wall flags"

* Introduce `SURFACETYPE_WALLTYPE_` enum

* Introduce `SURFACETYPE_WALLFLAG_` defines

* `SURFACETYPE1_0` -> "sfx type"

* `SurfaceType_GetSfx` -> `GetSfxId` and cleanup

* Introduce `SURFACETYPE_SFXTYPE_` enum

* Note oddity on `Player.unk_89E` (more docs needed)

* `SURFACETYPE1_4` -> "floor effect" (not 100% set on the name, just something different from type and property)

* Introduce `SURFACETYPE_FLOOREFFECT_` enum

* Introduce `SURFACETYPE_CONVEYORSPEED_` enum

* Add `SURFACETYPE_CONVEYORDIRECTION_TO_BINANG` macro

* `wallDamage` -> `hasFlag27`

* Be more underscore-happy

* Revert "`SURFACETYPE`0/1 getter macros"

This reverts commit e61cccf2e6.

* remove mention to removed define

* Remove surfacetype_ prefix, `SFX_TYPE_` -> `SURFACE_SFX_TYPE_`, `FLOOREFFECT_` -> `FLOOR_EFFECT_`

* Formatting

* 0-pad litteral to 8 nibbles
2022-07-31 20:57:18 +02:00
Dragorn421 6889c275cb
Doc pass on EnDoor and transition actors (#1243)
* Doc pass on EnDoor and transition actors

* (re)Name things

* Forgot to change gameplay_keep.xml

* "actor transition index" -> "transition actor index"

* Run formatter

* Better names for `DOOR_DL_` enum

* `TRANSITION_ACTOR_INDEX` -> `GET_TRANSITION_ACTOR_INDEX`

* name endoor params macros with get/is, _mask to _flag for the doubledoor flag

* Move last ; from `DOOR_ACTOR_BASE` expansion to usage
2022-07-30 20:57:44 -04:00
Tharo 455321d2e8
Fix various small gfx issues (#1313)
* Fix various small gfx issues

* Use 0xFFFF instead of -1 for max prim depth

* More fixed point numbers

* scale -> texCoordScale, better cycle 2 render mode in z_title

* GFXP_CHAR_* defines renamed to SPACING

* Fix some gDPLoadMultiBlock uses
2022-07-30 17:49:10 -04:00
fig02 afbc312024
Rename "Scene Setup Index" to "Scene Layer" (#1300)
* setup -> layer

* IS_CUTSCENE_LAYER

* review

* backtick

* remove some more mentions of setup

* alt header block

* clarifying comment
2022-07-30 17:28:50 -04:00
Dragorn421 2f5eac6b76
Move fault_drawer bss to data/ asm because -g3 bss is fun (#1335) 2022-07-30 10:09:42 -04:00
engineer124 1d19f37b26
Rename "Sound" to "Sfx" (#1292)
* First attempt

* More

* rename

* more sound -> sfx / sound effect (#7)

* PR Suggestions

* PR Suggestions

* Small fix

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
2022-07-30 09:05:27 -04:00
Roman971 1652b7e5d7
Fix audio strings with -use_readwrite_const and -signed (#1324)
* Fix audio strings with -use_readwrite_const and -signed

* Add comments for audio flags in makefile
2022-07-29 20:35:09 -04:00
engineer124 423fec9f79
Clean up audio sample counts: bytes, samples, frames (#1289)
* Clean up bytes, samples, frames

* Improve macro usage

* More missed macros

* rename macro now that it crosses files

* redefine macros in terms of frames

* Another use of macro

* Fix, it's number of samples, not size

* Partial PR Suggestions

* Small change

* size to length

* Correct/Clarify comments

* remove comment

* More PR suggestions, cleanup

* Bad formatting, fixed
2022-07-27 17:53:56 -04:00
mzxrules ffcbc0de79
Fix TEXTBOX_POS issue (#1329) 2022-07-27 16:24:58 -04:00
Dragorn421 9647f50451
Cleanup z_debug (reg editor) (#1290)
* Cleanup z_debug

* misc

* pad reg names column to """allow""" 40 characters because why not

* safety parentheses in regs.h

* More safety parentheses, in named regs defines

* sort named regs in order, except for message system regs (?)

* put all regs in order (message system ones too)
2022-07-14 19:02:07 -04:00
engineer124 79cb1f8d5c
Misc Cleanup/Docs (#1315)
* Misc Cleanup

* More cleanup
2022-07-14 16:26:10 -04:00