From e729f104429cacdc915e27887090ceb8d956c9ab Mon Sep 17 00:00:00 2001
From: Kristopher Early <1191258+MrPolymorph@users.noreply.github.com>
Date: Sun, 19 Jun 2022 02:29:44 +0100
Subject: [PATCH] Yasi descriptive names (#831)

* Cleaned up yasi by giving symbols descriptive names

* renamed variables to palm tree

* Adding descriptive comment to root of xml asset file

Co-authored-by: MrPolymorph <{ID}+{username}@users.noreply.github.com>
---
 assets/xml/objects/object_obj_yasi.xml        | 15 ++++++++-------
 src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.c |  6 +++---
 src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.h |  2 +-
 3 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/assets/xml/objects/object_obj_yasi.xml b/assets/xml/objects/object_obj_yasi.xml
index b7d2c1fd13..a8e153edd8 100644
--- a/assets/xml/objects/object_obj_yasi.xml
+++ b/assets/xml/objects/object_obj_yasi.xml
@@ -1,11 +1,12 @@
 <Root>
+    <!-- Object for the Palm Tree(s) found at the Great Bay Coast -->
     <File Name="object_obj_yasi" Segment="6">
-        <DList Name="object_obj_yasi_DL_000360" Offset="0x360" />
-        <Texture Name="object_obj_yasi_TLUT_000630" OutName="tlut_000630" Format="rgba16" Width="4" Height="4" Offset="0x630" />
-        <Texture Name="object_obj_yasi_Tex_000650" OutName="tex_000650" Format="ci4" Width="32" Height="128" Offset="0x650" />
-        <Texture Name="object_obj_yasi_Tex_000E50" OutName="tex_000E50" Format="rgba16" Width="16" Height="16" Offset="0xE50" />
-        <Texture Name="object_obj_yasi_Tex_001050" OutName="tex_001050" Format="rgba16" Width="16" Height="16" Offset="0x1050" />
-        <Texture Name="object_obj_yasi_Tex_001250" OutName="tex_001250" Format="rgba16" Width="8" Height="8" Offset="0x1250" />
-        <Collision Name="object_obj_yasi_Colheader_001428" Offset="0x1428" />
+        <DList Name="gPalmTreeDL" Offset="0x360" />
+        <Texture Name="gPalmTreeTLUT" OutName="palm_tree_tlut" Format="rgba16" Width="4" Height="4" Offset="0x630" />
+        <Texture Name="gPalmTreeFrondTex" OutName="palm_tree_frond_tex" Format="ci4" Width="32" Height="128" Offset="0x650" />
+        <Texture Name="gPalmTreeDekuNutTex" OutName="palm_tree_deku_nut_tex" Format="rgba16" Width="16" Height="16" Offset="0xE50" />
+        <Texture Name="gPalmTreeScarredWoodTex" OutName="palm_tree_scarred_wood_tex" Format="rgba16" Width="16" Height="16" Offset="0x1050" />
+        <Texture Name="gPalmTreeWoodTex" OutName="palm_tree_wood_tex" Format="rgba16" Width="8" Height="8" Offset="0x1250" />
+        <Collision Name="gPalmTreeCol" Offset="0x1428" />
     </File>
 </Root>
diff --git a/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.c b/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.c
index 3dfea08180..4e9bb84b2d 100644
--- a/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.c
+++ b/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.c
@@ -42,11 +42,11 @@ void ObjYasi_Init(Actor* thisx, GlobalContext* globalCtx) {
 
     Actor_ProcessInitChain(&this->dyna.actor, sInitChain);
     DynaPolyActor_Init(&this->dyna, 0);
-    DynaPolyActor_LoadMesh(globalCtx, &this->dyna, &object_obj_yasi_Colheader_001428);
+    DynaPolyActor_LoadMesh(globalCtx, &this->dyna, &gPalmTreeCol);
 
     this->dyna.actor.home.rot.y = 0;
 
-    if (OBJYASI_IS_WIDE(thisx)) {
+    if (PALM_TREE_IS_WIDE(thisx)) {
         this->dyna.actor.scale.x = 0.2f;
         this->dyna.actor.scale.z = 0.2f;
     }
@@ -97,5 +97,5 @@ void ObjYasi_Draw(Actor* thisx, GlobalContext* globalCtx) {
     }
 
     Matrix_Scale(0.1f, 0.1f, 0.1f, MTXMODE_APPLY);
-    Gfx_DrawDListOpa(globalCtx, object_obj_yasi_DL_000360);
+    Gfx_DrawDListOpa(globalCtx, gPalmTreeDL);
 }
diff --git a/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.h b/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.h
index f4ab9ca9ca..d1fdc6aeda 100644
--- a/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.h
+++ b/src/overlays/actors/ovl_Obj_Yasi/z_obj_yasi.h
@@ -11,6 +11,6 @@ typedef struct ObjYasi {
 
 extern const ActorInit Obj_Yasi_InitVars;
 
-#define OBJYASI_IS_WIDE(thisx) ((thisx)->params & 1)
+#define PALM_TREE_IS_WIDE(thisx) ((thisx)->params & 1)
 
 #endif // Z_OBJ_YASI_H