mm/include
Tom Overton 5684c79312
BossHakugin (Goht) OK and documented, EnHakurock documented, other assorted documentation (#1599)
* 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 <hensley.derek58@gmail.com>
Co-authored-by: Zach North <zrnorth@gmail.com>
Co-authored-by: petrie911 <pmontag@Monday.localdomain>

* 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 <hensley.derek58@gmail.com>
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 <pmontag@Monday.localdomain>
Co-authored-by: petrie911 <69443847+petrie911@users.noreply.github.com>
Co-authored-by: Zach North <zrnorth@gmail.com>
Co-authored-by: engineer124 <engineer124engineer124@gmail.com>
2024-02-02 15:10:48 +11:00
..
PR General Cleanup 3 (#1543) 2024-01-29 10:51:59 -03:00
audio Introduce Audio `reverb.h` (#1511) 2023-11-24 12:03:38 +11:00
libc Organize `libc` and `libm` files (#1499) 2023-11-28 13:01:14 +11:00
libc64 Organize `libc64` files (#1492) 2023-11-27 12:01:42 +11:00
tables Dmadata Migration (#1526) 2024-01-14 13:04:53 -03:00
CIC6105.h Cleanup pass for CIC6105.c (#1371) 2023-09-24 19:23:44 +10:00
alignment.h Match `Environment_DrawSkyboxStarsImpl` (z_kankyo OK), introduce `rand.h` (#1476) 2023-11-10 10:28:16 +11:00
attributes.h Yet another libultra cleanup (#1384) 2023-10-26 10:44:27 -03:00
audiomgr.h Irqmgr + scheduler Docs (#1527) 2024-01-20 20:47:00 -03:00
audiothread_cmd.h Enable `-Wint-conversion` warning (#1266) 2023-11-02 10:07:38 +11:00
buffers.h Move the system heap and the framebuffers to their own segments (#1488) 2023-11-26 09:47:21 -03:00
build.h Cleanup pass for CIC6105.c (#1371) 2023-09-24 19:23:44 +10:00
carthandle.h Small boot cleanup (#1475) 2023-11-10 10:08:21 +11:00
color.h Match `Environment_DrawSkyboxStarsImpl` (z_kankyo OK), introduce `rand.h` (#1476) 2023-11-10 10:28:16 +11:00
command_macros_base.h `z_demo` with 4 NON_MATCHINGs (#514) 2022-03-04 19:14:52 -05:00
debug.h Move libultra function declarations to libultra headers (#1196) 2023-09-02 15:34:29 -04:00
fault.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
fault_internal.h Port OoT's docs for `fault.c` and `fault_drawer.c` (#1199) 2023-07-08 14:41:25 -04:00
functions.h A higher level language for schedule scripts (#1462) 2024-02-01 09:50:32 -03:00
gamealloc.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
gfx.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
gfxprint.h General Cleanup 3 (#1543) 2024-01-29 10:51:59 -03:00
global.h Yet another header cleanup (#1284) 2023-06-18 16:43:47 +10:00
ichain.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
idle.h Idle + Main bss and cleanup (#1292) 2023-06-26 10:18:50 +10:00
irqmgr.h Irqmgr + scheduler Docs (#1527) 2024-01-20 20:47:00 -03:00
kanread.h Extract Kanji + some adjacent docs (#1536) 2024-01-21 12:47:27 +11:00
listalloc.h PreRender.c OK (#1320) 2023-09-15 19:34:16 -03:00
loadfragment.h Enable `-Wint-conversion` warning (#1266) 2023-11-02 10:07:38 +11:00
macro.inc ABI FPR names (#767) 2022-03-31 18:22:19 +01:00
macros.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
main.h Irqmgr + scheduler Docs (#1527) 2024-01-20 20:47:00 -03:00
message_data_fmt_nes.h Text Extraction + some Message Docs (#1530) 2024-01-19 21:16:57 -03:00
message_data_fmt_staff.h Text Extraction + some Message Docs (#1530) 2024-01-19 21:16:57 -03:00
message_data_static.h Text Extraction + some Message Docs (#1530) 2024-01-19 21:16:57 -03:00
padmgr.h Move libultra function declarations to libultra headers (#1196) 2023-09-02 15:34:29 -04:00
padutils.h General Cleanup (#1529) 2024-01-15 10:03:13 +11:00
prevent_bss_reordering.h Color_RGBAu32 (#253) 2021-08-15 10:56:20 -04:00
prevent_bss_reordering2.h `z64vi*.h` and `sys_cfb.h` headers (#1259) 2023-08-09 19:44:31 -04:00
regs.h `z_en_test7.c` Documentation Pass (#1497) 2023-11-27 21:21:52 +11:00
scheduler.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
segment_symbols.h Move the system heap and the framebuffers to their own segments (#1488) 2023-11-26 09:47:21 -03:00
seqcmd.h Audio `sequence.c` OK and documented (#1201) 2023-03-30 19:53:47 +11:00
sequence.h Cleanup External Audio Headers (#1520) 2023-11-29 14:18:09 -03:00
sfx.h Cleanup External Audio Headers (#1520) 2023-11-29 14:18:09 -03:00
slowly.h Slowly Cleanup (#1213) 2023-03-20 00:48:49 +11:00
stack.h Stack cleanups (#1193) 2023-03-08 15:25:51 -03:00
stackcheck.h `stackcheck.h` (#1204) 2023-04-18 17:50:34 -04:00
sys_cfb.h `z64vi*.h` and `sys_cfb.h` headers (#1259) 2023-08-09 19:44:31 -04:00
sys_flashrom.h Enable `-Wint-conversion` warning (#1266) 2023-11-02 10:07:38 +11:00
sys_matrix.h Format Script Update (#904) 2022-10-04 04:06:04 +01:00
system_heap.h Docs Cleanup (#1153) 2023-05-29 13:04:07 +10:00
tha.h Enable `-Wint-conversion` warning (#1266) 2023-11-02 10:07:38 +11:00
thga.h THA docs (#1177) 2023-03-24 14:38:04 -03:00
ultra64.h Yet another libultra cleanup (#1384) 2023-10-26 10:44:27 -03:00
unk.h `z_demo` with 4 NON_MATCHINGs (#514) 2022-03-04 19:14:52 -05:00
variables.h A higher level language for schedule scripts (#1462) 2024-02-01 09:50:32 -03:00
viconfig.h General Cleanup (#1529) 2024-01-15 10:03:13 +11:00
vt.h Overhaul the build system (#234) 2021-08-03 23:21:31 -04:00
yaz0.h General Cleanup (#1529) 2024-01-15 10:03:13 +11:00
z64.h Organize `libc64` files (#1492) 2023-11-27 12:01:42 +11:00
z64actor.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
z64animation.h Player doc: anim wrappers (#1434) 2023-11-18 23:55:04 +11:00
z64animation_legacy.h Yet another header cleanup (#1284) 2023-06-18 16:43:47 +10:00
z64audio.h Cleanup External Audio Headers (#1520) 2023-11-29 14:18:09 -03:00
z64bgcheck.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
z64bombers_notebook.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
z64camera.h `code_80140E80` OK and preliminary documentation, Fbdemo_Wipe4 OK and documented (#1106) 2023-10-26 17:42:24 +11:00
z64collision_check.h Boss01 (Odolwa) OK and documented (#1452) 2023-10-29 08:29:43 +11:00
z64curve.h Update ZAPD (#1533) 2024-01-14 12:34:50 -03:00
z64cutscene.h Update ZAPD (#1533) 2024-01-14 12:34:50 -03:00
z64cutscene_commands.h Update ZAPD (#1533) 2024-01-14 12:34:50 -03:00
z64debug_display.h Debug mode (#1185) 2023-03-08 00:06:49 -05:00
z64debug_text.h Debug mode (#1185) 2023-03-08 00:06:49 -05:00
z64dma.h Dmadata Migration (#1526) 2024-01-14 13:04:53 -03:00
z64door.h Object Cleanup (#1410) 2023-10-05 17:37:52 -03:00
z64eff_blure.h Split effect headers and a bit of cleanup (#1482) 2023-11-27 12:24:46 -03:00
z64eff_footmark.h `z_eff_footmark` cleanup (#1180) 2023-02-27 17:56:04 -05:00
z64eff_shield_particle.h Split effect headers and a bit of cleanup (#1482) 2023-11-27 12:24:46 -03:00
z64eff_spark.h Split effect headers and a bit of cleanup (#1482) 2023-11-27 12:24:46 -03:00
z64eff_ss_dead.h Split effect headers and a bit of cleanup (#1482) 2023-11-27 12:24:46 -03:00
z64eff_tire_mark.h Split effect headers and a bit of cleanup (#1482) 2023-11-27 12:24:46 -03:00
z64effect.h Split effect headers and a bit of cleanup (#1482) 2023-11-27 12:24:46 -03:00
z64effect_ss.h Split effect headers and a bit of cleanup (#1482) 2023-11-27 12:24:46 -03:00
z64environment.h `z_en_test4.c` Documented (#1498) 2023-11-25 17:34:33 +11:00
z64frameadvance.h Move libultra function declarations to libultra headers (#1196) 2023-09-02 15:34:29 -04:00
z64game.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
z64game_over.h `z64game_over.h` (#1183) 2023-03-24 15:29:54 -03:00
z64horse.h `z_horse.c` OK (#1245) 2023-06-01 15:11:11 -04:00
z64interface.h Yet another header cleanup (#1284) 2023-06-18 16:43:47 +10:00
z64item.h Z_message (2 NON_MATCHINGS) (#1398) 2023-10-04 08:51:45 +11:00
z64jpeg.h Move libultra function declarations to libultra headers (#1196) 2023-09-02 15:34:29 -04:00
z64lib.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
z64light.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
z64malloc.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
z64map.h z_map_exp OK and somewhat documented (#877) 2022-07-11 23:23:01 -04:00
z64math.h ObjMure2 OK and documented (#1525) 2024-01-14 15:36:22 -03:00
z64message.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
z64object.h Port Proposed OoT Object Docs (#1361) 2023-10-04 14:01:04 +11:00
z64ocarina.h Cleanup External Audio Headers (#1520) 2023-11-29 14:18:09 -03:00
z64player.h General Cleanup (#1529) 2024-01-15 10:03:13 +11:00
z64prerender.h PreRender.c OK (#1320) 2023-09-15 19:34:16 -03:00
z64quake.h `code_80140E80` OK and preliminary documentation, Fbdemo_Wipe4 OK and documented (#1106) 2023-10-26 17:42:24 +11:00
z64rumble.h Move libultra function declarations to libultra headers (#1196) 2023-09-02 15:34:29 -04:00
z64save.h BossHakugin (Goht) OK and documented, EnHakurock documented, other assorted documentation (#1599) 2024-02-02 15:10:48 +11:00
z64scene.h Update ZAPD (#1533) 2024-01-14 12:34:50 -03:00
z64schedule.h A higher level language for schedule scripts (#1462) 2024-02-01 09:50:32 -03:00
z64shrink_window.h `z64game_over.h` (#1183) 2023-03-24 15:29:54 -03:00
z64skin.h General Cleanup (#1529) 2024-01-15 10:03:13 +11:00
z64skin_matrix.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
z64skybox.h Skybox Docs (#1534) 2024-01-14 15:56:19 -03:00
z64snap.h Misc cleanup 13 (#1189) 2023-03-07 23:44:18 -05:00
z64sound_source.h Yet another header cleanup (#1284) 2023-06-18 16:43:47 +10:00
z64speed_meter.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
z64subs.h BossHakugin (Goht) OK and documented, EnHakurock documented, other assorted documentation (#1599) 2024-02-02 15:10:48 +11:00
z64thread.h Dmadata Migration (#1526) 2024-01-14 13:04:53 -03:00
z64transition.h Yet another header cleanup (#1508) 2023-11-23 13:55:05 +11:00
z64view.h Speedmeter OK (#1393) 2023-10-03 15:52:41 +11:00
z64vimode.h `z64vi*.h` and `sys_cfb.h` headers (#1259) 2023-08-09 19:44:31 -04:00
z64vis.h Framebuffer filter docs (#1528) 2024-01-20 21:04:28 -03:00
z64visfbuf.h `code_80140E80` OK and preliminary documentation, Fbdemo_Wipe4 OK and documented (#1106) 2023-10-26 17:42:24 +11:00
z64voice.h General Cleanup 2 (#1538) 2024-01-28 21:27:50 -03:00
z_en_hy_code.h Text Extraction + some Message Docs (#1530) 2024-01-19 21:16:57 -03:00
z_fireobj.h Misc Cleanup 3 (#1268) 2023-06-06 08:57:45 +10:00
z_prenmi.h `z64game.h` (#1250) 2023-06-06 08:54:18 -04:00
z_title_setup.h `z64game.h` (#1250) 2023-06-06 08:54:18 -04:00