Commit Graph

196 Commits

Author SHA1 Message Date
cadmic bccb219ea3
Fix typos found by codespell (#2229) 2024-09-26 00:21:00 -04:00
Dragorn421 7ccb0a641e
[headers] Create letterbox.h, move more protos from functions.h (#2225)
* [headers] Create z64shrink_window.h, move more protos from functions.h

* format

* include

* bss

* letterbox.h
2024-09-25 13:45:06 -04:00
Dragorn421 5ed5f196d9
[headers] audio functions to z64audio.h and z64ocarina.h (#2223)
* [headers] audio functions to z64audio.h and z64ocarina.h

* bss
2024-09-25 10:25:49 +02:00
Dragorn421 a09ea76025
[headers] gfx_setupdl.h and z64skin_matrix.h (#2221)
* [headers] gfx_setupdl.h and z64skin_matrix.h

* include z64skin_matrix.h

* bss

* bss
2024-09-24 18:18:01 -04:00
mzxrules dc1501e7a0
create ucode_disas.h (#2222)
* ucode_disas.h

* create UcodeType

* bss
2024-09-24 13:45:53 -04:00
mzxrules 56981d5297
Document Player Knockback related functions (#1601)
* document knockback related functions

* rotation -> yRot

* implement some changes

* Renames and comments

* mq bss

* format

* Intangibility and Invulnerability

* bss

* .bss

* add #pragma increment_block_number to z_en_item00.c

* .bss
2024-09-23 18:31:00 -04:00
Dragorn421 0f725405d1
[headers] Move z_actor functions to z64actor.h (#2216)
* move

* format

* bss
2024-09-23 11:06:43 -04:00
fig02 fcd5745d40
PLAYER_STATE1_ACTOR_CARRY -> PLAYER_STATE1_CARRYING_ACTOR (#2213) 2024-09-21 18:25:19 -04:00
Dragorn421 a1a192b1a2
[headers] z64inventory.h, move savectx/inventory macros to z64save.h (#2209)
* [headers] z64inventory.h

* move savectx/inventory macros to z64save.h

* commit the file

* bss
2024-09-18 15:40:59 -04:00
fig02 8f0e2fc29c
Name `PLAYER_STATE1_CHARGING_SPIN_ATTACK` (#2203)
* name charge state flag

* format
2024-09-16 17:14:29 -04:00
cadmic f089adf20c
[ntsc-1.2] Match ntsc-1.2 BSS and add to CI (#2187)
* Match ntsc-1.2

* Add ntsc-1.2 to CI

* Apply fixes from Jenkins

* Promote ntsc-1.2 to "supported" in Makefile

* Declare D_80858AD8 as a u64 array

* Tweak wording

* Hopefully make ntsc-1.2 bss more stable

* Restore segmented_address.h include
2024-09-12 14:10:43 -04:00
fig02 900c2f0f68
Name `PLAYER_STATE1_ACTOR_CARRY` (#2173)
* actor carry flag

* format and add comments

* comment changes
2024-09-08 17:43:27 -04:00
Dragorn421 3a9ebfbbad
Pause doc: World map points (#2141)
* Pause doc: World map points

* bss

* `WORLD_MAP_POINT_HYLIA_LAKESIDE` -> `_LAKE_HYLIA`
2024-09-07 17:14:08 +09:00
cadmic 2ce648a7c6
Miscellaneous libultra header fixes (#2139)
* Miscellaneous libultra header fixes

* Fix bss?

* Reword RCP timeout
2024-09-06 14:46:44 +02:00
cadmic 7a9209c885
[ntsc-1.2] Match z_camera.c (#2112)
* Add CAMERA_CHECK_BTN

* Match Camera_Demo3
2024-09-03 23:00:37 -04:00
Dragorn421 b1b8b8c426
T() macro 3 (#2083)
* T() in z_camera.c

* T() in z_parameter.c

* T() in z_room.c

* T() in z_kaleido_scope_call.c

* T() in z_map_exp.c
2024-08-24 17:47:45 +02: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 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
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 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
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
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
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 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
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
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 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 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
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
fig02 2cb4ff4fd3
Player Docs: csMode -> csAction (#1547)
* csmode -> cs action

* format
2023-09-26 12:48:41 -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
engineer124 b8aa2a251e
Document z_lib Sfx Functions (#1470)
* document lib sfx

* rename functions
2023-08-15 01:44:20 -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
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
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
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
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
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
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
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
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
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 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
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 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
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
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
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 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
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
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
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
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
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
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 2f07874a5f
Remove `BINANG_SUB` (#1297) 2022-07-12 12:17:07 -04:00
Dragorn421 397e481f9a
Fix misc 15 (#1298)
* Use `SCENE_` enum more

* Decimal for pos in `D_8011F9B8`

* `__osEventStateTab`: length `OS_NUM_EVENTS + 1` -> `OS_NUM_EVENTS`

* thone -> throne

* `s` on local data

* minor sfxId cleanup

* Run formatter

* Fixup 0x19 + 1 = 0x1A, not 0x20 lol

* Tlut -> TLUT

* DemoKankyo params usage cleanup

* Some proofreading (up to z_actor.c)

* Revert 0 -> sfxId, add todo comment (sfxId=0 is weird apparently)

* `sZdWaterBox` -> `sZorasDomainWaterBox`

* `msgMode == MSGMODE_`, not `GAMEMODE_` (my bad Sadge)
2022-06-24 19:45:05 -04:00
Dragorn421 984871eb38
Document `SaveContext.gameMode` (#1295)
* Document `SaveContext.gameMode`

* end credits

* Remove no longer needed comment
2022-06-23 21:32:48 -04:00
Dragorn421 81ab6fe831
Remove `BINANG_ROT180` (#1241) 2022-06-22 16:10:01 -04:00
engineer124 849fdbf9ea
Document Camera BgCamData (#1232)
* Document bgCamData

* More changes and cleanup

* More docs

* Clarify comments

* PR Feedback, rename bgcheck functions

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

* PR Suggestions

* bug report

* 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

* Revert bgCamFuncData to Vec3s

* format
2022-06-17 20:25:42 +02:00
Roman971 08c8126ba5
Enable int-conversion warnings and fix all current instances (#1280)
* Enable int-conversion warnings for gcc/clang

* Fix all current int-conversion warnings

* Run format.sh

* Apply review suggestions
2022-06-15 20:15:44 -04:00
Roman971 feadb0d9ee
Enable more IDO warnings and apply fixes (#1264)
* Update asm-processor and fix includes with EARLY

* Enable more IDO warnings and disable unwanted warning 516

* Fix most new and remaining warnings

* Improve skelanime comment

* Improve asmproc pragma comment

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

* Add suggested comment for a wrong prototype

* Update asm-processor with the latest fix

Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-06-12 19:24:45 -04:00
Dragorn421 73ba138f54
Doc pass on scene & room headers (#1240)
* Doc pass on scene & room headers

* Remove comments on room draw handlers

* `struct ActorEntry` -> `ActorEntry`
2022-06-09 15:02:18 -04:00
Tharo 451b24f79b
Fix a number of warnings when compiling with GCC (#1239)
* Silence a number of GCC warnings

* Remove

* Suggested changes

* Format

* Fix comment in en_go2
2022-06-03 18:51:23 +02:00
fig02 2e6279bc8e
PlayState Rename (#1231)
* global context -> play

* fix PlayState* PlayState
2022-05-21 14:23:43 -04:00
Dragorn421 154f44b6da
Documentation pass on scene/room commands (#1226)
* Rename handler functions

* Rename cmd_id enum names for consistency

* `char` -> `s8` for explicit padding in cmd structs

* `Room.unk03/03` -> `behaviorType2/1`

* `UNK_PTR` -> `void*`

* `showInvisActors` -> `lensActorsMode` + enum

* Add `ROOM_BEHAVIOR_TYPE1/2_` enums

* "mesh" -> "mesh header"

* `Polygon polygon` -> `PolygonBase base` (for now...)

* Misc cleanup

* "lens actors mode" -> "lens actor mode"

* Revert "`char` -> `s8` for explicit padding in cmd structs"

This reverts commit 59b9295828.

* `LENS_ACTOR_MODE_` -> `LENS_MODE_HIDE/SHOW_ACTORS`
2022-05-21 08:54:51 -04:00
fig02 aadb5f9c47
Gameplay_ -> Play_ and this (#1229) 2022-05-18 00:41:50 +02:00
engineer124 bf56c94f0f
Document Sub-Cameras (#989)
* Copying SubCam Changes from PR 908, made it to the end of bosses

* Finish copying over PR

* format

* More cleanup

* clean-up

* PR Suggestions, Clean-Up, Improvement in CS

* Remove substructs from fd/fd2

* format

* Improve fishing

* minor fix

* Make CutsceneCameraDir more general

* `sActiveCamMove` -> `sCamMove`

* Fix conflict with object kankyo

* Add CAM_ID_MAIN to object_kankyo

* Improve cam cutscenes further

* Revert cutscene cmd names (better for a separate PR)

* At -> LookAt in the context of Cutscenes

* Missed naming in diving game

* Format

* Fill in Ganon2 Names (now that it's matching)

* format

* `sActiveCamId` -> `sReturnToCamId`

* activeCamId -> returnToCamId

* Discord Discussions

* FIRST

* Move macro to bottom, comments

* More suggestions

* PR suggestion, cleanup comment

* Oops

* add comments

* Adjust comment

* Change edge-case

* whoops

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-05-12 20:35:31 +02:00
Roman971 92aef346f2
Remove many redundant parentheses (eg. in boolean conditions) (#1220)
* Remove many unnecessary parens around boolean conditions

* Remove duplicate parens in some expressions

* Apply review suggestions

* Update src/overlays/actors/ovl_Bg_Jya_Lift/z_bg_jya_lift.c

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

Co-authored-by: EllipticEllipsis <elliptic.ellipsis@gmail.com>
2022-05-12 09:04:37 -04:00
engineer124 7da841fcc9
Restructuring Camera Structs and Related Macros (#1108)
* Proof-of-concept

* small cleanup

* static to fixed

* Update to new names

* Use full names for structs

* Update comments

* PR 1

* More macro changes

* More PR Suggestions

* Use a union for funcData

* Apply change to all cam structs

* typedef union outside of cam struct

* Add size

* typedef union, not struct

* funcData -> paramData

* Better manage doorParams
2022-05-08 23:35:54 +02:00
Dragorn421 ca77b26c90
Fix misc 11 (#1209)
* Pass boolean for `freezeFlag` to `Actor_SetDropFlag`

* Use `else if`s in `func_80835F44`

* Cleanup `transitionCtx` usage of instance data

* `TransitionContext.setEnvColor` -> `TransitionContext.setUnkColor`

* Fixup one comment

* linebreaks (#1)

* Run formatter

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-05-04 21:25:26 +02:00
EllipticEllipsis e84f5ab387
Memstuff (#1164)
* Un-fake a couple of matches in memory manip functions

* Document fmodf

* Un-fake a couple of matches in memory manip functions

* Document fmodf

* Rename functions and files

* Document memmove, memsets, memcpys

* Format

* Sort out some missing sizeofs

* Name fmodf

* Rename local variables

* size_t

* Use COBRA_SHADOW_TEX_SIZE

* Review

* Tweak the Doxyfile to remove @brief requirement

* Roman's review

* Fix a bug comment

* Change fmodf
2022-05-02 00:06:35 +02:00
fig02 16790bc253
Document Transition System (#1131)
* transition type enum

* mode enum, start documenting some types

* some more

* use enums for entrance table

* entrance table filled out

* sceneLoadFlag -> transitionTrigger

* sandstorm state/mode/type

* done i think

* fixes

* clean up circle weirdness

* circle use enum + fix texture names

* fix

* how did that even happen lol

* jesus

* review2

* some more review

* most review, still some more to do

* new transition trigger names

* some of review

* next type default
2022-04-27 16:00:25 -04:00
Dragorn421 fed9ac3e20
Angle cleanup - macros names (#1193)
* Move binang utility macros out of angle conversion macros block

* `BINANG_TO_DEGF` -> `BINANG_TO_DEG_ALT` (it may even be warranted to name it _approx instead of _alt, unsure)

* Add `BINANG_TO_DEG` (unused by oot) (for completeness)

* `DEGF_TO_BINANG` -> `DEG_TO_BINANG_ALT` (again may even be _approx, or maybe _cam)

* Add `DEG_TO_BINANG` (unused by oot) (for completeness)

* `RADF_TO_BINANG` -> `RAD_TO_BINANG`

* `RADF_TO_DEGF` -> `RAD_TO_DEG`

* Cleanup argument names in angle conversion macros

* Format for angle macros changes

* Run formatter

* Move `DEG_TO_BINANG_ALT`, `BINANG_TO_DEG_ALT` to z64camera.h

* Remove `DEG_TO_BINANG`, `BINANG_TO_DEG`

* Remove `_ALT` from `DEG_TO_BINANG`, `BINANG_TO_DEG`

* Add comment about inaccuracy near `DEG_TO_BINANG`, `BINANG_TO_DEG`

* run formatter

* `CAM_` prefix on `DEG_TO_BINANG`, `BINANG_TO_DEG` macros

* Revert "Remove `DEG_TO_BINANG`, `BINANG_TO_DEG`"

This reverts commit 5321647e5b.
2022-04-24 10:23:49 -04:00
Robin Allen 9984c267d9
Names for some view things (#1191)
* Names for some view things

* Review: ORTHOGRAPHIC → ORTHO

* Review: dirty → dirtyFlags

* Review: Doc comment style

* Review: Define constants in terms of each other

* Review: Rename the ApplyToOverlay functions

* Update include/z64.h

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

* Review: Better View_LookAtInternal doc

* arg1 → mask

* View_LookAtInternal → View_LookAtUnsafe

* Review: View_SanityCheckEyePosition → View_ErrorCheckEyePosition

* sViewNotInitialized → sLogOnNextViewInit

* Remove VIEW_FORCE_ALL

* near/far → zNear/zFar

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

* lookAt → at

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

* near/far → zNear/zFar

* View_ApplyPerspective/Ortho: Remove from header instead of commenting

* lookAt → at

* Add fwd decls

* Fix external view->at accesses

* Missed these somehow

* lookAt → at

* Omit "Apply" in comments

* dirtyFlags → flags

* View_ApplyScissor → View_ApplyShrinkWindow

* Update src/code/z_view.c

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

Co-authored-by: fig02 <fig02srl@gmail.com>
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-04-09 00:50:28 +02:00
Dragorn421 4729ac131a
Angle cleanup - `DEG_TO_RAD` (#1157)
* Run formatter

* Touch up angle macros (parentheses and hex constants)

* Remove `DEGF_TO_RADF`, use `DEG_TO_RAD` instead

* Remove `DEGTORAD`, use `DEG_TO_RAD` instead

* Use `DEG_TO_RAD` more
2022-03-20 19:33:29 -04:00
Dragorn421 61b864a89c
Angle cleanup - `RADF_TO_BINANG` (#1155)
* Run formatter

* Touch up angle macros (parentheses and hex constants)

* Use `RADF_TO_BINANG` more
2022-03-13 14:46:46 -04:00
Dragorn421 5cadc5df8a
Document/fix `Player.bodyPartsPos` usage (#1141)
* Document/fix `Player#bodyPartsPos` usage

* `distFromLinksHead` -> `distFromPlayerHat`

* Comment on `bodyPartsPos[-1]`

* Run formatter

* Use `PLAYER_BODYPART_MAX` more

* Use hex for `PlayerBodyPart` enum comments
2022-03-08 19:50:27 -05:00
Dragorn421 ed6ec5bceb
Doc misc 1 (#1160)
* Misc documentation 1

* Add parentheses

Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>

* Move the parentheses to the right place

* `curByte`(2) -> `curChar`(2)

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

* Revert `isMaterialSet` boolean usage

* Fix misplaced line (how did that happen)

* Fixup

Co-authored-by: EllipticEllipsis <73679967+EllipticEllipsis@users.noreply.github.com>
Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
2022-02-27 16:32:05 -05:00
Dragorn421 145b14dbc4
sword -> meleeWeapon (#1147) 2022-02-20 18:45:12 -05:00
engineer124 85ce3d3ca4
Document Distortions from z_camera and z_view (#1102)
* Document Distortions

* cleanup

* cleanup hot-room comment

* small swap

* PR Review 1

* Missed a small thing

* Add fishing case

* PR Feedback

* dirRot -> orientation

* `UpdateWater` and `UpdateHotRoom`
2022-02-20 18:35:53 -05:00
Dragorn421 e51fd73704
Fix misc 7 (#1149)
* Fixup `Math3D_LineClosestToPoint`

* `gDodongosCavernBossLavaFloorTex` is 32x64

* Name empty-dlist-making functions `_EmptyDList`

* Fix typos

* transitionRate -> morphFrames

* Compare `xyzDistToPlayerSq` to squared values

* Fix hookshot target/post collision header names being swapped

* Fix description of `z_bg_mizu_movebg.c`

* Add scene command comment to `func_80098508` to match other scene command handlers

* Some fixup in `Camera_Demo5`

* `1` -> `ALLOCTYPE_ABSOLUTE` in comment on `ActorContext.absoluteSpace`
2022-02-20 08:31:31 -05:00
Dragorn421 a9526a3354
Fix misc 6 (#1148)
* Fix typo `vertexs` -> `vertices`

* Fix typo `limbMatricies` -> `limbMatrices`

* Fix some `gSPTextureRectangle` usage of fixed point constants

* Run formatter

* `ALIGN8` macro

* `object_skj` cleanup

* sholder -> shoulder

* cleanup `stdbool.h`

* Some function prototypes cleanup

* Use macros in `osVirtualToPhysical`
2022-02-20 14:22:29 +01:00
Dragorn421 6479913daa
Defines for player state flags (#1081)
* script-assisted player state flags

* Run formatter

* manually convert state flags in `D_80116068`

* `PLAYER_STATE_FLAG_` -> `PLAYER_STATE`

* Run formatter
2022-01-17 19:04:07 -05:00
engineer124 67f6b50de3
Document Parts of Camera Data (#1054)
* Add Data enum and fill ARRAY_COUNT

* Clean-Up

* Document camera settings

* Document scenes further

* Minor edit

* Cleanup

* More cleanup

* Oof, that was tedious

* Align function look-up tables

* Remove comments

* format

* Cleanup

* formatter gone wrong, hid comments from me

* format

* Dragorn PR Review 1

* Change approach to camera data using macros

* Clean up function and data map

* Cleanup Comments
2022-01-10 20:51:57 -05:00
Dragorn421 a9284494f2
Use defines for actor flags (#873)
* Add ACTOR_FLAG_ defines

* Add ACTOR_FLAGS_ALL macro and use ACTOR_FLAG_* constants everywhere

* Remove unused ACTOR_FLAG_* constants

* actor flags in bigokuta & ko

* actor flags in obj_mure

* actor flags in stalfos, twinrova & ganon2

* actor flags in morpha & barinade

* name some previously missed actor flags

* found some comments using hex for actor flags

* Actor flags in ovl_En_Ganon_Mant

* Actor flags in EnWf

* Flags in en_zf

* Actor flags in BossGanon (FeelsOKMan)

* Remove `ACTOR_FLAG_NONE`

* Wrap expansion of `FLAGS` in parentheses

* `ACTOR_FLAGS_ALL` -> `CHECK_FLAG_ALL`

* Move `CHECK_FLAG_ALL` to `macros.h`

* Run formatter
2021-12-05 19:11:38 -05:00
Dragorn421 669732abbe
Misc Cleanup 2 (#1007)
* Cleanup `UNK_TYPE`, `UNK_PTR` usage

* Add some missing empty lines after declarations

* Remove some legacy comments from non-matching times

* Fix some grammar (mostly "it's"/"its")

* Use proper names for two symbols after ZAPD bugfix

* Cleanup `place_title_cards.xml`

* Use `NULL` to check against `D_8012D260` pointer

* Parentheses around some macro arguments

* wip proofread headers up to z64animation.h
2021-11-30 18:40:42 -05:00