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
@@ -1083,15 +1083,15 @@ SurfaceType_IsHookshotSurface = 0x800CB80C; // type:func size:0x28
SurfaceType_IsIgnoredByEntities = 0x800CB834; // type:func size:0x3C
SurfaceType_IsIgnoredByProjectiles = 0x800CB870; // type:func size:0x3C
SurfaceType_IsFloorConveyor = 0x800CB8AC; // type:func size:0x54
func_800C9DDC = 0x800CB900; // type:func size:0x3C
SurfaceType_IsFloorDekuFlower = 0x800CB900; // type:func size:0x3C
SurfaceType_GetConveyorSpeed = 0x800CB93C; // type:func size:0x28
SurfaceType_GetConveyorDirection = 0x800CB964; // type:func size:0x48
SurfaceType_IsWallDamage = 0x800CB9AC; // type:func size:0x34
WaterBox_GetSurfaceImpl = 0x800CB9E0; // type:func size:0x2F0
WaterBox_GetSurface1 = 0x800CBCD0; // type:func size:0x3C
WaterBox_GetSurface1_2 = 0x800CBD0C; // type:func size:0x44
WaterBox_GetSurface2 = 0x800CBD50; // type:func size:0x33C
func_800CA568 = 0x800CC08C; // type:func size:0xCC
BgCheck_GetWaterSurface = 0x800CB9E0; // type:func size:0x2F0
BgCheck_GetWaterSurfaceNoBgIdAlt = 0x800CBCD0; // type:func size:0x3C
BgCheck_GetWaterSurfaceNoBgId = 0x800CBD0C; // type:func size:0x44
BgCheck_FindWaterBox = 0x800CBD50; // type:func size:0x33C
WaterBox_GetSurface = 0x800CC08C; // type:func size:0xCC
WaterBox_GetBgCamIndex = 0x800CC158; // type:func size:0x14
WaterBox_GetBgCamSetting = 0x800CC16C; // type:func size:0x70
WaterBox_GetSceneBgCamSetting = 0x800CC1DC; // type:func size:0x20
+6 -6
View File
@@ -1073,15 +1073,15 @@ SurfaceType_IsHookshotSurface = 0x800C9CEC; // type:func
SurfaceType_IsIgnoredByEntities = 0x800C9D14; // type:func
SurfaceType_IsIgnoredByProjectiles = 0x800C9D50; // type:func
SurfaceType_IsFloorConveyor = 0x800C9D8C; // type:func
func_800C9DDC = 0x800C9DDC; // type:func
SurfaceType_IsFloorDekuFlower = 0x800C9DDC; // type:func
SurfaceType_GetConveyorSpeed = 0x800C9E18; // type:func
SurfaceType_GetConveyorDirection = 0x800C9E40; // type:func
SurfaceType_IsWallDamage = 0x800C9E88; // type:func
WaterBox_GetSurfaceImpl = 0x800C9EBC; // type:func
WaterBox_GetSurface1 = 0x800CA1AC; // type:func
WaterBox_GetSurface1_2 = 0x800CA1E8; // type:func
WaterBox_GetSurface2 = 0x800CA22C; // type:func
func_800CA568 = 0x800CA568; // type:func
BgCheck_GetWaterSurface = 0x800C9EBC; // type:func
BgCheck_GetWaterSurfaceNoBgIdAlt = 0x800CA1AC; // type:func
BgCheck_GetWaterSurfaceNoBgId = 0x800CA1E8; // type:func
BgCheck_FindWaterBox = 0x800CA22C; // type:func
WaterBox_GetSurface = 0x800CA568; // type:func
WaterBox_GetBgCamIndex = 0x800CA634; // type:func
WaterBox_GetBgCamSetting = 0x800CA648; // type:func
WaterBox_GetSceneBgCamSetting = 0x800CA6B8; // type:func