mm/include/z64subs.h, branch main

Boss07 (Majora) OK and documented [mm-n64-us.z64 OK] (#1753)

2024-12-11T02:06:55+00:00

* more matches

* more functions

* merge, I hope

* wrath done-ish

* 5 nonmatchings

* more matchings

* more improvements

* more stuff

* stuff

* docs part 1 / infinity

* more docs

* .

* more adjustments

* linked assets

* Document object_boss07 and match Boss07_Incarnation_Intro (thanks Synray!)

* more stuff

* play part 2

* lol merge

* update

* unk types

* SWEET GOOGLY MOOGLY IT MATCHES

* cam fixes

* adjust damage stuff

* if?

* stuff

* signs

* macro stuff. clean up later

* names

* Some small cleanup

* cleanup and docs

* more cleanup

* Wrath shadow docs

* Use `EVENTINF_INTRO_CS_WATCHED_MAJORA` after merging

* Update functions.txt

* Types cleanup

* Some low hanging fruit

* Undefined_syms.txt

* More static -> battle handler

* Lots of naming cleanup

* Remove z_boss_07_dmgtbl.inc
The reasoning behind removing this file is simple; it wasn't all that long, so extracting it out to an included file didn't really add much, and it made refactoring and/or things much harder, since you needed to check in multiple places to change things.

* Get most of the limb stuff named (and actually update the spec)

* Some minor cleanup

* Updating the repo with what we talked about in discord

* Some syncing with Odolwa and other misc name stuff

* Some Odolwa/Bio Baba sync

* Another bit of Odolwa/Bio Baba sync

* Name a lot of incarnation limb variables

* Finalize the incarnation intro variable stuff

* Fix a goof

* `incarnationWrathTransition` variables

* `generalCollider` and always use "tentacle"

* Completely remove "shot," always use "projectile"

* Clean up `Boss07_Mask_Draw`

* Name `maskShakeTimer`

* Give better names to a few more things

* Some beam-related struct vars

* undefined_syms

* More beam names

* More beam stuff

* Beam, pt 100000

* Some intro struct members

* Some timers

* More non-beam stuff, back to beam

* Done with beam finally

* All but one of the subcam variables, some other stuff

* Some variable names and cleanup

* More cleanup

* jumpSfxTimer -> landSfxTimer

* actionState -> subAction and a little bit of syncing with Odolwa

* A couple more variables sync

* Buncha variables

* Lots of non-whip variables

* Commit what I have before starting on some of the grab stuff

* All but one struct var done

* Lots of header cleanup

* Finish the header file

* Fix build after merging main

* Damage effect enums

* Update damage effect enums for Incarnation and Wrath

* Update damage effect enums for Mask and Remains

* First pass at top damage effects

* Do a few sub action enums so I have something to show

* Fix the damage effect enums, clean up a lot of subaction enums

* All remaining sub action enums, cleanup damage effect enums, other misc cleanup

* Finish enums

* Finish data

* Push up what I have

* Consistency

* scroll -> texScroll

* low hanging fruit

* PR + small fix

* Happy with >20% of functions

* Happy with >40% of functions

* Happy with >60% of functions

* Happy with >75% of functions

* Happy with >90% of functions

* Happy with >95% of functions

* Happy with `Boss07_Wrath_DeathCutscene`

* Happy with `Boss07_Mask_FireBeam`

* Happy with `Boss07_Wrath_CheckWhipCollisions`

* Happy with everything but `Boss07_Mask_Draw`

* Happy with all functions I think?

* Clean up forward declarations

* Write a half-decent file header

* Fix after merging

* Fix some minor stuff here and there

* Minor fix in the file header because I forgot I renamed this

* Respond to engineer's review

* Respond to Anghelo's review

* Replace as many actor lookups with for-loops as I can in Odolwa/Majora

* Change the comment about the hookshot from a `@note` to a `@bug`

* `drag` -> `deceleration`

* Extra scopes for the matrix stuff in `Boss07_Mask_DrawBeam`

* Use decimal numbers in the various `FillShadowTex` functions

---------

Co-authored-by: petrie911 
Co-authored-by: petrie911 
Co-authored-by: petrie911 <69443847+petrie911@users.noreply.github.com>
Co-authored-by: petrie911 
Co-authored-by: petrie911 
Co-authored-by: Derek Hensley 
Co-authored-by: engineer124

Remove assets from automatic includes (#1683)

2024-09-10T18:16:56+00:00

`ovl_En_Door` docs pass (#1603)

2024-04-23T01:34:02+00:00

* DoorScheduleResult

* actionVar

* DOOR_DL_

* enums

* ENDOOR_TYPE_SCHEDULE and related stuff

* Name some functions and start figuring out stuff

* defines

* start documenting schedules

* Name Inn doors

* More door schedule naming

* ajar

* Name remaining schedule types

* parameters diagram and some cleanups

* Name renaiming types

* format

* rename some schedules

* Use more static_assert

* name anims

* yeet unrelated stuff

* requestOpen

* Yeet DoorScheduleResult

* whoops

* stuff i missed

* Update src/overlays/actors/ovl_En_Door/scheduleScripts.schl

Co-authored-by: Derek Hensley 

* Update src/overlays/actors/ovl_En_Door/z_en_door.h

Co-authored-by: Derek Hensley 

* Update src/overlays/actors/ovl_En_Door/z_en_door.h

Co-authored-by: Derek Hensley 

* review

* Update src/overlays/actors/ovl_En_Pm/z_en_pm.c

Co-authored-by: Derek Hensley 

* Update src/code/z_sub_s.c

Co-authored-by: Derek Hensley 

* review

* FindScheduleDoor

---------

Co-authored-by: Derek Hensley

BossHakugin (Goht) OK and documented, EnHakurock documented, other assorted documentation (#1599)

2024-02-02T04:10:48+00:00

* Fix struct

* 20/79 OK

* BossHakugin_Draw OK

* func_80B0D69C OK

* func_80B0D2B8 OK

* func_80B0D750 OK

* Shadow function docs

* Fix some non-matchings

* Apparently this matches now? It didn't before

* OverrideLimbDraw OK

* BossHakugin_PostLimbDraw

* Animation Cleanup: En_G* (#1395)

* wip

* more cleanup

* more cleanup

* one more thing

* one more default case

* missed brackets

* PR Review

* add more matches and fill stuct

* 3 more Draw functions

* func_80B0E5A4

* Finshed the Draw functions

* Small cleanup

* Most of the death-handling code done

* more matching

* functions

* Goht collab (#9)

* Animation Cleanup: En_G* (#1395)

* wip

* more cleanup

* more cleanup

* one more thing

* one more default case

* missed brackets

* PR Review

* z_message_nes (1 NON_MATCHING) (#1394)

* Bring over progress

* Some docs

* scratch urls + format

* Fixes

* Match Message_DrawTextNES

* String macros

* color structs

* Document object_mk (#1389)

* Updated object_mk animation, limb, and skeleton names

* Updated object_mk texture and DList names

* Added comment to object_mk.xml

* Remove "ing" from Anim names

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

* Update z_en_mk.c to not use "ing" in names

* Running formatter

---------

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

* Player Docs: Initial framework for "Action Change Lists" (#1397)

* copy fig docs

* adjust wording

* another fix

* fix bool

* PR Suggestion

* Animation Cleanup: En_H* (#1399)

* begin H

* more cleanup

* Animation Cleanup: En_I* (#1400)

* cleanup I

* oops

* Start Player Item Docs (#1396)

* Copy Fig Docs

* small cleanup

* ItemChangeType comment

* bool

* item change comments

* PR Review

* rm comments

* Animation Cleanup: En_K* (#1402)

* cleanup k

* one more name

* Animation Cleanup: En_J* (#1401)

* cleanup J

* small fix

* functions

---------

Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: Derek Hensley 
Co-authored-by: Zach North 
Co-authored-by: petrie911 

* hotfix

* all functions decomped

* all functions decomped

* Now with more data

* small fix

* another small fix

* ok last small fix I swear

* cleanup

* func_80B0A8C4 OK

* func_80B0D9CC OK

* Use generated reloc for Goht + remove Goht's undefined_syms

* Bodyparts + other clean up

* cleanup

* oops

* fix merge

* begin docs

* fix merge

* cutscene docs

* effects docs

* small docs

* Document colliders

* Odds and ends in the struct

* Name some functions

* Name two functions

* Some action functions and other odds and ends

* Name the lightning segments and electric ball functions correctly

* Names and other cleanup

* Start on hakurock + more cleanup

* Name all hakurock functions

* Name hakurock effects + create a GET_TYPE macro for it

* Finish documenting Hakurock

* Name one more function in BossHakugin

* Name a few more things

* Name a lot of struct vars

* Wall-related stuff

* Fix some fake matches

* Name a couple more struct vars

* Document some more of the struct

* Name the limb flag stuff

* Name the last unnamed struct vars

* Name the horn colliders correctly

* Some initial work on documenting data

* Some function documentation

* A couple of cleanups

* Finish documenting BossHakugin_UpdateBaseRot

* Name BossHakugin_SetLightningSegmentColliderVertices

* Document BossHakugin_AddLightningSegments

* Document BossHakugin_RunUpdateCommon and related functions

* Document BossHakugin_AddMalfunctionEffects

* Document BossHakugin_StepVectorToTarget

* Rename to BossHakugin_StepVector

* Finish documenting BossHakugin_AddMalfunctionEffects for now, might come back later though

* Document BossHakugin_UpdateSubCam

* Document BossHakugin_Thaw

* Document BossHakugin_ChargeUpAttack

* Some scattered docs

* Finish documenting the top "library" functions

* Document intro cutscene functions

* Document running and charging

* Document downed

* Document throwing

* Document remaining non-death action functions

* Document most of the death cutscene

* Get started on documenting crushing rocks

* Separate out the crushing rocks into their own struct

* Document the ExplosionLimbHideInfo

* Finish documenting BossHakugin_DeathCutsceneCrushedByRocks

* Almost done with rocks I think

* Port over Odolwa shadow documentation

* Finish documenting draw functions

* Finish documenting BossHakugin_Update

* Name variables in BossHakugin_UpdateElectricBalls

* Document BossHakugin_CheckForBodyColliderHit

* Finish documenting BossHakugin_UpdateDamage

* I've convinced myself these names are fine

* Almost finish documenting every update function

* Remove TODOs from the header

* Finish documenting the C file

* Delete duplicate define

* Finish variables.txt for Goht

* Undo change that desync'd z_eff_ss_fhg_flash.h from other effect headers

* Missed a THIS

* Some low-hanging review responses

* Add comment explaining something in BossHakugin_ShouldWait

* Match BossHakugin_SpawnLargeStalactiteWalls using a for-loop

* Create GOHT_ELECTRIC_BALL_COUNT_MAX constant

* vector -> norm and targetVector -> targetNorm

* Add TODO comments for dynamic shadow functions

---------

Co-authored-by: Derek Hensley 
Co-authored-by: engineer124 <47598039+engineer124@users.noreply.github.com>
Co-authored-by: Parker B <20159000+jpburnett@users.noreply.github.com>
Co-authored-by: petrie911 
Co-authored-by: petrie911 <69443847+petrie911@users.noreply.github.com>
Co-authored-by: Zach North 
Co-authored-by: engineer124

Object Cleanup (#1410)

2023-10-05T20:37:52+00:00

* object cleanup

* namefixer

* objectPtr

* PR Review

* PR Review

* more uses of macro

* missed another one

Talk Exchange System Docs (#1312)

2023-07-31T23:40:12+00:00

* Fix typo

* PLAYER_IA_HELD

* Actor offer exchange item functions

* SubS_OfferExchangeItemCustom

* SubS_OfferItem + enum

* Actors that use Subs_OfferItem

* SubS_OfferExchangeItemFacing

* Comments

* Format

* Better comment

* EnRg

* function names and comments

* Split enum

* exchangeItemId -> exchangeItemAction

* namefixer

* PR comments

* Missed a comment

* Max -> Mask

* SubS_SetOfferMode

* Some more comments updating

* rg comment

* PLAYER_IA_CONTINUE

* Revert back to PLAYER_IA_MINUS1

* Comment typos/grammar

* Verify functions

* yawRange

* Actor_OfferTalkNearby

* Actor_OfferTalkExchangeEquiCylinder

* format

* Actor_OfferTalkNearColChkInfoCylinder

* OfferTalk comments

* Actor_OfferTalkExchange comment enum

* format

Fidget Tables Docs (#1316)

2023-07-06T21:54:43+00:00

* Docs for SubS_FillLimbRotTables and Actor_FillLimbRotTables

* Fidget

* Format

* ///

* UpdateFidgetTables

* Clarify comment

* Adjust comments slightly

* Update src/code/z_actor.c

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

* Update src/code/z_sub_s.c

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

---------

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

Some pathing docs (#1205)

2023-06-05T02:46:39+00:00

* Some pathing docs

* Missed one

* Uno mas

* Uno mas x2

* Cleanup

* fix

* namefixer

* NULL

* More

* PR

* Actually remove SQ

* -1 define, plus some more pathing cleanup

* Actor macros instead

* Format

* ADDITIONAL_PATH_INDEX_NONE

* Remove reliance on PATH_INDEX_NONE

* Missed some PathIndex cleanup

* Review

* format

Cutscene Documentation (z_eventmgr.c OK) (#1164)

2023-04-19T17:52:00+00:00

* begin cutscene docs

* more docs

* more docs

* z_eventmgr.c OK

Co-authored-by: Thar0 

* cutscene camera

* commands WIP

* more docs

* merge master

* csId, oof

* more cleanup

* more docs, csCam

* more cleanup

* more docs

* more

* cleanup functions.h

* better misc cmd docs

* apply discord discussions

* small adjustment

* more cleanup

* more docs

* more cleanup

* more cs cam docs

* small fix

* cmd cleanup

* small cleanup

* better match, thanks anon

* remove last return

* PR suggestions, small cleanup

* next PR review

* rm internal funcs from functions.h

* more PR

* add comment

* csCam interp typedef handler

* cleanup, scene cmd

* missed an enum use

* ActorCutscene -> CutsceneManager, PR Suggestions

* more PR Suggestions

* more actorCutscene cleanup

* R_USE_DEBUG_CUTSCENE

* more small docs

* move functions to cutscene.h

* PlayerCsId

* fix bss

* missed some function headers

* more scene cleanup

* more scene cleanup

* missed one

* CS_SPAWN_FLAGS

* wrong usage of macro

* more cleanup

* name last cs transition types

* IsNext bool

* update namefixer

* fix namefixer

* more cleanup

* add comment

* fixed enums for motion blur

* consistent cutscene lists

* cutscene entry func consistent

* PR Suggestion

* fig review

* fix additionalCsId name in actor

* more pr review

* bss

---------

Co-authored-by: Thar0 
Co-authored-by: angie

Misc Cleanup 14 (#1214)

2023-03-21T14:12:22+00:00

* bgId

* z64scene.h whitespace

* SubS_ComputeTrackPointRot casts

* Macros cleanup

* ifs

* Empty Loops

* Lights_FindBufSlot void

* SkelAnime_GetFrameData

* };

* Struct inits

* fs

* @todo

* Bug comments

* EnPofusen and ObjUm

* Trailing comma

* Revert "bgId"

This reverts commit eea073c5ac30fd41f50436eeade43a811d0f0981.

* Revert "z64scene.h whitespace"

This reverts commit 399fd57550b7536b357ab6283360042f2e3e1467.

* Revert "SubS_ComputeTrackPointRot casts"

This reverts commit dea896c8743475508a3c7391e9d19cdb6b63f6a7.

* FAKE

* Review

* Format