Documentation pass centered on z_player_lib (#1230)

zeldaret · May 29, 2022 · d39ce02 · d39ce02
1 parent e68f321
commit d39ce02
Show file tree

Hide file tree

Showing 6 changed files with 220 additions and 191 deletions.
diff --git a/include/variables.h b/include/variables.h
@@ -73,10 +73,10 @@ extern s16 gSpoilingItems[3];
 extern s16 gSpoilingItemReverts[3];
 extern FlexSkeletonHeader* gPlayerSkelHeaders[2];
 extern u8 gPlayerModelTypes[PLAYER_MODELGROUP_MAX][PLAYER_MODELGROUPENTRY_MAX];
-extern Gfx* D_80125DE8[];
-extern Gfx* D_80125E08[];
-extern Gfx* D_80125E18[];
-extern Gfx* D_80125EF8[];
+extern Gfx* gPlayerLeftHandBgsDLs[];
+extern Gfx* gPlayerLeftHandOpenDLs[];
+extern Gfx* gPlayerLeftHandClosedDLs[];
+extern Gfx* gPlayerLeftHandBoomerangDLs[];
 extern Gfx gCullBackDList[];
 extern Gfx gCullFrontDList[];
 extern Gfx gEmptyDL[];

diff --git a/include/z64player.h b/include/z64player.h
@@ -254,7 +254,7 @@ typedef enum {
     /* 0x00 */ PLAYER_MODELTYPE_LH_OPEN, // empty open hand
     /* 0x01 */ PLAYER_MODELTYPE_LH_CLOSED, // empty closed hand
     /* 0x02 */ PLAYER_MODELTYPE_LH_SWORD, // holding kokiri/master sword
-    /* 0x03 */ PLAYER_MODELTYPE_3, // unused, same as PLAYER_MODELTYPE_LH_SWORD
+    /* 0x03 */ PLAYER_MODELTYPE_LH_SWORD_2, // unused, same as PLAYER_MODELTYPE_LH_SWORD
     /* 0x04 */ PLAYER_MODELTYPE_LH_BGS, // holding bgs/broken giant knife (child: master sword)
     /* 0x05 */ PLAYER_MODELTYPE_LH_HAMMER, // holding hammer (child: empty hand)
     /* 0x06 */ PLAYER_MODELTYPE_LH_BOOMERANG, // holding boomerang (adult: empty hand)
@@ -264,7 +264,7 @@ typedef enum {
     /* 0x09 */ PLAYER_MODELTYPE_RH_CLOSED, // empty closed hand
     /* 0x0A */ PLAYER_MODELTYPE_RH_SHIELD, // holding a shield (including no shield)
     /* 0x0B */ PLAYER_MODELTYPE_RH_BOW_SLINGSHOT, // holding bow/slingshot
-    /* 0x0C */ PLAYER_MODELTYPE_12, // unused, same as PLAYER_MODELTYPE_RH_BOW_SLINGSHOT
+    /* 0x0C */ PLAYER_MODELTYPE_RH_BOW_SLINGSHOT_2, // unused, same as PLAYER_MODELTYPE_RH_BOW_SLINGSHOT
     /* 0x0D */ PLAYER_MODELTYPE_RH_OCARINA, // holding ocarina (child: fairy ocarina, adult: OoT)
     /* 0x0E */ PLAYER_MODELTYPE_RH_OOT, // holding OoT
     /* 0x0F */ PLAYER_MODELTYPE_RH_HOOKSHOT, // holding hookshot (child: empty hand)

diff --git a/include/z64save.h b/include/z64save.h
@@ -101,7 +101,7 @@ typedef struct {
 
 typedef struct {
     /* 0x0000 */ s32 entranceIndex; // start of `save` substruct, originally called "memory"
-    /* 0x0004 */ s32 linkAge;
+    /* 0x0004 */ s32 linkAge; // 0: Adult; 1: Child (see enum `LinkAge`)
     /* 0x0008 */ s32 cutsceneIndex;
     /* 0x000C */ u16 dayTime; // "zelda_time"
     /* 0x0010 */ s32 nightFlag;