* Some doc/cleanup on `Effect_Ss_Fhg_Flash`
* Some doc/cleanup on `Effect_Ss_Blast`
* 11DA0 -> Billboard
* doc three lerp funcs in effectss
* Some doc/cleanup on `Effect_Ss_Bomb`
* `rTexIdx` -> `rTexIndex`
* lifespan
* `LIFESPAN` -> `EFFSSBOMB_LIFESPAN`
* --parentheses
* Add todo about "having zapd forward declare static variables"
* try rework comments on effects scale
* lightning -> "a ball of electrical arcs" ?
* Add defines for all used animflags
* Use named constants (and add two) for players `func_80832F54` flags
* note which flags are player-only
* Attempt at documenting but too FeelsUnkMan again
* forgot something
* ANIM_FLAG_PLAYER_0 -> ANIM_FLAG_0 and amend comment from "player-only" to "no effect outside player"
* 1<<n flags
* some EnHoll cleanup
* some more EnHoll cleanup
* even more EnHoll cleanup
* EnHoll docs
* `enHollFillAlpha` -> `bgCoverAlpha`
* Dl -> DL
* one temp: action -> type
* Move static data out of `EnHoll_HorizontalVisibleNarrow`
* "fade" -> "bgcover"
* spread sentence over several lines
* tweak comments formatting
Co-authored-by: fig02 <fig02srl@gmail.com>
* Change BunnyEarKinematics struct and some docs
* More complete docs
* Format, quick note in the InitModes array
* remove comment and move struct down
Co-authored-by: fig02 <fig02srl@gmail.com>
* "bgs sword" -> "biggoron sword"
* Animation_ChangeImpl: last arg is `ANIMTAPER_` enum
* TransitionTileStatus -> state
* Tiny gbi.h formatting fixups
* some cleanup on floormaster
* misc float ops cleanup
* sunsSongState = SUNSSONG_INACTIVE
* continueFlag == CS_CMD_STOP
* fix few camera names inconsistency
* textual 0 padding? not on my lawn
* libultra: construct address from end of dmem rather than oob from imem
* more free1 -> 2 fixup
* rename functions
* dragorns name suggestions
* Revert "dragorns name suggestions"
This reverts commit dd4626ce5e.
* lets try that again
* reword comment
* comments
* projectile speed
* arg name
* more comments
* minVelY comment
* merge master and format
* name functions and clean up some stuff
* clean up function call args and use enum, format
* slightly change comment
* review
* make things more debug cam oriented
* rename buffer
* regs update comment
* move enum
* commit old stuff
* progress
* progress
* progress
* progress
* more progress, renaming cues next
* small changes
* enum values added for all actions
* hardcoded values removed when possible
* commands renamed
* first pass of action -> cue
* fix some matches
* some more cleanup
* scriptPtr
* forgot one
* remove cue rot union
* more changes
* some more stuff
* more stuff
* fix matching issues
* some more things
* progress, starting to rename destinations
* small changes
* name some destinations
* more names
* need to switch branch
* progress
* first pass of destination names
* usages fixed
* use destination enum
* fix csdis
* format
* command descriptions
* revert accidental zap changes
* forgot some things
* use a single macro for CutsceneCameraPoint (idk why i didnt think of this sooner)
* typo
* review1
* clarify ruby/sapphire comment
* remove endframe for commands that dont use it
* some more review
* most review, but not all
* scriptPtr -> script, and another small change
* ocarina action
* remove +1 from light settings command, change comment
* actionIndex -> cueIdTemp (i guess)
* _SetCueX -> _SetXFromCue
* format
* tweak fade out seq arg names
* use spline terminology
* more dragorn and engineer review
* misc start/end frame note
* cleanup StartPosRotFromCue vs PosRotFromCue
* cleanup spline terminology
* sPrevCamId -> sReturnToCamId
* comment on debug cs data address
* Cutscene_Init -> Cutscene_InitContext
* single point types are not a list
* remove todo comment
* some more review
* rumble struct names
* some review
* more review
* missed one
* reword pointer comment
* even more review
* match transition terminology with z_play
* change condition and format
* frame count
* command specific structs with alignment
* anon review
* remove unneeded arg from time macro
* yeet `CsCmdGeneric`
* remove unused from single point types
* typo
* compromise attempt -- name endFrame everywhere
* fixes
* fix again
* copied the wrong note
* cutscene data note
* review, format
* compat defines
* idk whats going on man
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
* DoorShutter logic docs
* Comment on two more funcs
* Fix comment on DoorShutter_UnbarredCheckSwitchFlag I mmissed the `!(... == SHUTTER_FRONT_CLEAR)`
* Remove types 8,9,10 from enum as they aren't referenced by any transition actor list in all scenes
* Add `DOORSHUTTER_PARAMS` macro to pack params
* `DoorShutter_WaitPlayerShock` -> `DoorShutter_WaitPlayerSurprised`
* --comma
* moveState -> isActive
* Add mention about SlidingDoorActorBase.isActive being a timer in niche DoorShutter cases
* Clean up player tracking related things in NPCs
* Cleanup Npc_UpdateTalking usages and related things
* Reformat
* Minor fixes based on review comments
* Remove unneeded declarations
* More consistent function names
* begin docs
* More suggestions
* more docs
* timer to duration
* partial PR review
* init data with player
* consistent comments
* withPlayer to usingPlayer
* pushing up to save changes
* syncing up some more docs
* finishing what I can
* PR feedback
* fixing typo
* Addressing comments
* master merge
* naming object
* ummm committing this for now before catching up
* other review + my review
* more review
* review2
Co-authored-by: fig02 <fig02srl@gmail.com>
* Cleanup scene names
* missing scene id use
* rename scene draw config functions
* remove now useless comments
* format
* fix double defense/magic swapped
* try precision on "from potion shop"
Co-authored-by: engineer124 <engineer124engineer124@gmail.com>
* document camera for vertical platforms
* cleanup
* another rename
* small
* another rename
* add comment
* PR Suggestions
* more cleanup
* oops
* adjust comment
* Add skybox .h and cleanup
* move forward declared structs to top of file
* `SkyboxDraw_` -> `Skybox_`
* format
* move more forward declared structs to top of file
* Comment names on titled scenes
* Comment some more scene names
* Comment some map assets symbol prefixes
* Name collapse sequence scenes (from the non-collapse equivalent scene's name + `_COLLAPSE`)
* Name ganon/ganondorf boss scenes (symbol prefix suffixed with `Scene` to prevent confusion with boss actors)
* Fix symbol prefix for back alley night scene
* Name the two grave scenes (normal and fairy's fountain variant)
* Name most houses, name/update misc scenes
Co-authored-by: fig02 <fig02srl@gmail.com>
* (hakaana) `GRAVE` -> `REDEAD_GRAVE` to be more specific
Co-authored-by: fig02 <fig02srl@gmail.com>
* `miharigoya_scene`: `market_guard_house`
* `kakariko_scene` -> `kakariko_center_house`
* `richards_house` -> `dog_lady_house` (for localization differences)
* Revert "Comment some map assets symbol prefixes"
This reverts commit 210a38a628.
* remove other xml prefixes
* ganon_boss, ganondorf_boss
* comments to namefixer
* `KAKARIKO_CENTER_HOUSE` -> `KAKARIKO_CENTER_GUEST_HOUSE`
* two collapse sequence scenes -> `GANONS_TOWER_COLLAPSE_`interior/exterior
* Run namefixer
`find src include -type f -exec ./tools/namefixer.py {} \;`
* run formatter
Co-authored-by: fig02 <fig02srl@gmail.com>
* Rename npc dialog state variable
* Rename and doc NPC actor talking funtion
* Introduce NpcTalkState enum
* Rename NPC_TALK_STATE enum values
* Document NpcPlayerInteractionState and related functions
* Rename player tracking opt enum variants
* Rename npc functions, interact info
* Minor npc actor function tweaks
* Minor comment fixes for npc
* Generalize NPC player tracking to point tracking
* Change unused NpcInteractInfo field type and name
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
* Rename headRot and torsoRot
* Rename GetTalkState to UpdateTalkState
* Minor comment fixes
* Rename rotateActorShape and clarify related comments
* Remove unneeded parentheses in z_en_heishi4.c
* Reformat
* Remove unclear comment
* Rename yPosOffset to yOffset
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
* `z_obj_lift`: doc funcs and field
doc remaining funcs and field in `z_obj_lift`
* `z_obj_lift`: shakeVec->shakeOrientation
* removed space from copy-paste of field name
* z_shot_sun: minor doc
document one field and function remaining in z_shot_sun
* z_shot_sun: updated state doc'ing
* Update z_shot_sun.c
format enum
* ran format.py
* `z_shot_sun`: changes based on feedback
gave enum better name, removed redundant comment.
* Update z_shot_sun.c
enum changed.
* More documentation for z_std_dma
* uintptr casts for rom symbols in z64animation.h and z_kanfont.c
* Format
* Suggested changes, more defines for static texture sizes
* PI Interface -> PI
* Further suggested changes
* Format
* Comments about item_name and map_name texture assumptions
* Document Timers, First Draft
* some progress
* more timer docs
* cleanup
* small cleanup
* more cleanup
* comments
* more cleanup
* extra comment
* more docs
* brackets
* PR Suggestions
* cleanup, missed some
* more suggestions
* more PR Suggestions
* small change
* environmental
* 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
* `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
* 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
