Merge branch 'master' into tilemap-docs

1 files changed, 114 insertions, 102 deletions

diff --git a/src/object/button.c b/src/object/button.c
index a7f2a9ac..317d8e50 100644
--- a/src/object/button.c
+++ b/src/object/button.c
@@ -4,177 +4,189 @@
  *
  * @brief Button object
  */
-#include "object.h"
+#define NENT_DEPRECATED
 #include "functions.h"
 #include "tiles.h"
+#include "object.h"
 
-void Button_Init(Entity*);
-void Button_Action1(Entity*);
-void Button_Action2(Entity*);
-void Button_Action3(Entity*);
-void Button_Action4(Entity*);
-void Button_Action5(Entity*);
+typedef struct {
+    /*0x00*/ Entity base;
+    /*0x68*/ u8 unused1[8];
+    /*0x70*/ u16 unk_70;
+    /*0x72*/ u16 unk_72;
+    /*0x74*/ u16 metaTilePos;
+    /*0x76*/ u8 unused2[14];
+    /*0x84*/ u16 unk_84;
+    /*0x86*/ u16 unk_86;
+} ButtonEntity;
 
-void Button(Entity* this) {
-    static void (*const Button_Actions[])(Entity*) = {
+void Button_Init(ButtonEntity* this);
+void Button_Action1(ButtonEntity* this);
+void Button_Action2(ButtonEntity* this);
+void Button_Action3(ButtonEntity* this);
+void Button_Action4(ButtonEntity* this);
+void Button_Action5(ButtonEntity* this);
+
+void Button(ButtonEntity* this) {
+    static void (*const Button_Actions[])(ButtonEntity*) = {
         Button_Init, Button_Action1, Button_Action2, Button_Action3, Button_Action4, Button_Action5,
     };
-    Button_Actions[this->action](this);
+    Button_Actions[super->action](this);
 }
 
-extern u32 sub_08081E3C(Entity*);
+extern u32 sub_08081E3C(ButtonEntity*);
 
-void Button_Init(Entity* this) {
-    COLLISION_OFF(this);
-    this->updatePriority = PRIO_NO_BLOCK;
-    this->y.HALF.HI++;
-    if (this->cutsceneBeh.HWORD != 0) {
-        this->collisionLayer = this->cutsceneBeh.HWORD;
+void Button_Init(ButtonEntity* this) {
+    COLLISION_OFF(super);
+    super->updatePriority = PRIO_NO_BLOCK;
+    super->y.HALF.HI++;
+    if (this->unk_84 != 0) {
+        super->collisionLayer = this->unk_84;
     }
-    this->field_0x74.HWORD = (((this->x.HALF.HI - gRoomControls.origin_x) >> 4) & 0x3F) |
-                             ((((this->y.HALF.HI - gRoomControls.origin_y) >> 4) & 0x3F) << 6);
-    this->field_0x70.HALF.HI = GetMetaTileType(this->field_0x74.HWORD, this->collisionLayer);
-    if (this->type == 0 && CheckFlags(this->field_0x86.HWORD)) {
-        this->action = 5;
-        SetMetaTileType(META_TILE_TYPE_122, this->field_0x74.HWORD, this->collisionLayer);
+    this->metaTilePos = (((super->x.HALF.HI - gRoomControls.origin_x) >> 4) & 0x3F) |
+                   ((((super->y.HALF.HI - gRoomControls.origin_y) >> 4) & 0x3F) << 6);
+    this->unk_72 = GetMetaTileType(this->metaTilePos, super->collisionLayer);
+    if (super->type == 0 && CheckFlags(this->unk_86)) {
+        super->action = 5;
+        SetMetaTileType(META_TILE_TYPE_122, this->metaTilePos, super->collisionLayer);
     } else {
         if (sub_08081E3C(this)) {
-            this->action = 2;
+            super->action = 2;
         } else {
-            this->action = 1;
+            super->action = 1;
         }
     }
 }
 
-void Button_Action1(Entity* this) {
+void Button_Action1(ButtonEntity* this) {
     if (sub_08081E3C(this)) {
-        this->action = 2;
-        this->field_0x70.HALF.HI = GetMetaTileType(this->field_0x74.HWORD, this->collisionLayer);
+        super->action = 2;
+        this->unk_72 = GetMetaTileType(this->metaTilePos, super->collisionLayer);
     }
 }
 
-u32 sub_08081CB0(Entity*);
+u32 sub_08081CB0(ButtonEntity*);
 void sub_08081FF8(Entity*);
 
-void Button_Action2(Entity* this) {
+void Button_Action2(ButtonEntity* this) {
     if (sub_08081CB0(this)) {
-        this->subAction = 0;
-        this->timer = 10;
-        RequestPriorityDuration(this, 10);
-        sub_08081FF8(this);
-        if (this->type == 1) {
-            this->action = 3;
+        super->subAction = 0;
+        super->timer = 10;
+        RequestPriorityDuration(super, 10);
+        sub_08081FF8(super);
+        if (super->type == 1) {
+            super->action = 3;
         } else {
-            this->action = 5;
+            super->action = 5;
         }
     }
 }
 
-u32 sub_08081F7C(Entity*, u32 metaTileType);
-u32 sub_08081D28(Entity*);
-void sub_08081E6C(Entity*);
+u32 sub_08081F7C(ButtonEntity*, u32 metaTileType);
+u32 sub_08081D28(ButtonEntity*);
+void sub_08081E6C(ButtonEntity*);
 
-void Button_Action3(Entity* this) {
+void Button_Action3(ButtonEntity* this) {
     if (!sub_08081F7C(this, META_TILE_TYPE_120))
         return;
     if (!sub_08081D28(this)) {
-        this->action = 4;
-        this->subtimer = 1;
+        super->action = 4;
+        super->subtimer = 1;
         if ((gPlayerState.heldObject == 2) || (!(gPlayerState.field_0x35 & 0x80))) {
-            this->timer = 24;
+            super->timer = 24;
         } else {
-            this->timer = 8;
+            super->timer = 8;
         }
     } else {
         sub_08081E6C(this);
     }
 }
 
-void Button_Action4(Entity* this) {
-    if (this->timer != 0) {
-        this->timer--;
-        if (this->subtimer != 0) {
-            this->subtimer = 0;
-            SetMetaTile(SPECIAL_META_TILE_53, this->field_0x74.HWORD, this->collisionLayer);
+void Button_Action4(ButtonEntity* this) {
+    if (super->timer != 0) {
+        super->timer--;
+        if (super->subtimer != 0) {
+            super->subtimer = 0;
+            SetMetaTile(SPECIAL_META_TILE_53, this->metaTilePos, super->collisionLayer);
         }
         if (sub_08081CB0(this)) {
-            this->action = 3;
-            this->timer = 0;
+            super->action = 3;
+            super->timer = 0;
         }
     } else {
-        this->action = 2;
-        ClearFlag(this->field_0x86.HWORD);
-        SetMetaTileType(META_TILE_TYPE_119, this->field_0x74.HWORD, this->collisionLayer);
+        super->action = 2;
+        ClearFlag(this->unk_86);
+        SetMetaTileType(META_TILE_TYPE_119, this->metaTilePos, super->collisionLayer);
         SoundReq(SFX_BUTTON_PRESS);
     }
 }
 
-void Button_Action5(Entity* this) {
+void Button_Action5(ButtonEntity* this) {
     if (sub_08081F7C(this, META_TILE_TYPE_122)) {
         sub_08081E6C(this);
     }
 }
 
-Entity* sub_08081D74(Entity*);
+Entity* sub_08081D74(ButtonEntity*);
 
-u32 sub_08081CB0(Entity* this) {
+bool32 sub_08081CB0(ButtonEntity* this) {
     u16 tileType;
     if (sub_08081D74(this)) {
-        this->field_0x70.HALF.LO = -1;
-        if (GetMetaTileType(this->field_0x74.HWORD, this->collisionLayer) == SPECIAL_META_TILE_53) {
-            sub_0807B7D8(0x78, this->field_0x74.HWORD, this->collisionLayer);
+        this->unk_70 = -1;
+        if (GetMetaTileType(this->metaTilePos, super->collisionLayer) == SPECIAL_META_TILE_53) {
+            sub_0807B7D8(0x78, this->metaTilePos, super->collisionLayer);
         }
-        return 1;
+        return TRUE;
     } else {
-        tileType = GetMetaTileType(this->field_0x74.HWORD, this->collisionLayer);
+        tileType = GetMetaTileType(this->metaTilePos, super->collisionLayer);
         if (tileType != 0x77 && tileType != 0x79 && tileType != SPECIAL_META_TILE_53) {
-            this->field_0x70.HALF.LO = GetMetaTileIndex(this->field_0x74.HWORD, this->collisionLayer);
-            return 1;
+            this->unk_70 = GetMetaTileIndex(this->metaTilePos, super->collisionLayer);
+            return TRUE;
         }
     }
-    return 0;
+    return FALSE;
 }
 
-u32 sub_08081D28(Entity* this) {
+bool32 sub_08081D28(ButtonEntity* this) {
     if (sub_08081D74(this)) {
-        this->field_0x70.HALF_U.LO = 0xFFFF;
-        return 1;
+        this->unk_70 = 0xFFFF;
+        return TRUE;
     } else {
-        if (this->field_0x70.HALF_U.LO == 0xFFFF) {
-            return 0;
+        if (this->unk_70 == 0xFFFF) {
+            return FALSE;
         }
-        if (GetMetaTileIndex(this->field_0x74.HWORD, this->collisionLayer) != this->field_0x70.HALF_U.LO) {
-            return 0;
+        if (GetMetaTileIndex(this->metaTilePos, super->collisionLayer) != this->unk_70) {
+            return FALSE;
         }
     }
-    return 1;
+    return TRUE;
 }
 
 extern Entity* gPlayerClones[3];
 u32 sub_08081E0C(Entity*);
 
-Entity* sub_08081D74(Entity* this) {
+Entity* sub_08081D74(ButtonEntity* this) {
     Entity* ent;
-    if (GetCollisionDataAtMetaTilePos(this->field_0x74.HWORD, this->collisionLayer) == COLLISION_DATA_15) {
+    if (GetCollisionDataAtMetaTilePos(this->metaTilePos, super->collisionLayer) == COLLISION_DATA_15) {
         return NULL;
     }
     ent = 0;
-    if (sub_08081E0C(this)) {
+    if (sub_08081E0C(super)) {
         if ((gPlayerState.flags & PL_CAPTURED) == 0 && (gPlayerState.flags & PL_MINISH) == 0) {
             ent = &gPlayerEntity;
         }
     } else {
         if (gPlayerState.flags & PL_CLONING) {
-            if (EntityInRectRadius(this, gPlayerClones[0], 5, 6)) {
+            if (EntityInRectRadius(super, gPlayerClones[0], 5, 6)) {
                 ent = gPlayerClones[0];
-            } else if (EntityInRectRadius(this, gPlayerClones[1], 5, 6)) {
+            } else if (EntityInRectRadius(super, gPlayerClones[1], 5, 6)) {
                 ent = gPlayerClones[1];
-            } else if (EntityInRectRadius(this, gPlayerClones[2], 5, 6)) {
+            } else if (EntityInRectRadius(super, gPlayerClones[2], 5, 6)) {
                 ent = gPlayerClones[2];
             }
         }
     }
-    this->child = ent;
+    super->child = ent;
     return ent;
 }
 
@@ -187,13 +199,13 @@ u32 sub_08081E0C(Entity* this) {
     }
 }
 
-u32 sub_08081E3C(Entity* this) {
+u32 sub_08081E3C(ButtonEntity* this) {
     static const u16 gUnk_0811EE50[] = {
         0x77, 0x78, 0x79, 0x7a, 0, 0,
     };
     const u16* tmp1;
     s32 tmp2;
-    tmp2 = GetMetaTileType(this->field_0x74.HWORD, this->collisionLayer);
+    tmp2 = GetMetaTileType(this->metaTilePos, super->collisionLayer);
     tmp1 = gUnk_0811EE50;
     do {
         if (*tmp1 == tmp2)
@@ -208,20 +220,20 @@ extern u16 gMapDataTopSpecial[0x2000];
 
 extern u16 gMapDataBottomSpecial[];
 
-void sub_08081E6C(Entity* this) {
+void sub_08081E6C(ButtonEntity* this) {
     u32 metaTileType;
     MapLayer* mapLayer;
     u16* tmp2;
     u16* tmp;
     u16* tmp3;
-    u32 metaTilePos = this->field_0x74.HWORD;
-    u32 layer = this->collisionLayer;
+    u32 metaTilePos = this->metaTilePos;
+    u32 layer = super->collisionLayer;
     u32 specialMetaTile = GetMetaTileType(metaTilePos, layer);
 
     if (specialMetaTile < 0x4000)
         return;
     mapLayer = GetLayerByIndex(layer);
-    metaTileType = (this->type == 0 ? META_TILE_TYPE_122 : META_TILE_TYPE_120);
+    metaTileType = (super->type == 0 ? META_TILE_TYPE_122 : META_TILE_TYPE_120);
     tmp = mapLayer->metatiles;
     tmp = tmp + (mapLayer->unkData2[metaTileType] << 2);
     tmp2 = (layer == 2 ? gMapDataTopSpecial : gMapDataBottomSpecial);
@@ -256,25 +268,25 @@ void sub_08081F24(Entity* this) {
     }
 }
 
-u32 sub_08081F7C(Entity* this, u32 metaTileType) {
+bool32 sub_08081F7C(ButtonEntity* this, u32 metaTileType) {
     u16 tmp;
-    if (this->timer == 0)
-        return 1;
-    if (--this->timer > 6) {
-        if (this->child != NULL)
-            this->child->spriteOffsetY = -4;
+    if (super->timer == 0)
+        return TRUE;
+    if (--super->timer > 6) {
+        if (super->child != NULL)
+            super->child->spriteOffsetY = -4;
     } else {
-        if (this->timer == 6) {
-            SetFlag(this->field_0x86.HWORD);
-            SetMetaTileType(metaTileType, this->field_0x74.HWORD, this->collisionLayer);
-            sub_08081F24(this);
+        if (super->timer == 6) {
+            SetFlag(this->unk_86);
+            SetMetaTileType(metaTileType, this->metaTilePos, super->collisionLayer);
+            sub_08081F24(super);
             SoundReq(SFX_BUTTON_PRESS);
-            if (this->field_0x70.HALF_U.LO != 0xFFFF)
-                SetMetaTile(this->field_0x70.HALF_U.LO, this->field_0x74.HWORD, this->collisionLayer);
-            return 0;
+            if (this->unk_70 != 0xFFFF)
+                SetMetaTile(this->unk_70, this->metaTilePos, super->collisionLayer);
+            return FALSE;
         }
     }
-    return 1;
+    return TRUE;
 }
 
 void sub_08081FF8(Entity* this) {