Documentation pass on WaterBox code (#1860)

* Documentation pass on WaterBox code

* format

* vtx flags, fix comments

* format

* Add function documentation comment

tools/disasm/n64-jp-1.1/functions.txt

@@ -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

tools/disasm/n64-us/functions.txt

@@ -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

tools/namefixer.py

@@ -572,10 +572,10 @@ wordReplace = {
     "func_800C9E18": "SurfaceType_GetConveyorSpeed",
     "func_800C9E40": "SurfaceType_GetConveyorDirection",
     "func_800C9E88": "SurfaceType_IsWallDamage",
-    "func_800C9EBC": "WaterBox_GetSurfaceImpl",
-    "func_800CA1AC": "WaterBox_GetSurface1",
-    "func_800CA1E8": "WaterBox_GetSurface1_2",
-    "func_800CA22C": "WaterBox_GetSurface2",
+    "func_800C9EBC": "BgCheck_GetWaterSurface",
+    "func_800CA1AC": "BgCheck_GetWaterSurfaceNoBgIdAlt",
+    "func_800CA1E8": "BgCheck_GetWaterSurfaceNoBgId",
+    "func_800CA22C": "BgCheck_FindWaterBox",
     "func_800CA6D8": "WaterBox_GetLightSettingIndex",
 
     "func_8017D668": "Math3D_PointDistSqToLine2DImpl",

tools/sizes/code_functions.csv

@@ -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