From 2cb423d9ec62072f9ba2d360a3efddbab85d0f16 Mon Sep 17 00:00:00 2001
From: Derek Hensley <hensley.derek58@gmail.com>
Date: Fri, 21 Oct 2022 16:57:49 -0700
Subject: [PATCH] Document object_os (#1414)

---
 assets/xml/objects/object_os.xml              | 71 ++++++++++---------
 src/overlays/actors/ovl_Demo_Ec/z_demo_ec.c   |  4 +-
 src/overlays/actors/ovl_En_Ossan/z_en_ossan.c | 18 +++--
 3 files changed, 53 insertions(+), 40 deletions(-)

diff --git a/assets/xml/objects/object_os.xml b/assets/xml/objects/object_os.xml
index 7c3029443c..d98b3a0f52 100644
--- a/assets/xml/objects/object_os.xml
+++ b/assets/xml/objects/object_os.xml
@@ -1,36 +1,43 @@
 <Root>
     <File Name="object_os" Segment="6">
-        <Animation Name="object_os_Anim_0002E4" Offset="0x2E4"/>
-        <DList Name="object_os_DL_001D80" Offset="0x1D80"/>
-        <DList Name="object_os_DL_0020A8" Offset="0x20A8"/>
-        <DList Name="object_os_DL_0025E8" Offset="0x25E8"/>
-        <DList Name="object_os_DL_002718" Offset="0x2718"/>
-        <DList Name="object_os_DL_002848" Offset="0x2848"/>
-        <DList Name="object_os_DL_002A00" Offset="0x2A00"/>
-        <DList Name="object_os_DL_002B30" Offset="0x2B30"/>
-        <DList Name="object_os_DL_002C60" Offset="0x2C60"/>
-        <Texture Name="object_os_TLUT_002E18" OutName="tlut_00002E18" Format="rgba16" Width="16" Height="16" Offset="0x2E18"/>
-        <Texture Name="object_os_TLUT_003018" OutName="tlut_00003018" Format="rgba16" Width="16" Height="16" Offset="0x3018"/>
-        <Texture Name="object_os_Tex_003218" OutName="tex_00003218" Format="ci8" Width="8" Height="8" Offset="0x3218" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_003258" OutName="tex_00003258" Format="ci8" Width="16" Height="16" Offset="0x3258" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_003358" OutName="tex_00003358" Format="ci8" Width="8" Height="8" Offset="0x3358" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_003398" OutName="tex_00003398" Format="ci8" Width="8" Height="8" Offset="0x3398" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_0033D8" OutName="tex_000033D8" Format="ci8" Width="32" Height="16" Offset="0x33D8" TlutOffset="0x3018"/>
-        <Texture Name="gOsEyeClosedTex" OutName="eye_closed" Format="ci8" Width="32" Height="32" Offset="0x35D8" TlutOffset="0x3018"/>
-        <Texture Name="gOsEyeOpenTex" OutName="eye_open" Format="ci8" Width="32" Height="32" Offset="0x39D8" TlutOffset="0x3018"/>
-        <Texture Name="object_os_Tex_003DD8" OutName="tex_00003DD8" Format="ci8" Width="16" Height="16" Offset="0x3DD8" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_003ED8" OutName="tex_00003ED8" Format="ci8" Width="16" Height="32" Offset="0x3ED8" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_0040D8" OutName="tex_000040D8" Format="ci8" Width="32" Height="32" Offset="0x40D8" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_0044D8" OutName="tex_000044D8" Format="ci8" Width="8" Height="16" Offset="0x44D8" TlutOffset="0x2E18"/>
-        <Texture Name="object_os_Tex_004558" OutName="tex_00004558" Format="ci8" Width="8" Height="16" Offset="0x4558" TlutOffset="0x2E18"/>
-        <Limb Name="object_os_Limb_0045D8" LimbType="Standard" Offset="0x45D8"/>
-        <Limb Name="object_os_Limb_0045E4" LimbType="Standard" Offset="0x45E4"/>
-        <Limb Name="object_os_Limb_0045F0" LimbType="Standard" Offset="0x45F0"/>
-        <Limb Name="object_os_Limb_0045FC" LimbType="Standard" Offset="0x45FC"/>
-        <Limb Name="object_os_Limb_004608" LimbType="Standard" Offset="0x4608"/>
-        <Limb Name="object_os_Limb_004614" LimbType="Standard" Offset="0x4614"/>
-        <Limb Name="object_os_Limb_004620" LimbType="Standard" Offset="0x4620"/>
-        <Limb Name="object_os_Limb_00462C" LimbType="Standard" Offset="0x462C"/>
-        <Skeleton Name="object_os_Skel_004658" Type="Flex" LimbType="Standard" Offset="0x4658"/>
+        <!-- Happy Mask Salesman Animation -->
+        <Animation Name="gHappyMaskSalesmanIdleAnim" Offset="0x2E4"/>
+
+        <!-- Happy Mask Salesman DLists -->
+        <DList Name="gHappyMaskSalesmanTorsoDL" Offset="0x1D80"/>
+        <DList Name="gHappyMaskSalesmanHeadDL" Offset="0x20A8"/>
+        <DList Name="gHappyMaskSalesmanRightUpperArmDL" Offset="0x25E8"/>
+        <DList Name="gHappyMaskSalesmanRightForearmDL" Offset="0x2718"/>
+        <DList Name="gHappyMaskSalesmanRightHandDL" Offset="0x2848"/>
+        <DList Name="gHappyMaskSalesmanLeftUpperArmDL" Offset="0x2A00"/>
+        <DList Name="gHappyMaskSalesmanLeftForearmDL" Offset="0x2B30"/>
+        <DList Name="gHappyMaskSalesmanLeftHandDL" Offset="0x2C60"/>
+
+        <!-- Happy Mask Salesman Textures -->
+        <Texture Name="gHappyMaskSalesmanTLUT" OutName="tlut" Format="rgba16" Width="16" Height="16" Offset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanEyeMouthTLUT" OutName="eye_mouth_tlut" Format="rgba16" Width="16" Height="16" Offset="0x3018"/>
+        <Texture Name="gHappyMaskSalesmanSkinTex" OutName="skin" Format="ci8" Width="8" Height="8" Offset="0x3218" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanHairTex" OutName="hair" Format="ci8" Width="16" Height="16" Offset="0x3258" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanEarTex" OutName="ear" Format="ci8" Width="8" Height="8" Offset="0x3358" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanNostrilTex" OutName="nostril" Format="ci8" Width="8" Height="8" Offset="0x3398" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanMouthTex" OutName="mouth" Format="ci8" Width="32" Height="16" Offset="0x33D8" TlutOffset="0x3018"/>
+        <Texture Name="gHappyMaskSalesmanEyeClosedTex" OutName="eye_closed" Format="ci8" Width="32" Height="32" Offset="0x35D8" TlutOffset="0x3018"/>
+        <Texture Name="gHappyMaskSalesmanEyeOpenTex" OutName="eye_open" Format="ci8" Width="32" Height="32" Offset="0x39D8" TlutOffset="0x3018"/>
+        <Texture Name="gHappyMaskSalesmanFingersTex" OutName="fingers" Format="ci8" Width="16" Height="16" Offset="0x3DD8" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanSleeveTex" OutName="sleeve" Format="ci8" Width="16" Height="32" Offset="0x3ED8" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanShirtTex" OutName="shirt" Format="ci8" Width="32" Height="32" Offset="0x40D8" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanGoldFabricTex" OutName="gold_fabric" Format="ci8" Width="8" Height="16" Offset="0x44D8" TlutOffset="0x2E18"/>
+        <Texture Name="gHappyMaskSalesmanGoldFabricCenterTex" OutName="gold_fabric_center" Format="ci8" Width="8" Height="16" Offset="0x4558" TlutOffset="0x2E18"/>
+
+        <!-- Happy Mask Salesman Skeleton -->
+        <Limb Name="gHappyMaskSalesmanTorsoLimb" LimbType="Standard" Offset="0x45D8"/>
+        <Limb Name="gHappyMaskSalesmanLeftUpperArmLimb" LimbType="Standard" Offset="0x45E4"/>
+        <Limb Name="gHappyMaskSalesmanLeftForearmLimb" LimbType="Standard" Offset="0x45F0"/>
+        <Limb Name="gHappyMaskSalesmanLeftHandLimb" LimbType="Standard" Offset="0x45FC"/>
+        <Limb Name="gHappyMaskSalesmanRightUpperArmLimb" LimbType="Standard" Offset="0x4608"/>
+        <Limb Name="gHappyMaskSalesmanRightForearmLimb" LimbType="Standard" Offset="0x4614"/>
+        <Limb Name="gHappyMaskSalesmanRightHandLimb" LimbType="Standard" Offset="0x4620"/>
+        <Limb Name="gHappyMaskSalesmanHeadLimb" LimbType="Standard" Offset="0x462C"/>
+        <Skeleton Name="gHappyMaskSalesmanSkel" Type="Flex" LimbType="Standard" Offset="0x4658"/>
     </File>
 </Root>
diff --git a/src/overlays/actors/ovl_Demo_Ec/z_demo_ec.c b/src/overlays/actors/ovl_Demo_Ec/z_demo_ec.c
index aedb325c26..4be5ea5242 100644
--- a/src/overlays/actors/ovl_Demo_Ec/z_demo_ec.c
+++ b/src/overlays/actors/ovl_Demo_Ec/z_demo_ec.c
@@ -1038,7 +1038,7 @@ void DemoEc_DrawPotionShopOwner(DemoEc* this, PlayState* play) {
 
 void DemoEc_InitMaskShopOwner(DemoEc* this, PlayState* play) {
     DemoEc_UseDrawObject(this, play);
-    DemoEc_InitSkelAnime(this, play, &object_os_Skel_004658);
+    DemoEc_InitSkelAnime(this, play, &gHappyMaskSalesmanSkel);
     DemoEc_UseAnimationObject(this, play);
     DemoEc_ChangeAnimation(this, &gDemoEcPotionShopOwnerAnim, 0, 0.0f, false);
     func_8096D5D4(this, play);
@@ -1054,7 +1054,7 @@ void DemoEc_UpdateMaskShopOwner(DemoEc* this, PlayState* play) {
 }
 
 void DemoEc_DrawMaskShopOwner(DemoEc* this, PlayState* play) {
-    DemoEc_DrawSkeleton(this, play, gOsEyeClosedTex, NULL, NULL, NULL);
+    DemoEc_DrawSkeleton(this, play, gHappyMaskSalesmanEyeClosedTex, NULL, NULL, NULL);
 }
 
 void DemoEc_InitFishingOwner(DemoEc* this, PlayState* play) {
diff --git a/src/overlays/actors/ovl_En_Ossan/z_en_ossan.c b/src/overlays/actors/ovl_En_Ossan/z_en_ossan.c
index 1177489436..eb1c8ef358 100644
--- a/src/overlays/actors/ovl_En_Ossan/z_en_ossan.c
+++ b/src/overlays/actors/ovl_En_Ossan/z_en_ossan.c
@@ -2023,7 +2023,7 @@ void EnOssan_InitPotionShopkeeper(EnOssan* this, PlayState* play) {
 }
 
 void EnOssan_InitHappyMaskShopkeeper(EnOssan* this, PlayState* play) {
-    SkelAnime_InitFlex(play, &this->skelAnime, &object_os_Skel_004658, &object_os_Anim_0002E4, NULL, NULL, 0);
+    SkelAnime_InitFlex(play, &this->skelAnime, &gHappyMaskSalesmanSkel, &gHappyMaskSalesmanIdleAnim, NULL, NULL, 0);
     this->actor.draw = EnOssan_DrawHappyMaskShopkeeper;
     this->obj3ToSeg6Func = NULL;
 }
@@ -2454,8 +2454,11 @@ void EnOssan_DrawZoraShopkeeper(Actor* thisx, PlayState* play) {
 }
 
 void EnOssan_DrawPotionShopkeeper(Actor* thisx, PlayState* play) {
-    static void* sPotionShopkeeperEyeTextures[] = { gPotionShopkeeperEyeOpenTex, gPotionShopkeeperEyeHalfTex,
-                                                    gPotionShopkeeperEyeClosedTex };
+    static void* sPotionShopkeeperEyeTextures[] = {
+        gPotionShopkeeperEyeOpenTex,
+        gPotionShopkeeperEyeHalfTex,
+        gPotionShopkeeperEyeClosedTex,
+    };
     EnOssan* this = (EnOssan*)thisx;
     s32 pad;
 
@@ -2472,7 +2475,7 @@ void EnOssan_DrawPotionShopkeeper(Actor* thisx, PlayState* play) {
 }
 
 void EnOssan_DrawHappyMaskShopkeeper(Actor* thisx, PlayState* play) {
-    static void* sHappyMaskShopkeeperEyeTextures[] = { gOsEyeClosedTex, gOsEyeOpenTex };
+    static void* sHappyMaskShopkeeperEyeTextures[] = { gHappyMaskSalesmanEyeClosedTex, gHappyMaskSalesmanEyeOpenTex };
     EnOssan* this = (EnOssan*)thisx;
     s32 pad;
 
@@ -2491,8 +2494,11 @@ void EnOssan_DrawHappyMaskShopkeeper(Actor* thisx, PlayState* play) {
 }
 
 void EnOssan_DrawBombchuShopkeeper(Actor* thisx, PlayState* play) {
-    static void* sBombchuShopkeeperEyeTextures[] = { gBombchuShopkeeperEyeOpenTex, gBombchuShopkeeperEyeHalfTex,
-                                                     gBombchuShopkeeperEyeClosedTex };
+    static void* sBombchuShopkeeperEyeTextures[] = {
+        gBombchuShopkeeperEyeOpenTex,
+        gBombchuShopkeeperEyeHalfTex,
+        gBombchuShopkeeperEyeClosedTex,
+    };
     EnOssan* this = (EnOssan*)thisx;
     s32 pad;