* 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>
* 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
* 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
* 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
* More documentation for PreRender.c
* Comment fix
* Suggested changes
* More on coverage reading functions
* Further comment changes
* Further suggestions
* 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+
* 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>
* 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
* 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>
