* 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" ?
* 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>
* Improve rcp.h, remove `HW_REG` macro (#1425)
* 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
* Fix misc 18 (#1423)
* two more ABS
* fixup item_name_static texs outnames
* fixup CollisionCheck_SetOCvsOC docs
* Cleanup int comments alignments
* collsion -> collision
* `SQ*` macros fixup
* use `LERP` more
* static -> `s` prefix
* grammar: dont -> don't
* 3
* Improvements to Video Interface related functions and data (#1332)
* 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>
* TwoHeadArena and TwoHeadGfxArena docs (#1349)
* TwoHeadArena and TwoHeadGfxArena docs, ALIGNOF macro
* AllocStart -> AllocHead , AllocEnd -> AllocTail
* Format
* Suggested changes
* Fix
* Further suggested changes
* z_en_horse_zelda doc (#1430)
* 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
* Mempak doc (#1382)
* Mempak doc
* Format
* Suggested changes
* Further changes
* Update item names (#1376)
* Reevaluate item names (`ItemID` enum)
* format
* Carry `ItemID` changes to `ExchangeItemID`
* format
* Add item enum comments on items to slots array
* Rename slots according to current item enum names
* Add item enum comments on items to PlayerItemAction array
* Rename PlayerItemAction enum names according to current item enum names
* gi, gid names...
* `QUEST_GERUDO_CARD` -> `QUEST_GERUDOS_CARD`
* `DUNGEON_KEY_BOSS` -> `DUNGEON_BOSS_KEY`
* `UPG_` sticks/nuts : +deku
* Fixed remove array enum comments in `sDebugSaveEquips`
* "magic beans" -> "magic bean" (singular)
* cucco -> chicken (the one from weird egg, "alarm clock bird" from literal japanese translation)
* Document Timers (#1412)
* 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
* More documentation for `z_std_dma.c` (#1415)
* 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
* `z_en_bird` doc (#1431)
* `z_en_bird` doc
Documented `z_en_bird`
* `Z_en_bird` changes from feedback
* Update z_en_bird.c
* `z_en_bird`: suggested changes
* `z_en_bird`: changes based on feedback
animation speed mod field changed, redundant comments removed.
* z_shot_sun: minor doc (#1429)
* 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.
* `z_obj_lift`: doc remaining funcs and field (#1440)
* `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
* Small `Actor_UpdateAll` doc (#1432)
* Small `Actor_UpdateAll` doc
* improve, "freeze"
* rename "freeze category masks"
* shorten to "category freeze mask" everywhere
* Doc object_rs (#1439)
* Document En_Ko Animations (#1306)
* Document Kokiri Children animations
* Remove BOY, GIRL, and FADO prefixes
* Formatting
* Further prefix removal
* more fixups
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
* Document Hud Mode (#1323)
* begin interface alpha docs
* more progress/docs
* First draft of docs done
* cleanup
* Consistency
* Display -> Mode
* Remaining display -> mode
* Better docs
* Small touchups
* Small Update
* Apply discord discussion
* small fix
* More discussions
* PR Suggestions
* Roman PR Suggestions
* better comments
* PR Suggestions
* another suggestion
* discord discussions
* cleanup comments
* more discord/pr suggestions
* Document NPC talking and player tracking (#1426)
* 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>
* Player doc: Temporary `PLAYER_ANIMGROUP` names from original animation names (#1446)
* Name `PLAYER_ANIMGROUP_` based on original names
* format
* add comment indicating source of names
* Document HREG debugging system (#1351)
* progress
* progress
* change
* named most
* name prerender things
* fix and format
* play prefix
* address most comments (still a few more things to do)
* fix error
* reword input test comments
* some more
* rework env draw flags
* add hilite
* merge and format
* init to proper values
* rename env draw flag names
* 7 to 6
* more small changes
* Name scenes (scene enum, entrance enum, various identifiers) (#1343)
* Comment names on titled scenes
* Comment some more scene names
* Comment some map assets symbol prefixes
* Name collapse sequence scenes (from the non-collapse equivalent scene's name + `_COLLAPSE`)
* Name ganon/ganondorf boss scenes (symbol prefix suffixed with `Scene` to prevent confusion with boss actors)
* Fix symbol prefix for back alley night scene
* Name the two grave scenes (normal and fairy's fountain variant)
* Name most houses, name/update misc scenes
Co-authored-by: fig02 <fig02srl@gmail.com>
* (hakaana) `GRAVE` -> `REDEAD_GRAVE` to be more specific
Co-authored-by: fig02 <fig02srl@gmail.com>
* `miharigoya_scene`: `market_guard_house`
* `kakariko_scene` -> `kakariko_center_house`
* `richards_house` -> `dog_lady_house` (for localization differences)
* Revert "Comment some map assets symbol prefixes"
This reverts commit 210a38a6288d5d2fa318059f31988ca7ceb5c708.
* 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>
* Add skybox .h and cleanup, `SkyboxDraw_` -> `Skybox_` (#1435)
* 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
* Document Surface Material (#1447)
* material
* cleanup
* iron boots
* climb
* more docs
* rename
* small fix
* comments
* adjust bug comment
* simplify comment
* Document Camera for Elevator Platforms (Camera_Special7) (#1448)
* document camera for vertical platforms
* cleanup
* another rename
* small
* another rename
* add comment
* PR Suggestions
* more cleanup
* oops
* adjust comment
* Skelanime/Animation header cleanup (#1434)
* Skelanime/Animation header cleanup
* touch up names of the two existing moveFlags macros
* formatter is a dum dum D:
* fixed z_select.h changes
* fixed config entrance name
Co-authored-by: Tharo <17233964+Thar0@users.noreply.github.com>
Co-authored-by: Dragorn421 <Dragorn421@users.noreply.github.com>
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: blackgamma7 <blackgamma7@gmail.com>
Co-authored-by: Derek Hensley <hensley.derek58@gmail.com>
Co-authored-by: Charles Averill <46544495+CharlesAverill@users.noreply.github.com>
Co-authored-by: Lauri Koskela <luryus@users.noreply.github.com>
Co-authored-by: fig02 <fig02srl@gmail.com>
