Merge pull request #315 from AnonymousRandomPerson/master

Document some AI vars, sync names with pmdsky-debug
pret · Dec 30, 2024 · 6936e1f · 6936e1f
2 parents 6020a3d + 1ec6bc5
commit 6936e1f
Show file tree

Hide file tree

Showing 68 changed files with 502 additions and 498 deletions.
diff --git a/asm/code_8040094.s b/asm/code_8040094.s
@@ -1663,7 +1663,7 @@ _08040E24:
 	adds r6, r7, 0
 _08040E26:
 	adds r0, r6, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	bne _08040E34
@@ -2104,7 +2104,7 @@ _0804118A:
 	movs r2, 0
 	str r2, [sp, 0x14]
 	adds r0, r6, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080411CA
@@ -2137,7 +2137,7 @@ _080411D0:
 	cmp r5, r0
 	beq _08041216
 	adds r0, r6, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _08041216
@@ -2452,7 +2452,7 @@ sub_804143C:
 	cmp r0, 0xED
 	bne _08041476
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080414A4
@@ -2613,7 +2613,7 @@ sub_8041550:
 	lsls r0, 24
 	lsrs r6, r0, 24
 	adds r0, r7, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _0804159C

diff --git a/asm/code_8044210.s b/asm/code_8044210.s
@@ -30,7 +30,7 @@ _08044592:
 	adds r0, r1
 	ldr r5, [r0]
 	adds r0, r5, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080446A4
@@ -110,7 +110,7 @@ _08044644:
 	adds r0, r5, 0
 	bl TickStatusHeal
 	adds r0, r5, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080446A4
@@ -181,7 +181,7 @@ _080446D4:
 	adds r0, r1
 	ldr r4, [r0]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _08044760
@@ -273,7 +273,7 @@ _0804476A:
 	movs r0, 0
 	bl sub_8043ED0
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 _080447A0:
 	ldr r5, [r5, 0x4]
 	cmp r5, 0
@@ -295,7 +295,7 @@ _080447B8:
 	adds r0, r1
 	ldr r4, [r0]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080447FC
@@ -309,7 +309,7 @@ _080447B8:
 	adds r0, r4, 0
 	bl sub_8074094
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080447FC

diff --git a/asm/code_8045A00.s b/asm/code_8045A00.s
@@ -493,7 +493,7 @@ _0804618A:
 	adds r0, r2
 	adds r0, r1
 	ldr r0, [r0]
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	adds r1, r4, 0x1
 	cmp r0, 0
@@ -597,7 +597,7 @@ _08046258:
 	adds r0, r2
 	adds r0, r1
 	ldr r0, [r0]
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	adds r1, r4, 0x1
 	cmp r0, 0
@@ -659,7 +659,7 @@ sub_80462AC:
 	movs r0, 0
 	str r0, [sp, 0x4]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	bne _080462E4
@@ -1792,7 +1792,7 @@ _08046BAA:
 	adds r4, r5
 	adds r4, 0x4
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _08046C06

diff --git a/asm/code_805D8C8.s b/asm/code_805D8C8.s
@@ -1995,7 +1995,7 @@ _080629FC:
 	adds r0, r1
 	ldr r4, [r0]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _08062A5A
@@ -5467,7 +5467,7 @@ sub_806455C:
 	movs r3, 0
 	bl PrintStringOnWindow
 	ldr r0, [r4, 0x14]
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080645C0

diff --git a/asm/code_805D8C8_1.s b/asm/code_805D8C8_1.s
@@ -944,7 +944,7 @@ _08069044:
 	cmp r4, 0
 	beq _08069072
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _08069072
@@ -1149,7 +1149,7 @@ _080691FE:
 	adds r0, r1
 	ldr r4, [r0]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080691FC

diff --git a/asm/code_8066D04.s b/asm/code_8066D04.s
@@ -821,7 +821,7 @@ _080674BC:
 	bl sub_8047190
 _080674D0:
 	adds r0, r6, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080674F8
@@ -1332,7 +1332,7 @@ _080678C6:
 	cmp r0, 0
 	bne _080678F6
 	adds r0, r5, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080678F0
@@ -1443,7 +1443,7 @@ _0806798E:
 	movs r3, 0
 	bl TryUseChosenMove
 	adds r0, r5, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080679DE
@@ -1462,7 +1462,7 @@ _080679D2:
 	blt _0806798E
 _080679DE:
 	adds r0, r5, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _08067A56

diff --git a/asm/code_8072CF4.s b/asm/code_8072CF4.s
@@ -24,7 +24,7 @@ _080732FE:
 	adds r0, r1
 	ldr r0, [r0]
 	mov r8, r0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	adds r4, 0x1
 	str r4, [sp, 0x10]
@@ -236,7 +236,7 @@ _0807349E:
 	adds r0, r1
 	ldr r7, [r0]
 	adds r0, r7, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	adds r4, 0x1
 	str r4, [sp, 0x10]

diff --git a/asm/code_8083654.s b/asm/code_8083654.s
@@ -491,7 +491,7 @@ _080839DA:
 _08083A00:
 	ldr r4, [r5]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _08083A32

diff --git a/asm/code_808417C.s b/asm/code_808417C.s
@@ -548,7 +548,7 @@ _08084632:
 	adds r0, r1
 	ldr r4, [r0]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _0808466E

diff --git a/asm/code_80848F0.s b/asm/code_80848F0.s
@@ -161,7 +161,7 @@ _0808538E:
 	adds r0, r1
 	ldr r4, [r0]
 	adds r0, r4, 0
-	bl EntityExists
+	bl EntityIsValid
 	lsls r0, 24
 	cmp r0, 0
 	beq _080853BE

diff --git a/include/constants/status.h b/include/constants/status.h
@@ -47,7 +47,7 @@
 #define STATUS_CHARGING 11
 #define STATUS_ENRAGED 12
 
-// ReflectClassStatus statuses
+// Reflect class statuses
 #define STATUS_REFLECT 1
 #define STATUS_SAFEGUARD 2
 #define STATUS_LIGHT_SCREEN 3

diff --git a/include/dungeon_util.h b/include/dungeon_util.h
@@ -9,7 +9,7 @@
 
 extern const DungeonPos gAdjacentTileOffsets[NUM_DIRECTIONS];
 
-bool8 EntityExists(Entity *pokemon);
+bool8 EntityIsValid(Entity *pokemon);
 u32 GetEntityType(Entity *entity);
 u8 GetEntityRoom(Entity *entity);
 Tile *GetTileAtEntitySafe(Entity *entity);

diff --git a/include/items.h b/include/items.h
@@ -29,7 +29,7 @@ u8 GetItemPalette(u8 id);
 u32 GetItemActionType(u8 id);
 u32 GetSpawnAmountRange(u8 id, u32 r1);
 u8 *GetItemDescription(u8 id);
-bool8 GetItemAIFlag(u8 id, u32 r1);
+bool8 TestItemAIFlag(u8 id, u32 aiFlag);
 void BufferItemName(u8 *, u8 id, unkStruct_8090F58 *);
 void sub_8090E14(u8 *ext_buffer, Item *slot, const unkStruct_8090F58 *);
 bool8 AddItemToInventory(const Item* slot);

diff --git a/include/structs/dungeon_entity.h b/include/structs/dungeon_entity.h
@@ -30,11 +30,11 @@
 #define STAT_STAGE_EVASION 1
 
 // size: 0x8
-typedef struct unkStruct_8044CC8
+typedef struct ActionParameter
 {
     /* 0x0 */ u8 actionUseIndex;
-    /* 0x4 */ DungeonPos lastItemThrowPosition;
-} unkStruct_8044CC8;
+    /* 0x4 */ DungeonPos itemPos;
+} ActionParameter;
 
 // size: 0x18
 typedef struct ActionContainer
@@ -43,7 +43,7 @@ typedef struct ActionContainer
     /* 0x2 */ u8 direction;
     u8 unk3;
     // Additional parameter alongside actionIndex. Used for things like indicating which move a Pokémon should use from its moveset.
-    /* 0x4 */ unkStruct_8044CC8 unk4[2];
+    /* 0x4 */ ActionParameter actionParameters[2];
     // Position of the target that the Pokémon wants throw an item at.
     /* 0x14 */ DungeonPos itemTargetPosition;
 } ActionContainer;

diff --git a/src/code_803E724.c b/src/code_803E724.c
@@ -348,7 +348,7 @@ void sub_803EDF0(void)
 
     if (gUnknown_202EDE8.unk0 == 0)
         return;
-    if (!EntityExists(gUnknown_202EDE8.unk4)) {
+    if (!EntityIsValid(gUnknown_202EDE8.unk4)) {
         gUnknown_202EDE8.unk0 = 0;
         return;
     }
@@ -935,7 +935,7 @@ void sub_803F580(u8 a0)
     UnkDungeonGlobal_unk181E8_sub *strPtr = &gDungeon->unk181e8;
     Entity *cameraTarget = strPtr->cameraTarget;
 
-    if (cameraTarget != NULL && EntityExists(cameraTarget)) {
+    if (cameraTarget != NULL && EntityIsValid(cameraTarget)) {
         s32 i;
         u32 before, unk18214;
         EntityInfo *info = GetEntInfo(cameraTarget);
@@ -1036,7 +1036,7 @@ void sub_803F580(u8 a0)
         if (strPtr->cameraPos.x != strPtr->cameraPosMirror.x || strPtr->cameraPos.y != strPtr->cameraPosMirror.y) {
             for (i = 0; i < DUNGEON_MAX_POKEMON; i++) {
                 Entity *mon = gDungeon->activePokemon[i];
-                if (EntityExists(mon)) {
+                if (EntityIsValid(mon)) {
                     sub_80402AC(mon->pos.x, mon->pos.y);
                 }
             }

diff --git a/src/code_8041AD0.c b/src/code_8041AD0.c
@@ -156,7 +156,7 @@ void sub_8041888(u8 param_1)
     for(index = 0; index < DUNGEON_MAX_POKEMON; index++)
     {
         entity = gDungeon->activePokemon[index];
-        if(EntityExists(entity))
+        if(EntityIsValid(entity))
         {
             entityInfo = GetEntInfo(entity);
             if(param_1)
@@ -176,7 +176,7 @@ void EntityUpdateStatusSprites(Entity *entity)
   u32 spriteStatus;
   u8 temp;
 
-  if (EntityExists(entity)) {
+  if (EntityIsValid(entity)) {
     entityInfo = GetEntInfo(entity);
     spriteStatus = 0;
     flag = TRUE;

diff --git a/src/code_804267C.c b/src/code_804267C.c
@@ -104,7 +104,7 @@ void sub_80427AC(void)
 
     for (i = 0; i < 20; i++) {
         entity = gDungeon->activePokemon[i];
-        if (EntityExists(entity)) {
+        if (EntityIsValid(entity)) {
             enInfo = GetEntInfo(entity);
             if (enInfo->unkF3) {
                 enInfo->unkF3 = FALSE;