* z_en_horse_zelda doc
Zelda's horse has been better documented. Horse seemed to follow a path around Hyrule Field
* `z_en_horse_zelda` revised based on feedback
* Update z_en_horse_zelda.c
EnHorseZelda_ResetAnimation -> EnHorseZelda_SetupStop
* z_horse_zelda: changes based on feedback
* Improvements to VI related functions
* Fix
* Suggested changes
* Comment enum values
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
* Suggested changes, plus comments in visetspecial.c
* Name gViConfigModeType
* Further suggested changes
* Format
* Fix comment on modeLPN2
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
* Real rcp.h
* Correction to comment in initialize.c
* Try fix R4300.h
* Adjust rcp.h formatting, remove defines in other headers that are now in rcp.h
* Suggested changes, document a bug in the modified osAiSetNextBuffer
* More rcp.h formatting changes
* `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
* 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>
* 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>
* Comment enums on some big arrays
* z_camera_data too
* comment in get item table on own lines
* `sDebugSaveInventory.ammo`
* More in z_sram
* `0xFF` -> `ITEM_NONE` in `sNewSaveInventory.items`
* 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
* `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>
* 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
* 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`
* 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
* `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>
* 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
* 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
* 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
* 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
* 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
* More documentation for PreRender.c
* Comment fix
* Suggested changes
* More on coverage reading functions
* Further comment changes
* Further suggestions
* 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
* 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
* en_skb stalchild actor doc
* missed a sneaky one
* rename Main to DecideNextAction
* action state rename and become enum
* tweak bodybreak comment
* rename SPAWNING to BURIED
* rename to headlessWalkYawOffset
* rename hitboxActive to enableATCollision
* use bools for enableATCollision
* formatting
* move EnSkbActionState out of header
* rename enableATCollision -> setColliderAT
* remove unnecessary prototypes
* renaming per review, settle on breakFlags
* 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
* 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)
* 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)
* 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+
* 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
* 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>
* 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
* Document Audio Heap Init Sizes
* Swap order
* Another small change
* Another
* Plural
* swap order
* Reverb Settings
* Return comment
* more cleanup
* Fix data names
* 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>
* 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
* 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
* 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
* 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`
* 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>
* 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
* Document Table For Sequence Instruction Arguments
* Add small bit of docs
* More cleanup
* Shorten Macros
* Add another comment
* rm cast
* Cleanup
* More consistency
* instruction
* Better ret name
* PR suggestions
* Small fix
* 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
* 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
* 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
