Documentation pass on WaterBox code (#1860)

* Documentation pass on WaterBox code

* format

* vtx flags, fix comments

* format

* Add function documentation comment
This commit is contained in:
mzxrules
2026-08-29 11:44:47 -04:00
committed by GitHub
parent 31b5e861b2
commit acffd6443f
55 changed files with 342 additions and 275 deletions
+6 -6
View File
@@ -590,15 +590,15 @@ asm/non_matchings/code/z_bgcheck/SurfaceType_IsHookshotSurface.s,SurfaceType_IsH
asm/non_matchings/code/z_bgcheck/SurfaceType_IsIgnoredByEntities.s,SurfaceType_IsIgnoredByEntities,0x800C9D14,0xF
asm/non_matchings/code/z_bgcheck/SurfaceType_IsIgnoredByProjectiles.s,SurfaceType_IsIgnoredByProjectiles,0x800C9D50,0xF
asm/non_matchings/code/z_bgcheck/SurfaceType_IsFloorConveyor.s,SurfaceType_IsFloorConveyor,0x800C9D8C,0x14
asm/non_matchings/code/z_bgcheck/func_800C9DDC.s,func_800C9DDC,0x800C9DDC,0xF
asm/non_matchings/code/z_bgcheck/SurfaceType_IsFloorDekuFlower.s,SurfaceType_IsFloorDekuFlower,0x800C9DDC,0xF
asm/non_matchings/code/z_bgcheck/SurfaceType_GetConveyorSpeed.s,SurfaceType_GetConveyorSpeed,0x800C9E18,0xA
asm/non_matchings/code/z_bgcheck/SurfaceType_GetConveyorDirection.s,SurfaceType_GetConveyorDirection,0x800C9E40,0x12
asm/non_matchings/code/z_bgcheck/SurfaceType_IsWallDamage.s,SurfaceType_IsWallDamage,0x800C9E88,0xD
asm/non_matchings/code/z_bgcheck/WaterBox_GetSurfaceImpl.s,WaterBox_GetSurfaceImpl,0x800C9EBC,0xBC
asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface1.s,WaterBox_GetSurface1,0x800CA1AC,0xF
asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface1_2.s,WaterBox_GetSurface1_2,0x800CA1E8,0x11
asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface2.s,WaterBox_GetSurface2,0x800CA22C,0xCF
asm/non_matchings/code/z_bgcheck/func_800CA568.s,func_800CA568,0x800CA568,0x33
asm/non_matchings/code/z_bgcheck/BgCheck_GetWaterSurface.s,BgCheck_GetWaterSurface,0x800C9EBC,0xBC
asm/non_matchings/code/z_bgcheck/BgCheck_GetWaterSurfaceNoBgIdAlt.s,BgCheck_GetWaterSurfaceNoBgIdAlt,0x800CA1AC,0xF
asm/non_matchings/code/z_bgcheck/BgCheck_GetWaterSurfaceNoBgId.s,BgCheck_GetWaterSurfaceNoBgId,0x800CA1E8,0x11
asm/non_matchings/code/z_bgcheck/BgCheck_FindWaterBox.s,BgCheck_FindWaterBox,0x800CA22C,0xCF
asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface.s,WaterBox_GetSurface,0x800CA568,0x33
asm/non_matchings/code/z_bgcheck/func_800CA634.s,func_800CA634,0x800CA634,0x5
asm/non_matchings/code/z_bgcheck/func_800CA648.s,func_800CA648,0x800CA648,0x1C
asm/non_matchings/code/z_bgcheck/WaterBox_GetSceneBgCamSetting.s,WaterBox_GetSceneBgCamSetting,0x800CA6B8,0x8
1 asm/non_matchings/code/z_en_a_keep/EnAObj_Init.s EnAObj_Init 0x800A5AC0 0x2B
590 asm/non_matchings/code/z_bgcheck/SurfaceType_IsIgnoredByEntities.s SurfaceType_IsIgnoredByEntities 0x800C9D14 0xF
591 asm/non_matchings/code/z_bgcheck/SurfaceType_IsIgnoredByProjectiles.s SurfaceType_IsIgnoredByProjectiles 0x800C9D50 0xF
592 asm/non_matchings/code/z_bgcheck/SurfaceType_IsFloorConveyor.s SurfaceType_IsFloorConveyor 0x800C9D8C 0x14
593 asm/non_matchings/code/z_bgcheck/func_800C9DDC.s asm/non_matchings/code/z_bgcheck/SurfaceType_IsFloorDekuFlower.s func_800C9DDC SurfaceType_IsFloorDekuFlower 0x800C9DDC 0xF
594 asm/non_matchings/code/z_bgcheck/SurfaceType_GetConveyorSpeed.s SurfaceType_GetConveyorSpeed 0x800C9E18 0xA
595 asm/non_matchings/code/z_bgcheck/SurfaceType_GetConveyorDirection.s SurfaceType_GetConveyorDirection 0x800C9E40 0x12
596 asm/non_matchings/code/z_bgcheck/SurfaceType_IsWallDamage.s SurfaceType_IsWallDamage 0x800C9E88 0xD
597 asm/non_matchings/code/z_bgcheck/WaterBox_GetSurfaceImpl.s asm/non_matchings/code/z_bgcheck/BgCheck_GetWaterSurface.s WaterBox_GetSurfaceImpl BgCheck_GetWaterSurface 0x800C9EBC 0xBC
598 asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface1.s asm/non_matchings/code/z_bgcheck/BgCheck_GetWaterSurfaceNoBgIdAlt.s WaterBox_GetSurface1 BgCheck_GetWaterSurfaceNoBgIdAlt 0x800CA1AC 0xF
599 asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface1_2.s asm/non_matchings/code/z_bgcheck/BgCheck_GetWaterSurfaceNoBgId.s WaterBox_GetSurface1_2 BgCheck_GetWaterSurfaceNoBgId 0x800CA1E8 0x11
600 asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface2.s asm/non_matchings/code/z_bgcheck/BgCheck_FindWaterBox.s WaterBox_GetSurface2 BgCheck_FindWaterBox 0x800CA22C 0xCF
601 asm/non_matchings/code/z_bgcheck/func_800CA568.s asm/non_matchings/code/z_bgcheck/WaterBox_GetSurface.s func_800CA568 WaterBox_GetSurface 0x800CA568 0x33
602 asm/non_matchings/code/z_bgcheck/func_800CA634.s func_800CA634 0x800CA634 0x5
603 asm/non_matchings/code/z_bgcheck/func_800CA648.s func_800CA648 0x800CA648 0x1C
604 asm/non_matchings/code/z_bgcheck/WaterBox_GetSceneBgCamSetting.s WaterBox_GetSceneBgCamSetting 0x800CA6B8 0x8