Document object_boss03 (#559)

* Document object_boss03

* Actually run ./format.sh

* Preserve ordering

* Move Tanron3 limb enum to object

* Don't name the limb enum after the actor

1 files changed, 134 insertions, 89 deletions

diff --git a/assets/xml/objects/object_boss03.xml b/assets/xml/objects/object_boss03.xml
index 14d7d3498..5cf4ad2b8 100644
--- a/assets/xml/objects/object_boss03.xml
+++ b/assets/xml/objects/object_boss03.xml
@@ -1,93 +1,138 @@
 <Root>
+    <!-- 
+        Gyorg, his title card, the small fishes he summons, the seaweed in his boss arena,
+        and the bubbles in his intro cutscene. Also contains an unused copy of Majora's Wrath's
+        whip assets, along with an unused duplicate of the small fishes.
+    -->
     <File Name="object_boss03" Segment="6">
-        <Animation Name="object_boss03_Anim_000088" Offset="0x88" />
-        <Texture Name="object_boss03_Tex_0000A0" OutName="tex_0000A0" Format="rgba16" Width="8" Height="16" Offset="0xA0" />
-        <DList Name="object_boss03_DL_000200" Offset="0x200" />
-        <DList Name="object_boss03_DL_000278" Offset="0x278" />
-        <DList Name="object_boss03_DL_0002A8" Offset="0x2A8" />
-        <DList Name="object_boss03_DL_003398" Offset="0x3398" />
-        <DList Name="object_boss03_DL_003A78" Offset="0x3A78" />
-        <DList Name="object_boss03_DL_003E38" Offset="0x3E38" />
-        <DList Name="object_boss03_DL_003FB8" Offset="0x3FB8" />
-        <DList Name="object_boss03_DL_0042D0" Offset="0x42D0" />
-        <DList Name="object_boss03_DL_004450" Offset="0x4450" />
-        <DList Name="object_boss03_DL_004768" Offset="0x4768" />
-        <DList Name="object_boss03_DL_004AC0" Offset="0x4AC0" />
-        <DList Name="object_boss03_DL_005010" Offset="0x5010" />
-        <!-- <Blob Name="object_boss03_Blob_005388" Size="0x8" Offset="0x5388" /> -->
-        <Texture Name="object_boss03_TLUT_005390" OutName="tlut_005390" Format="rgba16" Width="4" Height="4" Offset="0x5390" />
-        <Texture Name="object_boss03_TLUT_0053B0" OutName="tlut_0053B0" Format="rgba16" Width="4" Height="4" Offset="0x53B0" />
-        <Texture Name="object_boss03_TLUT_0053D0" OutName="tlut_0053D0" Format="rgba16" Width="4" Height="4" Offset="0x53D0" />
-        <Texture Name="object_boss03_TLUT_0053F0" OutName="tlut_0053F0" Format="rgba16" Width="4" Height="4" Offset="0x53F0" />
-        <Texture Name="object_boss03_Tex_005410" OutName="tex_005410" Format="rgba16" Width="32" Height="32" Offset="0x5410" />
-        <Texture Name="object_boss03_Tex_005C10" OutName="tex_005C10" Format="ci4" Width="64" Height="64" Offset="0x5C10" />
-        <Texture Name="object_boss03_Tex_006410" OutName="tex_006410" Format="ci4" Width="64" Height="64" Offset="0x6410" />
-        <Texture Name="object_boss03_Tex_006C10" OutName="tex_006C10" Format="ci4" Width="64" Height="64" Offset="0x6C10" />
-        <Texture Name="object_boss03_Tex_007410" OutName="tex_007410" Format="ci4" Width="64" Height="64" Offset="0x7410" />
-        <Texture Name="object_boss03_Tex_007C10" OutName="tex_007C10" Format="rgba16" Width="16" Height="16" Offset="0x7C10" />
-        <DList Name="object_boss03_DL_007E50" Offset="0x7E50" />
-        <DList Name="object_boss03_DL_007EB0" Offset="0x7EB0" />
-        <!-- <Blob Name="object_boss03_Blob_007EC8" Size="0x1400" Offset="0x7EC8" /> -->
-        <Limb Name="object_boss03_Standardlimb_0092C8" Type="Standard" Offset="0x92C8" />
-        <Limb Name="object_boss03_Standardlimb_0092D4" Type="Standard" Offset="0x92D4" />
-        <Limb Name="object_boss03_Standardlimb_0092E0" Type="Standard" Offset="0x92E0" />
-        <Limb Name="object_boss03_Standardlimb_0092EC" Type="Standard" Offset="0x92EC" />
-        <Limb Name="object_boss03_Standardlimb_0092F8" Type="Standard" Offset="0x92F8" />
-        <Limb Name="object_boss03_Standardlimb_009304" Type="Standard" Offset="0x9304" />
-        <Limb Name="object_boss03_Standardlimb_009310" Type="Standard" Offset="0x9310" />
-        <Limb Name="object_boss03_Standardlimb_00931C" Type="Standard" Offset="0x931C" />
-        <Limb Name="object_boss03_Standardlimb_009328" Type="Standard" Offset="0x9328" />
-        <Limb Name="object_boss03_Standardlimb_009334" Type="Standard" Offset="0x9334" />
-        <Limb Name="object_boss03_Standardlimb_009340" Type="Standard" Offset="0x9340" />
-        <Limb Name="object_boss03_Standardlimb_00934C" Type="Standard" Offset="0x934C" />
-        <Limb Name="object_boss03_Standardlimb_009358" Type="Standard" Offset="0x9358" />
-        <Limb Name="object_boss03_Standardlimb_009364" Type="Standard" Offset="0x9364" />
-        <Skeleton Name="object_boss03_Skel_0093A8" Type="Flex" LimbType="Standard" Offset="0x93A8" />
-        <Animation Name="object_boss03_Anim_009554" Offset="0x9554" />
-        <Animation Name="object_boss03_Anim_0098F0" Offset="0x98F0" />
-        <Animation Name="object_boss03_Anim_0099D0" Offset="0x99D0" />
-        <Animation Name="object_boss03_Anim_009C14" Offset="0x9C14" />
-        <Animation Name="object_boss03_Anim_009CF8" Offset="0x9CF8" />
-        <Animation Name="object_boss03_Anim_00A020" Offset="0xA020" />
-        <Animation Name="object_boss03_Anim_00A134" Offset="0xA134" />
-        <Animation Name="object_boss03_Anim_00A6C8" Offset="0xA6C8" />
-        <DList Name="object_boss03_DL_00A8B0" Offset="0xA8B0" />
-        <DList Name="object_boss03_DL_00A948" Offset="0xA948" />
-        <DList Name="object_boss03_DL_00A978" Offset="0xA978" />
-        <DList Name="object_boss03_DL_00A9A8" Offset="0xA9A8" />
-        <DList Name="object_boss03_DL_00A9D8" Offset="0xA9D8" />
-        <DList Name="object_boss03_DL_00AA08" Offset="0xAA08" />
-        <Texture Name="object_boss03_TLUT_00AAC0" OutName="tlut_00AAC0" Format="rgba16" Width="4" Height="4" Offset="0xAAC0" />
-        <Texture Name="object_boss03_TLUT_00AAE0" OutName="tlut_00AAE0" Format="rgba16" Width="4" Height="4" Offset="0xAAE0" />
-        <Texture Name="object_boss03_Tex_00AB00" OutName="tex_00AB00" Format="ci4" Width="64" Height="64" Offset="0xAB00" />
-        <Texture Name="object_boss03_Tex_00B300" OutName="tex_00B300" Format="ci4" Width="64" Height="64" Offset="0xB300" />
-        <!-- <Blob Name="object_boss03_Blob_00BB00" Size="0x10" Offset="0xBB00" /> -->
-        <DList Name="object_boss03_DL_00BD80" Offset="0xBD80" />
-        <DList Name="object_boss03_DL_00BE40" Offset="0xBE40" />
-        <DList Name="object_boss03_DL_00BF20" Offset="0xBF20" />
-        <DList Name="object_boss03_DL_00BFD8" Offset="0xBFD8" />
-        <DList Name="object_boss03_DL_00C0A8" Offset="0xC0A8" />
-        <DList Name="object_boss03_DL_00C160" Offset="0xC160" />
-        <Texture Name="object_boss03_TLUT_00C230" OutName="tlut_00C230" Format="rgba16" Width="4" Height="4" Offset="0xC230" />
-        <Texture Name="object_boss03_Tex_00C250" OutName="tex_00C250" Format="ci4" Width="64" Height="64" Offset="0xC250" />
-        <DList Name="object_boss03_DL_00CCC0" Offset="0xCCC0" />
-        <DList Name="object_boss03_DL_00CD80" Offset="0xCD80" />
-        <DList Name="object_boss03_DL_00CE60" Offset="0xCE60" />
-        <DList Name="object_boss03_DL_00CF18" Offset="0xCF18" />
-        <DList Name="object_boss03_DL_00CFE8" Offset="0xCFE8" />
-        <DList Name="object_boss03_DL_00D0A0" Offset="0xD0A0" />
-        <Texture Name="object_boss03_TLUT_00D170" OutName="tlut_00D170" Format="rgba16" Width="4" Height="4" Offset="0xD170" />
-        <Texture Name="object_boss03_Tex_00D190" OutName="tex_00D190" Format="ci4" Width="64" Height="64" Offset="0xD190" />
-        <Limb Name="object_boss03_Standardlimb_00D990" Type="Standard" Offset="0xD990" />
-        <Limb Name="object_boss03_Standardlimb_00D99C" Type="Standard" Offset="0xD99C" />
-        <Limb Name="object_boss03_Standardlimb_00D9A8" Type="Standard" Offset="0xD9A8" />
-        <Limb Name="object_boss03_Standardlimb_00D9B4" Type="Standard" Offset="0xD9B4" />
-        <Limb Name="object_boss03_Standardlimb_00D9C0" Type="Standard" Offset="0xD9C0" />
-        <Limb Name="object_boss03_Standardlimb_00D9CC" Type="Standard" Offset="0xD9CC" />
-        <Limb Name="object_boss03_Standardlimb_00D9D8" Type="Standard" Offset="0xD9D8" />
-        <Limb Name="object_boss03_Standardlimb_00D9E4" Type="Standard" Offset="0xD9E4" />
-        <Limb Name="object_boss03_Standardlimb_00D9F0" Type="Standard" Offset="0xD9F0" />
-        <Skeleton Name="object_boss03_Skel_00DA20" Type="Flex" LimbType="Standard" Offset="0xDA20" />
-        <Animation Name="object_boss03_Anim_00DAAC" Offset="0xDAAC" />
+        <Animation Name="gGyorgIdleAnim" Offset="0x88" /> <!-- Original name is "bus_base". Maybe unused? -->
+
+        <!-- Unused Majora's Wrath Whip Texture -->
+        <Texture Name="gGyorgUnusedMajorasWrathWhipTex" OutName="unused_majoras_wrath_whip" Format="rgba16" Width="8" Height="16" Offset="0xA0" />
+
+        <!-- Unused Majora's Wrath Whip DisplayLists -->
+        <DList Name="gGyorgUnusedMajorasWrathWhipDL1" Offset="0x200" />
+        <DList Name="gGyorgUnusedMajorasWrathWhipDL2" Offset="0x278" />
+        <DList Name="gGyorgUnusedMajorasWrathWhipDL3" Offset="0x2A8" />
+
+        <!--Gyorg Limb DisplayLists -->
+        <DList Name="gGyorgHeadDL" Offset="0x3398" />
+        <DList Name="gGyorgJawDL" Offset="0x3A78" />
+        <DList Name="gGyorgUpperLeftFinDL" Offset="0x3E38" />
+        <DList Name="gGyorgLowerLeftFinDL" Offset="0x3FB8" />
+        <DList Name="gGyorgUpperRightFinDL" Offset="0x42D0" />
+        <DList Name="gGyorgLowerRightFinDL" Offset="0x4450" />
+        <DList Name="gGyorgUpperTrunkDL" Offset="0x4768" />
+        <DList Name="gGyorgLowerTrunkDL" Offset="0x4AC0" />
+        <DList Name="gGyorgTailDL" Offset="0x5010" />
+
+        <!-- Unused Empty Texture Animation -->
+        <TextureAnimation Name="gGyorgUnused5388TexAnim" Offset="0x5388" />
+
+        <!-- Gyorg Textures -->
+        <Texture Name="gGyorgFinsSpikesAndJawTLUT" OutName="gyorg_fins_spikes_and_jaw_tlut" Format="rgba16" Width="4" Height="4" Offset="0x5390" />
+        <Texture Name="gGyorgSidesTLUT" OutName="gyorg_sides_tlut" Format="rgba16" Width="4" Height="4" Offset="0x53B0" />
+        <Texture Name="gGyorgMouthAndSpikeBacksideTLUT" OutName="gyorg_mouth_and_spike_backside_tlut" Format="rgba16" Width="4" Height="4" Offset="0x53D0" />
+        <Texture Name="gGyorgBellyAndFinFleshTLUT" OutName="gyorg_belly_and_fin_flesh_tlut" Format="rgba16" Width="4" Height="4" Offset="0x53F0" />
+        <Texture Name="gGyorgEyeTex" OutName="gyorg_eye" Format="rgba16" Width="32" Height="32" Offset="0x5410" />
+        <Texture Name="gGyorgFinsSpikesAndJawTex" OutName="gyorg_fins_spikes_and_jaw" Format="ci4" Width="64" Height="64" Offset="0x5C10" />
+        <Texture Name="gGyorgSidesTex" OutName="gyorg_sides" Format="ci4" Width="64" Height="64" Offset="0x6410" />
+        <Texture Name="gGyorgMouthAndSpikeBacksideTex" OutName="gyorg_mouth_and_spike_backside" Format="ci4" Width="64" Height="64" Offset="0x6C10" />
+        <Texture Name="gGyorgBellyAndFinFleshTex" OutName="gyorg_belly_and_fin_flesh" Format="ci4" Width="64" Height="64" Offset="0x7410" />
+        <Texture Name="gGyorgHornsTeethAndClawsTex" OutName="gyorg_horns_teeth_claws" Format="rgba16" Width="16" Height="16" Offset="0x7C10" />
+
+        <!-- Bubble DisplayLists (texture comes from gameplay_keep) -->
+        <DList Name="gGyorgBubbleMaterialDL" Offset="0x7E50" />
+        <DList Name="gGyorgBubbleModelDL" Offset="0x7EB0" />
+
+        <!-- Gyorg Title Card -->
+        <Texture Name="gGyorgTitleCardTex" OutName="gyorg_title_card" Format="i8" Width="128" Height="40" Offset="0x7EC8" />
+
+        <!-- Gyorg Limbs -->
+        <Limb Name="gGyorgRootLimb" Type="Standard" Offset="0x92C8" />
+        <Limb Name="gGyorgHeadLimb" Type="Standard" Offset="0x92D4" />
+        <Limb Name="gGyorgBodyRootLimb" Type="Standard" Offset="0x92E0" />
+        <Limb Name="gGyorgUpperTrunkLimb" Type="Standard" Offset="0x92EC" />
+        <Limb Name="gGyorgLowerTrunkLimb" Type="Standard" Offset="0x92F8" />
+        <Limb Name="gGyorgTailLimb" Type="Standard" Offset="0x9304" />
+        <Limb Name="gGyorgRightFinRootLimb" Type="Standard" Offset="0x9310" />
+        <Limb Name="gGyorgUpperRightFinLimb" Type="Standard" Offset="0x931C" />
+        <Limb Name="gGyorgLowerRightFinLimb" Type="Standard" Offset="0x9328" />
+        <Limb Name="gGyorgLeftFinRootLimb" Type="Standard" Offset="0x9334" />
+        <Limb Name="gGyorgUpperLeftFinLimb" Type="Standard" Offset="0x9340" />
+        <Limb Name="gGyorgLowerLeftFinLimb" Type="Standard" Offset="0x934C" />
+        <Limb Name="gGyorgJawRootLimb" Type="Standard" Offset="0x9358" />
+        <Limb Name="gGyorgJawLimb" Type="Standard" Offset="0x9364" />
+
+        <!-- Gyorg Skeleton-->
+        <Skeleton Name="gGyorgSkel" Type="Flex" LimbType="Standard" Offset="0x93A8" />
+
+        <!-- Gyorg Animations -->
+        <Animation Name="gGyorgFloppingAnim" Offset="0x9554" /> <!-- Original name is "bus_dead" -->
+        <Animation Name="gGyorgJumpingAnim" Offset="0x98F0" /> <!-- Original name is "bus_jump". Maybe unused? -->
+        <Animation Name="gGyorgStunnedAnim" Offset="0x99D0" /> <!-- Original name is "bus_sibire" ("paralyzed") -->
+        <Animation Name="gGyorgBackingUpAnim" Offset="0x9C14" /> <!-- Original name is "bus_stop" -->
+        <Animation Name="gGyorgFastSwimmingAnim" Offset="0x9CF8" /> <!-- Original name is "bus_swim" -->
+        <Animation Name="gGyorgGentleSwimmingAnim" Offset="0xA020" /> <!-- Maybe unused? -->
+        <Animation Name="gGyorgTailSweepAnim" Offset="0xA134" /> <!-- Maybe unused? -->
+        <Animation Name="gGyorgCrawlingAnim" Offset="0xA6C8" />
+
+        <!-- Seaweed DisplayLists -->
+        <DList Name="gGyorgSeaweedPiece1DL" Offset="0xA8B0" />
+        <DList Name="gGyorgSeaweedPiece2DL" Offset="0xA948" />
+        <DList Name="gGyorgSeaweedPiece3DL" Offset="0xA978" />
+        <DList Name="gGyorgSeaweedPiece4DL" Offset="0xA9A8" />
+        <DList Name="gGyorgSeaweedPiece5DL" Offset="0xA9D8" />
+        <DList Name="gGyorgSeaweedTopDL" Offset="0xAA08" />
+
+        <!-- Seaweed Textures -->
+        <Texture Name="gGyorgSeaweedTopTLUT" OutName="gyorg_seaweed_top_tlut" Format="rgba16" Width="4" Height="4" Offset="0xAAC0" />
+        <Texture Name="gGyorgSeaweedTLUT" OutName="gyord_seaweed_tlut" Format="rgba16" Width="4" Height="4" Offset="0xAAE0" />
+        <Texture Name="gGyorgSeaweedTopTex" OutName="gyorg_seaweed_top" Format="ci4" Width="64" Height="64" Offset="0xAB00" />
+        <Texture Name="gGyorgSeaweedTex" OutName="gyorg_seaweed" Format="ci4" Width="64" Height="64" Offset="0xB300" />
+
+        <!-- Unused Empty Texture Animation -->
+        <TextureAnimation Name="gGyorgUnusedBB00TexAnim" Offset="0xBB00" />
+
+        <!-- Unused Duplicate of Small Fish Limb DisplayLists -->
+        <DList Name="gUnusedGyorgSmallFishHeadDL" Offset="0xBD80" />
+        <DList Name="gUnusedGyorgSmallFishTrunkDL" Offset="0xBE40" />
+        <DList Name="gUnusedGyorgSmallFishRightFinDL" Offset="0xBF20" />
+        <DList Name="gUnusedGyorgSmallFishDorsalFinDL" Offset="0xBFD8" />
+        <DList Name="gUnusedGyorgSmallFishLeftFinDL" Offset="0xC0A8" />
+        <DList Name="gUnusedGyorgSmallFishTailFinDL" Offset="0xC160" />
+
+        <!-- Unused Duplicate of Small Fish Textures -->
+        <Texture Name="gUnusedGyorgSmallFishTLUT" OutName="unused_small_fish_tlut" Format="rgba16" Width="4" Height="4" Offset="0xC230" />
+        <Texture Name="gUnusedGyorgSmallFishTex" OutName="unused_small_fish" Format="ci4" Width="64" Height="64" Offset="0xC250" />
+
+        <!-- Small Fishes Limb DisplayLists -->
+        <DList Name="gGyorgSmallFishHeadDL" Offset="0xCCC0" />
+        <DList Name="gGyorgSmallFishTrunkDL" Offset="0xCD80" />
+        <DList Name="gGyorgSmallFishRightFinDL" Offset="0xCE60" />
+        <DList Name="gGyorgSmallFishDorsalFinDL" Offset="0xCF18" />
+        <DList Name="gGyorgSmallFishLeftFinDL" Offset="0xCFE8" />
+        <DList Name="gGyorgSmallFishTailFinDL" Offset="0xD0A0" />
+
+        <!-- Small Fishes Textures -->
+        <Texture Name="gGyorgSmallFishTLUT" OutName="small_fish_tlut" Format="rgba16" Width="4" Height="4" Offset="0xD170" />
+        <Texture Name="gGyorgSmallFishTex" OutName="small_fish" Format="ci4" Width="64" Height="64" Offset="0xD190" />
+
+        <!-- Small Fishes Limbs -->
+        <Limb Name="gGyorgSmallFishRootLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_ROOT" Offset="0xD990" />
+        <Limb Name="gGyorgSmallFishBodyRootLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_BODY_ROOT" Offset="0xD99C" />
+        <Limb Name="gGyorgSmallFishTrunkRootLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_TRUNK_ROOT" Offset="0xD9A8" />
+        <Limb Name="gGyorgSmallFishTailFinLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_TAIL_FIN" Offset="0xD9B4" />
+        <Limb Name="gGyorgSmallFishTrunkLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_TRUNK" Offset="0xD9C0" />
+        <Limb Name="gGyorgSmallFishLeftFinLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_LEFT_FIN" Offset="0xD9CC" />
+        <Limb Name="gGyorgSmallFishDorsalFinLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_DORSAL_FIN" Offset="0xD9D8" />
+        <Limb Name="gGyorgSmallFishRightFinLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_RIGHT_FIN" Offset="0xD9E4" />
+        <Limb Name="gGyorgSmallFishHeadLimb" Type="Standard" EnumName="GYORG_SMALL_FISH_LIMB_HEAD" Offset="0xD9F0" />
+
+        <!-- Small Fishes Skeleton -->
+        <Skeleton Name="gGyorgSmallFishSkel" Type="Flex" LimbType="Standard" LimbNone="GYORG_SMALL_FISH_LIMB_NONE" LimbMax="GYORG_SMALL_FISH_LIMB_MAX" EnumName="GyorgSmallFishLimbs" Offset="0xDA20" />
+
+        <!-- Small Fishes Animation -->
+        <Animation Name="gGyorgSmallFishSwimAnim" Offset="0xDAAC" /> <!-- Original name is "minibus_b_swim" -->
     </File>
 </Root>