1
0
Fork 0
mirror of https://github.com/zeldaret/oot.git synced 2024-11-14 13:30:47 +00:00
Commit graph

739 commits

Author SHA1 Message Date
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
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
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
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
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
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
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
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
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
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
Tharo
97e795fc0e
Cleanup libultra controller routines (#1312)
* Cleanup libultra controller routines

* Correct structure name

* Fixes + Suggestions

* Move READFORMAT macro to controller.h
2022-07-30 15:41:32 -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
Roman971
7564502b0b
Use intptr types in a few specific boot files (#1301)
* Add stdint.h with intptr_t and uinptr_t

* Use intptr types in dmamgr and yaz0

* Use intptr types in stackcheck

* Use intptr types in idle

* Run formatter

* Use pointers for StackEntry (+ minor type fix)
2022-07-12 12:47:25 -04:00
Dragorn421
2f07874a5f
Remove BINANG_SUB (#1297) 2022-07-12 12:17:07 -04:00
engineer124
c27e292929
Introduce Sfx Tables (#1296)
* sfx tables

* return audio sound params

* Add docs for tables

* REF -> BASE

* Fix description

* Small fix

* Reorder phrase

* Return sfx.h

* Better docs

* Roman PR Suggestions
2022-07-11 13:45:22 -04:00
engineer124
66946534a1
Audio Misc Cleanup 2 (#1303)
* Misc cleanup

* PR Suggestions
2022-07-04 12:19:39 -04:00
engineer124
8778bf09b5
Introduce Mutebehavior Flags (#1304)
* Add muteBehavior flags

* touchup

* Adjust comment
2022-07-04 12:00:29 -04:00
engineer124
f2d4c3b10b
Document code_800C3C20: Audio_StopAllSfx (#1309)
* Document code_800C3C20

* Associate it with AudioMgr to separate it from the audio library
2022-07-04 11:51:38 -04:00
Dragorn421
ed0ab877c9
Some names and docs on dynapoly (#1287)
* Add `BG_DYNA_ACTOR_FLAG_` for `DynaCollisionContext.bgActorFlags`

* Document 3/4 bgActor flags

* `func_8003EE6C` -> `DynaPoly_InvalidateLookup`

* `DynaPoly_ExpandSRT` -> `DynaPoly_AddBgActorToLookup`

* Add `DYNAPOLYACTOR_UNK160_` for `DynaPolyActor.unk_160`

* More dynapoly docs

* One comment

* Some `DynaPoly_` -> `DynaPolyActor_`

* run formatter

* .

* `BG_DYNA_ACTOR_FLAG_IS_USED` -> `BG_DYNA_ACTOR_FLAG_IN_USE`

* `BG_DYNA_ACTOR_FLAG_` -> `BGACTOR_`

* `DYNAPOLYACTOR_INTERACT_FLAG_` -> `DYNA_INTERACT_`

* `ResetInteractFlags` -> `ClearInteractFlags`

* Remove Has/Is prefix on dyna interact flags getters

* format

* remove now useless comments

* Remove `!= 0` on interact flags getter usage

* ceilings collision -> ceiling collision

* `ClearInteractFlags` -> `UnsetInteractFlags` (pepega)

* `UnsetInteractFlags` -> `UnsetAllInteractFlags` (pepega x2)

* Add back `Is` prefix (no `Has` this time) to dyna interact flags getters
2022-06-25 09:53:26 -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
engineer124
fe7afb9b07
Document File-Select Audio Settings: Sound Modes (#1281)
* Round 1

* Cleanup

* Cleanup

* Space

* More spacing

* Apply -> Set (consistency)

* round 1 pr

* Revert some names
2022-06-24 19:27:54 -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
e16779cc33
Rename game states (#1294)
* `TitleSetup` -> `Setup`

* `Title` -> `ConsoleLogo`

* `Opening` -> `TitleSetup`

* `FileChoose` -> `FileSelect`

* `Select` -> `MapSelect`

* prenmi/sample `Context` -> `State`

* Revert filename changes

* .

* setupstate cleanup

* Oops, `GameState` -> `SetupState`
2022-06-23 23:34:26 +02:00
Dragorn421
81ab6fe831
Remove BINANG_ROT180 (#1241) 2022-06-22 16:10:01 -04:00
fig02
e4884e0cb9
Introduce PLAY_LOG() (#1284)
* play log

* review, try to compromise on comment

* another compromise attempt

* new comment

* remove comma

* fix
2022-06-21 19:25:09 +02:00
engineer124
5dda2f9ffc
audio_seqplayer.c cleanup (#1274)
* Audio Seqplayer Cleanup

* More

* Edit description

* PR Suggestions

* while true

* Cleanup function declarations

* Extra space, oops

* Small fix

* PR Suggestions

* tatums per beat

* Edit comment
2022-06-21 04:42:02 -04:00
engineer124
00b98027db
Synthetic Waves Documentation (#1256)
* Synthetic wave documentation

* Better docs

* harmonicIndex

* More

* typo

* Complete the abi buffer docs

* Small change

* Revert change

* PR suggestions

* Missed one

* PR Feedback

* Better documents

* Well that was a silly copy-pasta mistake

* Typo

* Another comment

* Plural

* Make it more block-like

* Capitalization

* Add comments for gWaveSamples[8]

* Adjust comment

* More PR Suggestions

* PR Suggestions

* missed a phrasing

* PR Suggestions

* Update include/z64audio.h

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

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-20 21:55:01 -04:00
engineer124
e7e2da86a8
Remove OoB SfxIds (#1291) 2022-06-20 21:32:17 -04:00
engineer124
d88a23f4a0
Document Viewpoints and Scene Cam Types (#1285)
* 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

* Indoor BgCamData

* Change bgCamData to s16 for now

* PR suggestions

* the

* use "info"

* Missed a suggestion

* Update and sync docs

* More docs

* Even more docs

* Revert macro

* Add comment

* Better comments

* More cleanup

* Better Cam Scene Docs

* Small change

* Market -> Pivot

* "only"

* swap

* Better comment

* Another comment

* to

* Implement suggestions from discord

* Discord Discussion

* Revert bgCamFuncData to Vec3s

* cleanup

* Remaining cleanup

* docs cleanup

* format

* More docs

* Improve notes

* Cleanup

* Change enum

* PR Suggestions

* Improve comment

* Rephrase

* Implement discussion from discord

* Discord discussion

* fixed to locked

* Update comments

* Few more comments

* Update include/z64.h

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

* Update include/z64camera.h

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

* Better comments

* PR Suggestions

* rm numbers

* Update src/code/z_play.c

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

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-20 20:31:53 -04:00
Roman971
6d52684020
Format script improvements and use strict name checks (#1275)
* Prioritize using clang-tidy 6 and improve format.sh

* Use clang-tidy-6.0 when available since it's better at applying 'readability-inconsistent-declaration-parameter-name'
* Add -m32 and -Wno-everything to compiler options to avoid unwanted errors and warnings
* Remove -fsyntax-only since it serves no purpose in the context of clang-tidy

* Apply clang-tidy fixes for argument names

* Run format.sh again

* Use 'Strict' option instead of relying on clang-tidy 6

* Run format script

* Add --fix-notes to clang-tidy options for version 13+
2022-06-20 16:31:53 -04:00
Dragorn421
017a3aaf5c
Some doc on actor overlays alloc types (#1266)
* Some doc on actor overlays alloc types

* Line breaks between defines at the top of actor.h

* plain english

* `ACTOR_ALLOC_` -> `ACTOROVL_ALLOC_`

* More line breaks

* `ACTOR_OVERLAY_ABSOLUTE_SPACE_SIZE` -> `ACTOROVL_ABSOLUTE_SPACE_SIZE`

* Document bug about Scarecrow's Song not setting the flag to restore Nayru's Love

* Try to document the check for needing to actor_kill to leave the absolute space being too broad

* "which overlay uses" (bad english) -> simplify to "which uses"

* Run formatter
2022-06-20 16:17:09 -04:00
engineer124
b602276fef
Introduce Sfx Flags (#1278)
* Sfx Flags

* Discord Discussion

* Move macro to sound_params

* Oops

* PR Suggestions

* Clarify comment

* Missed switch

* More suggestions

* Update src/code/audio_sound_params.c

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

* sfxs

* PR Suggestions

* revert back to flag

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-20 14:24:21 -04:00
engineer124
38de9405e6
Restructuring SoundFont Structs (#1277)
* Document fontData relocation

* Fix

* More cleanup

* typo

* sample -> sampleHeader

* Revert name

* Just a little more

* Another comment change

* Fix Drum

* fix

* K0BASE

* Update relocs

* consistency

* clearer phrasing

* Fix

* PR/Discord Suggestions

* typo

* Revert Sound Font Sample Struct for another PR

* Missed a function

* Organize structs, tuned samples

* New sound effects struct

* fix func name

* wave samples

* consistency

* Fix

* More suggestions

* PR Suggestions

* sample bank reloc

* Revert header description

* better text

* SoundFount Relocation: some cleanup (#6)

* `fontDataStartAddr` for relocation, `fontData` for reading data (`AudioLoad_RelocateFont`)

* Comment "cleanup" in `AudioLoad_RelocateFont`

* Comment "cleanup" in `AudioLoad_RelocateSample`

* Cleanup cast and compares to 0 (offsets) / NULL (pointers)

* Cleanup

* soundFont info

* Revert waveSamples

* cleanup

* Plural

* PR suggestions

* A few name changes and suggestions

* small changes

* Drop Info on SoundFont

* Missed some

* One more function change

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-19 16:31:08 +02: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
Dragorn421
5299208291
Macros for Entranceinfo.field (#1270)
* Macros for `Entranceinfo.field`

* `ENTRANCE_INFO_FIELD_` -> `ENTRANCE_INFO_`

* Remove mentioning the transition types being "default"

* comment on macros what they are for

* Shorten "transition" -> "trans" for `EntranceInfo.field` usage
2022-06-15 20:41:47 +02:00
engineer124
93a6a1eb9a
Audio_Init_Params.c Cleanup (#1273)
* Document Audio Heap Init Sizes

* Swap order

* Another small change

* Another

* Plural

* swap order

* Reverb Settings

* Return comment

* more cleanup

* Fix data names
2022-06-12 19:47:53 -04:00
engineer124
605f13327a
Document SoundFont Relocation (#1237)
* Document fontData relocation

* Fix

* More cleanup

* typo

* sample -> sampleHeader

* Revert name

* Just a little more

* Another comment change

* Fix Drum

* fix

* K0BASE

* Update relocs

* consistency

* clearer phrasing

* Fix

* PR/Discord Suggestions

* typo

* Revert Sound Font Sample Struct for another PR

* Missed a function

* PR Suggestions

* sample bank reloc

* Revert header description

* better text

* SoundFount Relocation: some cleanup (#6)

* `fontDataStartAddr` for relocation, `fontData` for reading data (`AudioLoad_RelocateFont`)

* Comment "cleanup" in `AudioLoad_RelocateFont`

* Comment "cleanup" in `AudioLoad_RelocateSample`

* Cleanup cast and compares to 0 (offsets) / NULL (pointers)

* Cleanup

* Edit comments

* phrasing

Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-12 19:33:56 -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
Kenton M
4cb1c3345f
Small doc for Item00 actor (#1268)
* EnItem00.unk_15A rename to despawnTimer

* func_8001E5C8 rename to EnItem00_BounceAfterCollected

* shorten to Item00_Collected
2022-06-12 19:15:15 -04:00
EllipticEllipsis
be57b6bf4c
Document flag for swinging bottle (#1272)
* Document flag for swinging bottle

* Add bug, minor documentation to func_8084ECA4

* Update comments

* Add newline to z64cutscene_commands.h

* Review
2022-06-12 18:58:13 -04:00
Roman971
a33965c1d0
Minor cleanups in z_std_dma.c and yaz0.c (#1269)
* Cleanup dma and yaz0 functions using pointers for ram

Also includes a minor cleanup of yaz0 names to better fit their purpose

* Run formatter

* Additional cleanups on dma and yaz0 functions
2022-06-11 03:42:05 -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
Roman971
04ade9a255
Update clang-tidy configuration in format.sh and apply fixes for a new check (#1257)
* Update format.sh compiler options and add a check for clang-tidy

* Enable clang-tidy option to find inconsistent argument names

* Remove -Iassets from clang-tidy compiler options
2022-06-07 00:34:28 -04:00
Roman971
6f0b8f1e74
Changes to support renaming segments in the spec (#1259)
* Allow dmadata to have names different from the original table

Added an argument to the dma define which is used to match debug strings in z_std_dma.c

* Update kaleido manager to support different overlay names

* Update the actor table to support different actor names

Added an argument to the define which is used to match debug strings in z_actor_dlftbls.c

* PR suggestions for argument descriptions
2022-06-06 15:51:03 -04:00
Roman971
b0bfa9eb69
Fix asset file includes to always start with assets/ (#1260)
* Fix asset includes to consistently start with assets/

* Fix header paths in asset xmls to start with assets/

* Remove -Iassets from compiler options
2022-06-06 15:37:25 -04:00
Roman971
b28ad659e3
More minor isolated fixes (#1258)
* Fix reversed array access in z_boss_dodongo.c

* Remove useless return in z_en_encount2.c

* Remove some redundant externs or declarations

* Move some undefs to be performed as early as possible

* AudioOcarina_ResetStaffs -> AudioOcarina_ResetStaves

The plural appears to be staves for the music term

* Remove some uses of UNK_PTR

* Use NULL for pointers set to 0 in z_game_dlftbls.c

* Remove useless !! in z_en_tk.c

* Revert "AudioOcarina_ResetStaffs -> AudioOcarina_ResetStaves"

This reverts commit 1b7fe62408.

* Remove more redundant externs from PR suggestion
2022-06-05 12:48:44 -04:00
engineer124
bd4912a1bd
Cleanup NotePlaybackState (#1255)
* Audio Cleanup

* more

* missed one

* Audio docs imported from MM

* Suggestions from Discord

* Small fix

* Fix sizes in z64audio.h

* numSamples

* Cleanup comments

* Revert overlap with soundFont PR

* revert Audio_AdsrUpdate cleanup (move to different PR)

* PR Suggestion

* Mainly typos

* PR suggestion, vol -> volume

* Better description

* Name sampling frequency

* A good number of PR suggestions

* Missed a suggestion

* More PR Suggestions

* Cleanup NotePlaybackState

* one more

* Add comments for new variable names

* Reverb samplePosInt

* Missed one

* Remove `Always set to 0`
2022-06-04 15:29:01 -04:00
Dragorn421
1a41694d58
Add enum for setup dls and name z_rcp.c functions (#1196)
* Introduce `SetupDL` enum

* wip

* wip

* Remove comments on each setupdl index

* Name setup dl functions by setupdl index

* `Gfx_SetupDl` -> `Gfx_SetupDL`

* Run formatter

* globalctx -> play

* fix regressions

* `Gfx_SetupDL` -> `Gfx_SetupDL_` (add separating underscore)

* `CallSetupDL` -> `SetupDL`
2022-06-03 18:25:48 -04:00
engineer124
e989cb7ace
Audio Misc Docs and Cleanup (#1221)
* Audio Cleanup

* more

* missed one

* Audio docs imported from MM

* Suggestions from Discord

* Small fix

* Fix sizes in z64audio.h

* numSamples

* Cleanup comments

* Revert overlap with soundFont PR

* revert Audio_AdsrUpdate cleanup (move to different PR)

* PR Suggestion

* Mainly typos

* PR suggestion, vol -> volume

* Better description

* Name sampling frequency

* A good number of PR suggestions

* Missed a suggestion

* More PR Suggestions

Co-authored-by: fig02 <fig02srl@gmail.com>
2022-06-03 15:59:02 -04:00
Tharo
1738b19d63
More documentation for sched.c (#1219)
* More documentation for sched.c

* VI retrace -> vertical retrace, attempt to clarify comment in viconfig

* Further review changes, fix inconsistent capitalization of PreNMI (PRENMI -> PreNMI)

* Fix typo

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

* Change TaskSwapBuffer, change comment on OS_SC_DRAM_DLIST to unimplemented

* Rename SchedContext/gSchedContext to Scheduler/gScheduler

* Comments fixes

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

* Format

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
2022-06-03 15:43:30 -04:00
Dragorn421
b3b913d33d
Use DMG_ defines in code (#1245)
* Use `DMG_` defines for `dmgFlags` when single bits are used

* Pass on several (in code, no colliders)

* Conditional cleanup

* Remove wip comment, just use the flags 4head
2022-06-03 20:36:04 +02:00
Derek Hensley
b2752a6a2e
Doc Actor Rotation Functions (last 4 funcs in actor.c) (#1249)
* Cleanup functions

* Rename functions

* functions comments

* fix apostrophes

* Renames TurnTo -> Track, other review comments
2022-06-03 20:29:23 +02: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
engineer124
0a95d17aa8
Document Sequence Cutscene Effects (Sequence 109) (#1246)
* Seq 109 docs

* Fix

* Reorder function name
2022-06-02 03:49:10 -04:00
Dragorn421
fa1ea37d54
Fix misc 13 (#1244)
* Squared variables fixup

* `sAnimSoundFrames` fixup

* `ocElemFlags` fixup

* `toucherFlags` fixup

* `bumperFlags` fixup

* `atFlags` fixup

* `acFlags` fixup

* `ocFlags1` fixup

* `ocFlags2` fixup

* `&=`

* `TOUCH_SFX_NONE` -> `_MASK` in `CollisionCheck_HitSolid`
2022-05-31 14:48:41 -04:00
Derek Hensley
bd6b51a869
Overlay Functions Cleanup (#1235)
* Cleanup load functions

* Some cleanup

* forgot .

* Split off Overlay_Load

* review

* OverlayRelocationType -> MIPSRelocationType

* Reloc type macro and mips relocations
2022-05-31 20:28:17 +02:00
Dragorn421
6eeb217225
Doc pass on scene draw configs: names (#1233)
* Name most scene draw configs

* 0 -> None, 36 -> GanonCastleExterior

* 48 -> GraveExitLightShining

* 47 -> CalmWater

* (0) none -> default

* `SCENE_DRAW_CONFIG_` -> `SDC_`
2022-05-31 20:19:46 +02:00
engineer124
8f1fd58f22
Audio Docs: Adsr Decay Rate (#1238)
* Init adsr decay docs

* cleanup

* cleanup

* Revert some docs

* Cleaner docs

* count hex to dec

* scaled updates per frame

* Consistency

* Oops, fix meaning

* Avoid `decayRate` conflict with reverb `decayRate`

* PR suggestion
2022-05-29 14:31:43 -04:00
Dragorn421
d39ce02458
Documentation pass centered on z_player_lib (#1230) 2022-05-29 07:52:15 -04:00
engineer124
e68f321777
Document Magic (#1199)
* 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)

* PR Suggestions

* Missed one

* More PR Suggestions

* Change comment

* Add another clarity comment

* Discord discussions on `magicFillTarget`

* Comments

* grammar

* More comment clarity

* Another bad comment

* PR suggestions, improved comments

* One more comment

* one more thing

* bar -> meter
2022-05-23 18:52:01 +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
4f0018bf36
Environment documentation pass (#1115)
* some docs, start introducing time macro

* most usages of CLOCK_TIME

* finish up clock time defines, format

* saving incase i need to revert

* more docs

* more docs progress

* some more docs

* format with 11

* change sos to storm

* update functions.h

* some depth stuff

* review 1 and 2

* whoops

* update zbuf stuff

* most of review 3

* enum name

* storm state enum

* review 4

* fix enum

* add comment to skyboxischanging

* review

* things dont match, committing so i can change branches

* revert struct changes

* define for override_full_control

* new clock_time macro

* fill alpha -> glare strength

* update comment

* remove indoor/outdoor, new name for underwater light variable

* remove copy pasted comment

* fix comments

* remove whitespave

* review
2022-05-20 14:40:13 -04:00
Dragorn421
d7bbe43ba7
Document eventChkInf usage of freed carpenters flags (#1210)
* Document `eventChkInf` usage of freed carpenters flags

* +`()`
2022-05-20 19:54:47 +02:00
EllipticEllipsis
0e51a51fb1
Document SkelCurve system (#1192)
* Rename and document SkelCurve

* AVOID_UB in DemoTreLgt_OverrideLimbDraw

* Rename code_8006C510

* Objdump flags in the makefile

* Move CC_CHECK above compilation

* Review 1

* Review 2

* Review 3

* Review
Add doxygen comments to file head
use angle macro,
improve bug comment,
make arguments of SkelCurve_Draw more consistent,
Change this temp to pad in MagicWind
2022-05-20 02:27:54 -04:00
fig02
aadb5f9c47
Gameplay_ -> Play_ and this (#1229) 2022-05-18 00:41:50 +02:00
Dragorn421
f6c472ae5e
Doc misc 5 (#1223)
* Annotate global equip and upgrade masks data

* Trivial respawn doc stuff

Move the respawn mode enum up to use the _MAX enum value in the save context struct

* Comment on the `sceneFlags[127]` debug-strings-suggested out-of-bounds access

* Reword `room_inf[127]` comments (attempt)
2022-05-17 00:14:08 +02:00
Dragorn421
d4b6b31b15
Document entrances 0x7FF9-0x7FFF as "Return Entrances" (#1217)
* Document entrances 0x7FF9-0x7FFF as "Exit Entrances"

* `ENTR_EXIT_` -> `ENTR_RETURN_`

* "exit entrance" -> "return entrance"

* Less plural
2022-05-15 11:26:59 -04:00
Dragorn421
811b2d6ad2
Fix misc 12 (#1222)
* (light) `src` to `src/code/code_8006C510.c`

* `setup + entrance` -> `entrance + setup`

* Decimal for `gdSPDefLights1` args (colors, unit vector)

* Run formatter

* `firstDone` bool -> `materialFlag`

* `ENTR_MAX`: 0x613 -> 0x614

* revert `materialFlag` to bool++ for now
2022-05-15 16:38:31 +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
c799176a30
Various minor cleanups (#1218)
* Fix assert in z_en_horse.c

* Fix UB sceneFlags access in z_en_elf.c

* Add Object_Spawn to public object functions

This function is used externally in MM and works as a standalone, so it most likely belongs to the public interface

* Fix float literals to always use lowercase e for the exponent

* Remove "mininap" in one of the map data variables

sDgnMinimapTexIndexBase is also used for the pause menu map so naming it for the minimap turned out to be inaccurate
2022-05-10 15:51:38 -04:00
fig02
2efd00863a
Introduce DEFINE_ENTRANCE for entrance table and create entrance enum (#1213)
* entrance table OK

* entrance enum fixed

* most entrances using enum, still need to do conditionals

* more entrances

* entrance_table.h cleanups

* some review

* remove _0 from first entrance in a group of setups

* change table description

* typo

* wens spellcheck in vscode

* remove extra line
2022-05-09 13:45:53 -04:00
engineer124
95b4317931
Audio Ocarina Documentation (#1026)
* Begin ocarina documentation

* Many ocarina-related docs

* More ocarina docs

* Introduce Ocarina Fonts Enum

* Fix ocarina font enum

* Fix incorrect documentation, more documentation

* Ocarina recording documentation

* cleanup

* Small touch-ups

* Fix font -> instrument

* format

* Better docs on playback, memory game

* more cleanup

* Add z64ocarina.h

* Clean up names

* final cleanup

* typo

* Fix description

* better docs

* Fix channel -> channelIdx

* Fix old "font" name to correct "instrument" name, add io port docs

* Add comments to clarify certain lines/functions

* format

* Rename noteIdx to pitch

* Missed a name

* Add comment on pitch

* `reset` -> `SetInstrument` and `displayed` -> `playback`

* Clarify audio_update and windmill comment

* Minor PR fixes

* Revert Audio_Update because there are 2 different Audio_Update functions

* PR Feedback

* Ocarina Idx -> Index

* Introduce OCARINA_BTN_C_RIGHT_OR_C_LEFT

* PR Suggestions

* Next PR Suggestions

* Next PR Feedback

* consistency

* Better docs (PR)

* Better comment
2022-05-09 18:59:23 +02:00
Dragorn421
6cd8029cd5
Fixup weird horse flags usage (#1214)
* wip: refactor flag defines for `eventInf[0]`

* Cleanup attempt

* run formatter

* remove spacing in enum indices comments

* Add line breaks

* Macros +`()` -`;`
2022-05-08 18:17:10 -04:00
Dragorn421
2dfccbb919
Document eventChkInf usage of frogs played songs flags (#1211)
* Document `eventChkInf` usage of frogs played songs flags

* Prettify frogs flags defines

* Friendlier macro names
2022-05-08 17:52:35 -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
engineer124
80186ec1ab
HealthMeter_ -> Health_ (#1202)
* HealthMeter_ -> Health_

* PR Suggestion
2022-05-07 10:18:42 -04: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
Tharo
765cfd63e9
Name rsp ucodes and surrounding cleanup (#1166)
* Name rsp ucodes and surrounding cleanup

* Fix comments alignment and remove unnecessary & in sys_ucode

* Change capitalization of sys_ucode variables

* Remove unnecessary externs for aspMain

* Improvements to Jpeg_ScheduleDecoderTask

* Split unknown rsp code into a separate file, spacing
2022-05-04 00:43:09 +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
Tharo
7334ffa373
Improve the state of handwritten assembly files (#865)
* Format all handwritten asm and document some

* Use c preprocessor for constants

* Fix

* Fix PI_STATUS_ERROR, some label improvements

* Avoid hi/lo for constants

* Some more comments

* Properly mark functions as functions and their sizes

* Fix merge

* Improvements

* Review suggestions, rework procedure start/end macros to be more like libreultra

* Move IPL3 symbol definitions into ipl3.s

* Fix undefined_syms, add include and language guards to asm.h and fix the comment in gbi.h

* Consistent hex capitalization, add some MIPS builtin defines to CC_CHECK to behave properly

* Add -no-pad-sections assembler option and clean up alignment in gu files and bzero

* Further suggestions and improvements

* Matrix conversion function clarifications

* Fix passing AVOID_UB to gcc

* Suggestions

* Suggestions, global interrupt mask improvements

* Further suggestions, interrupt mask comments

* Comments fixes, rdb.h

* Switch from # comments to // comments, remove unnecesary .set gp=64 directives

* Further review suggestions

* Missed one
2022-05-01 01:03:22 +02:00
Dragorn421
b9fded7b4e
Doc equips usage (inventory, current and player-specific constants) (#1142)
* Doc equips usage (inventory, current and player-specific constants)

* Improve some comments

* `currentSword`(`Item`) -> `currentSwordItemId`

* Comments on the right in `D_801261F8`

* Improve `sDebugSaveInventory.equipment` formatting with extra parentheses

* Use constants for `sNewSaveInventory.equipment`

* Run formatter

* Make comments in z64save.h header a single line even if very long

* `CHECK_OWNED_EQUIP_ALT`

* One more use of `CHECK_OWNED_EQUIP`

* `OWNED_EQUIP_FLAG`

* `OWNED_EQUIP_FLAG_ALT`

* Improve (?) giving sword by item id

* "half-byte" -> "nibble"

* Improve equips for setting kokiri sword

* Improve (?) checking boots by item id

* Improve (?) checking equips by item id

* Fixup one spot assuming `EQUIP_TYPE_SWORD == 0`

* Comments on the right in `sBootDListGroups`
2022-04-30 18:18:56 +02:00
Dragorn421
72847660eb
Fix misc 10 (#1208)
* Cleanup around `Item_DropCollectible`

* Cleanup around `Math3D_Vec3fDistSq`, `Math3D_Dist2DSq`

* Material/Model naming for one dlist pair

* Minor comments fixup

* Explicit `!= NULL` check

* Signed decimal for an array of coordinates

* Fixup comments some more
2022-04-30 08:33:28 -04:00
Dragorn421
0d7670f059
Fixup feetFloorFlags doc and -> feetFloorFlag (#1180) 2022-04-29 14:29:49 -04:00
Dragorn421
6336df5fcd
Defines for SaveContext flags (eventChkInf, itemGetInf, infTable, eventInf) (#1094)
* script-assisted `itemGetInf` flags

* comment near non-trivial `itemGetInf` usage

* Run formatter

* Try something with the itemgetinf flags that can't use the packed value

* Add defines for `eventChkInf` (direct access)

* Add defines for `eventChkInf` (access through `Flags_GetEventChkInf`)

* Add defines for `eventChkInf` (access through `Flags_SetEventChkInf`)

* Add defines for `infTable` (direct access)

* Add defines for `infTable` (used by `Flags_GetInfTable`)

* Add defines for `infTable` (used by `Flags_SetInfTable`)

* Add defines for `eventInf`

* parenthesis cleanup near `GET_EVENTCHKINF` usage

* parenthesis cleanup near `GET_ITEMGETINF` usage

* parenthesis cleanup near `GET_INFTABLE` usage

* fixup one `eventInf` usage

* parenthesis cleanup near `GET_EVENTINF` usage

* parenthesis cleanup near `Flags_GetEventChkInf` usage

* slight `z64save.h` formatting improvement

* Improve itemGetInf flags in z_bg_dy_yoseizo

* Questionable improvement in z_en_ge2

* Questionable improvement in z_en_daiku

* Questionable improvement in z_en_mu

* Run formatter

* Parentheses around `gSaveContext` macros arguments

* Move individual flags define to the end of z64save.h, and improve comments separating the groups
2022-04-29 14:19:48 -04: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
engineer124
ef870bdd11
Name variables for Audio_PlaySoundGeneral (#1198)
* Rename variables and function

* Improve comment

* PR Suggestion

* PR Suggestions

* Revert back to `Audio_PlaySoundGeneral`, make a separate PR `Sound` -> `Sfx`

* Oops, fixed that
2022-04-23 10:55:18 -04:00
engineer124
1e03b662f2
Parameter/Item Misc Cleanup (#1201)
* Misc parameter cleanup

* More cleanup

* More cleanup

* ia4, more readable

* More comments

* PR Suggestion
2022-04-23 16:41:17 +02:00
playerskel
32e66c2da8
document most navi enemies as enum type (#1110)
* document most navi enemies as enum type

* enum value auto increments, add enemy default for 0

* also define and comment navi enemy tektite blue

* Update include/z64actor.h

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

* Update include/z64actor.h

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

* Update include/z64actor.h

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

* Update include/z64actor.h

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

* Update include/z64actor.h

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

* Update include/z64actor.h

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

* apply navi enemy updates accepted so far

* update names

* review

* review

* freezzard -> freezard

Co-authored-by: mzxrules <mzxrules@gmail.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
2022-04-18 18:23:12 -04:00
Tharo
7068ad3703
Message Queues, Threads, and surroundings cleanup (#1178)
* message queues, threads, and surroundings cleanup

* Format, make the formatter prefer clang-format-11 if found

* Fix __osThreadTail type

* Q -> Queue, thread defines renamed

* Reformat, add missing NULL

* Suggested changes and further casting cleanup

* Reformat

* padmgr name fixes
2022-04-08 20:20:23 -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
b9b40805f7
Fix misc 9 (#1183)
* Fix typo `tranform` -> `transform`

* (may be controversial) `indexes` (noun) -> `indices`, both are correct but `indices` prevails in the repo currently, and seems prefered in technical contexts

* Fixup one `@bug`

* Fix typo `relfect` -> `reflect`

* Rename and `@bug` `DemoTreLgt_OverrideLimbDraw`

* Fixup `PLAYER_AP_` to `ARROW_` type conversion

* `posModel` -> `modelPos`

* `effSpawnPosModel` -> `effSpawnModelPos`

* Gohma decay bug: Verified that timers do not prevent UB access

* Reorder summation in a more meaningful way

Co-authored-by: JoshDuMan <40190173+JoshDuMan@users.noreply.github.com>
2022-04-03 18:33:50 -04:00
engineer124
04fb0ac1b1
Document Pushing Player: Bg Conveyors and Climbing Slopes (#1103)
* Document pushing Player

* Cleaner and better names

* Tiny cleanup

* Add enum to func

* PR Feedback

* Change conveyor to `IsFloorConveyor`

* Small touchup

* Attempt at better comments

* Clarify comments

* Clarify comment further

* Fix formatting

* PR Feedback
2022-04-04 00:06:25 +02:00
Dragorn421
3ce701cfd8
Angle cleanup - miscellaneous (#1159)
* Add `BINANG_TO_RAD_ALT2`

* Few hex constants in place of decimal cardinal angles

* Use `BINANG_TO_DEGF` more

* Use `DEG_TO_RAD(int)` for angle literals

* `BINANG_TO_RAD_ALT(literal)` -> use `BINANG_TO_RAD`

* Somewhat arbitrary literal angles cleanup
2022-04-03 14:32:18 -04:00
louist103
791d9018c0
first pass (#1185) 2022-03-21 20:49:11 +01: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
8f9e309452
Doc (partially) player model and anim code data (#1143)
* Doc (partially) player model and anim data

* `Player_OverrideLimbDrawPause` -> `func_80091880`

* Enum comments: use hex

* Change `D_80853914` to 1D array, change accesses to use new macro `PLAYER_ANIM_BY_GROUP_AND_TYPE`

* `PLAYER_ANIM_BY_GROUP_AND_TYPE` -> `GET_PLAYER_ANIM`
2022-03-20 23:42:01 +01:00
Dragorn421
0e5ecdcd73
Angle cleanup - BINANG_TO_RAD, BINANG_TO_RAD_ALT (#1158)
* Run formatter

* Touch up angle macros (parentheses and hex constants)

* Add `BINANG_TO_RAD_ALT`

* Swap `BINANG_TO_RAD` and `BINANG_TO_RAD_ALT`

* Run formatter
2022-03-19 20:16:33 -04:00
Tharo
a7fa906841
Small collision_check improvements (#1172)
* COLSHAPE_INVALID -> COLSHAPE_MAX, variable names

* Marked suggestions

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

* true/false, SAC_ON define for sacFlags

* SAC_ON -> SAC_ENABLE, intersection -> hitPos, revert ARRAY_COUNT use in CollisionCheck_ApplyDamage

Co-authored-by: mzxrules <mzxrules@gmail.com>
2022-03-20 00:33:47 +01:00
Dragorn421
b2a3fb2f7f
Fix misc 8 (#1150)
* Use `s32` as type instead of `StackStatus` enum type

* `bossLimbDl` -> `bossLimbDL`

* Fixup comment refering to `Actor.velocity` by struct offset

* Fixup `feetFloorFlags` doc and -> `feetFloorFlag`

* Fixup `xyzDistToPlayerSq` comment

* Make `SkelAnime.mode` comment refer to `AnimationMode` (<- `AnimationModes`)

* Use enum names to refer to anim modes and break long lines in z64animation.h

* `EnDha_OverridePostDraw` -> `EnDha_PostLimbDraw`

* ichains cleanup

* Scene command ids usage cleanup

* Properly name unkXXX members as unk_XXX

* change `gSceneCmdHandlers` length in variables.h too

* Revert Unknown flags to unk0 & unk1

* Remove "current scene" mention from `Flags_*Unknown` as they aren't saved or loaded so not scene-specific

* `Struct_8011FAF0`: unk_00, unk_04

* Run formatter

* Do not break long lines in headers

* Revert "Fixup `feetFloorFlags` doc and -> `feetFloorFlag`"

This reverts commit c45b3611e7.
2022-03-16 22:14:56 +01:00
Tharo
93096a45b6
More documentation for IrqMgr (#1144)
* doc irqmgr

* Fix

* Format

* Review suggestions

* Fix

* Some more review

* Further changes
2022-03-13 19:22:14 -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
054bac7583
Doc player drawing (#1098)
* Introduce and use more enums and defines for equips and data involved in player drawing

* `EQUIP_TYPE_`, `EQUIP_INV_`, `EQUIP_VALUE_`

* Improve doc on ItemEquips/Inventory's `equipment` field

* Run formatter

* Add `PLAYER_MODELGROUPENTRY_*` for second index of `gPlayerModelTypes`

* Name `PLAYER_MODELGROUPENTRY_*` from existing documentation

* Partial doc on `PLAYER_MODELTYPE_*`

* Some doc on `PLAYER_MODELGROUP_*`

* Run formatter

* Name and some doc/cleanup on the various player draw functions

* Name symbols used for player position in pause menu

* Name player override/post limb draw callbacks

* `BOOTS_NORMAL` -> `BOOTS_KOKIRI`

* `EQUIP_INV_SWORD_GIANTKNIFE` -> `EQUIP_INV_SWORD_BROKENGIANTKNIFE`

* `currentSword` -> `currentSwordItem` to avoid confusion with `PlayerSword` enum

* Make one constant more explicit

* Document severe bug (not an issue by luck)

* Some doc on `PLAYER_MODELTYPE_RH_FF`

* Actually name most of `PlayerModelType`

* Actually name most of `PlayerModelGroup` and improve comments

* Make equipment in debug save data use equip enums

* Name symbol for computing player's `bodyPartsPos` and fix struct access

* Name right/left `HandType` symbols

* Add `PlayerBodyPart` enum

* Run formatter

* Introduce defines for pause player render dimensions and cleanup viewport usage in pause drawing

* Document `playerSegment` related usage

* Run formatter

* Revert player bodypart changes

* Revert equips doc changes

* Revert player model and anim data changes

* Revert drawing-unrelated changes

* Move `sTunicColors` tunic comments to after data
2022-03-12 19:06:43 -05:00
playerskel
a160fb96c8
Naming1 (#1113)
* typo

* rename 800636C0 to gameinfo_init

* fix incorrect casing in cup button

* some constants

* add item00_none enum value

* rename 80009460 to gdmaverbose

* fix typos

* Revert "some constants"

This reverts commit 27a07204d7.

* rename gdmaverbose to gdmamgrverbose

* Revert "rename 800636C0 to gameinfo_init"

This reverts commit c74e255929.

* Revert "fix incorrect casing in cup button"

This reverts commit ac313b3965.

* a couple of typos

* minor changes based on clang-format
2022-03-10 21:21:46 +01:00
Dragorn421
c55a8530ee
PlayerMeleeWeaponAnimation enum (#1154)
* Move `PlayerSwordAnimation` from `z_en_torch2.c` to `z64player.h`

* `PlayerSwordAnimation` -> `PlayerMeleeWeaponAnimation`

* Add `PWMA_` prefix to `PlayerMeleeWeaponAnimation` values

* Use `PlayerMeleeWeaponAnimation` enum more

* Add `PWMA_MAX`

* Update comments in z_en_kanban.c

* Some cleanup around conditionals with `meleeWeaponAnimation`

* Comment `PWMA_` index value in `D_80854190`

* `PMWA_` -> `PLAYER_MWA_`

* Minor fixup

* Missed one spot

* Run formatter
2022-03-09 12:52:28 -05: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
dfbc356cdf
Document vismono (#1107)
* Document and explain vismono

* Make it more clear "CFB" means Color Frame Buffer

* Rename: Update DList/TLUT -> Desaturate DList/TLUT
2022-02-27 16:21:26 -05:00
Dragorn421
145b14dbc4
sword -> meleeWeapon (#1147) 2022-02-20 18:45:12 -05:00
Dragorn421
b9cc31dc74
Defines for flags passed to Actor_UpdateBgCheckInfo (#1127)
* Tool-assisted flags for `Actor_UpdateBgCheckInfo`

* Manual flags separation

* Run formatter

* Light doc on the flags

* `UPDBGCHECKINFOFLAG_` -> `UPDBGCHECKINFO_FLAG_` (what an improvement!)

* Run formatter

* Run formatter
2022-02-20 18:41:55 -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