Merge pull request #108 from PikalaxALT/itemfinder

Itemfinder

asm/field_control_avatar.s

@@ -1152,24 +1152,24 @@ _0806D174:
 _0806D17A:
 	ldr r0, [r5, 0x8]
 	movs r1, 0x3
-	bl sub_80CC44C
+	bl GetHiddenItemAttr
 	lsls r0, 16
 	lsrs r0, 16
 	cmp r0, 0x1
 	beq _0806D164
 	ldr r0, [r5, 0x8]
 	movs r1, 0
-	bl sub_80CC44C
+	bl GetHiddenItemAttr
 	ldr r1, _0806D1C4 @ =gSpecialVar_0x8005
 	strh r0, [r1]
 	ldr r0, [r5, 0x8]
 	movs r1, 0x1
-	bl sub_80CC44C
+	bl GetHiddenItemAttr
 	ldr r4, _0806D1C8 @ =gSpecialVar_0x8004
 	strh r0, [r4]
 	ldr r0, [r5, 0x8]
 	movs r1, 0x2
-	bl sub_80CC44C
+	bl GetHiddenItemAttr
 	ldr r1, _0806D1CC @ =gSpecialVar_0x8006
 	strh r0, [r1]
 	ldrh r0, [r4]
@@ -1180,14 +1180,14 @@ _0806D17A:
 	beq _0806D164
 	ldr r0, _0806D1D0 @ =gSpecialVar_Facing
 	strh r6, [r0]
-	ldr r0, _0806D1D4 @ =gUnknown_81A6843
+	ldr r0, _0806D1D4 @ =EventScript_PickUpHiddenItem
 	b _0806D1E6
 	.align 2, 0
 _0806D1C4: .4byte gSpecialVar_0x8005
 _0806D1C8: .4byte gSpecialVar_0x8004
 _0806D1CC: .4byte gSpecialVar_0x8006
 _0806D1D0: .4byte gSpecialVar_Facing
-_0806D1D4: .4byte gUnknown_81A6843
+_0806D1D4: .4byte EventScript_PickUpHiddenItem
 _0806D1D8:
 	cmp r2, 0xFF
 	beq _0806D1E0

asm/field_specials.s

@@ -185,8 +185,8 @@ sub_80CA74C: @ 80CA74C
 _080CA754: .4byte gBattleOutcome
 	thumb_func_end sub_80CA74C
 
-	thumb_func_start sub_80CA758
+	thumb_func_start Special_SetHiddenItemFlag
-sub_80CA758: @ 80CA758
+Special_SetHiddenItemFlag: @ 80CA758
 	push {lr}
 	ldr r0, _080CA768 @ =gSpecialVar_0x8004
 	ldrh r0, [r0]
@@ -195,7 +195,7 @@ sub_80CA758: @ 80CA758
 	bx r0
 	.align 2, 0
 _080CA768: .4byte gSpecialVar_0x8004
-	thumb_func_end sub_80CA758
+	thumb_func_end Special_SetHiddenItemFlag
 
 	thumb_func_start sub_80CA76C
 sub_80CA76C: @ 80CA76C
@@ -1566,8 +1566,9 @@ _080CB1D2:
 	bx r1
 	thumb_func_end sub_80CB198
 
-	thumb_func_start sub_80CB1D8
+	thumb_func_start Special_CheckAddCoins
-sub_80CB1D8: @ 80CB1D8
+Special_CheckAddCoins: @ 80CB1D8
+@ addcoins but it's a dry run
 	push {lr}
 	ldr r0, _080CB1F0 @ =gSpecialVar_Result
 	ldrh r1, [r0]
@@ -1588,7 +1589,7 @@ _080CB1FC:
 _080CB1FE:
 	pop {r1}
 	bx r1
-	thumb_func_end sub_80CB1D8
+	thumb_func_end Special_CheckAddCoins
 
 	thumb_func_start sub_80CB204
 sub_80CB204: @ 80CB204
@@ -3942,8 +3943,8 @@ _080CC444: .4byte gSpecialVar_0x8004
 _080CC448: .4byte gSpecialVar_0x8006
 	thumb_func_end sub_80CC3CC
 
-	thumb_func_start sub_80CC44C
+	thumb_func_start GetHiddenItemAttr
-sub_80CC44C: @ 80CC44C
+GetHiddenItemAttr: @ 80CC44C
 	push {lr}
 	lsls r1, 24
 	lsrs r1, 24
@@ -3980,7 +3981,7 @@ _080CC484:
 _080CC486:
 	pop {r1}
 	bx r1
-	thumb_func_end sub_80CC44C
+	thumb_func_end GetHiddenItemAttr
 
 	thumb_func_start sub_80CC48C
 sub_80CC48C: @ 80CC48C

data/itemfinder.s

@@ -1,11 +0,0 @@
-	.section .rodata
-	.align 2
-
-gUnknown_84644D0:: @ 84644D0
-	.incbin "baserom.gba", 0x4644D0, 0x314
-
-gUnknown_84647E4:: @ 84647E4
-	.incbin "baserom.gba", 0x4647E4, 0x18
-
-gUnknown_84647FC:: @ 84647FC
-	.incbin "baserom.gba", 0x4647FC, 0x8

data/map_event_scripts.inc

@@ -1576,27 +1576,23 @@ EventScript_1A661D:: @ 81A661D
 	waitmessage
 	applymovement VAR_LAST_TALKED, Movement_1A666C
 	waitmovement 0
-	loadword 0, Text_1A5511
+	msgbox Text_1A5511
-	callstd 4
 	return
 
 EventScript_1A6636:: @ 81A6636
 	checkflag 2114
 	goto_if_eq EventScript_1A661D
-	loadword 0, Text_1A552B
+	msgbox Text_1A552B
-	callstd 4
 	setflag 2114
 	message Text_1BCCCA
 	waitmessage
 	applymovement VAR_LAST_TALKED, Movement_1A666C
 	waitmovement 0
-	loadword 0, Text_1A5511
+	msgbox Text_1A5511
-	callstd 4
 	return
 
 EventScript_1A6663:: @ 81A6663
-	loadword 0, Text_1A5511
+	msgbox Text_1A5511
-	callstd 4
 	return
 
 Movement_1A666C:: @ 81A666C
@@ -1681,8 +1677,7 @@ EventScript_1A6749:: @ 81A6749
 	message Text_1A51F6
 	waitfanfare
 	waitmessage
-	loadword 0, gUnknown_81A5218
+	msgbox gUnknown_81A5218
-	callstd 4
 	setvar VAR_RESULT, 1
 	return
 
@@ -1717,8 +1712,7 @@ EventScript_1A6795:: @ 81A6795
 	message Text_1A52F0
 	waitfanfare
 	waitmessage
-	loadword 0, gUnknown_81A532F
+	msgbox gUnknown_81A532F
-	callstd 4
 	setvar VAR_RESULT, 1
 	return
 
@@ -1755,8 +1749,7 @@ EventScript_1A67EE:: @ 81A67EE
 	call_if 1, EventScript_1A6827
 	waitfanfare
 	waitmessage
-	loadword 0, gUnknown_81A5218
+	msgbox gUnknown_81A5218
-	callstd 4
 	return
 
 EventScript_1A6821:: @ 81A6821
@@ -1768,15 +1761,100 @@ EventScript_1A6827:: @ 81A6827
 	return
 
 EventScript_1A682D:: @ 81A682D
-	loadword 0, Text_1A51F6
+	msgbox Text_1A51F6
-	callstd 4
+	msgbox gUnknown_81A5242
-	loadword 0, gUnknown_81A5242
-	callstd 4
 	setvar VAR_RESULT, 0
 	return
 
-gUnknown_81A6843:: @ 81A6843
+EventScript_PickUpHiddenItem:: @ 81A6843
-	.incbin "baserom.gba", 0x1A6843, 0x112
+	lockall
+	textcolor 3
+	waitse
+	compare_var_to_value VAR_0x8005, 0
+	goto_if_eq EventScript_PickUpHiddenCoins
+	call EventScript_GiveItem
+	compare_var_to_value VAR_0x8007, 1
+	goto_if_eq EventScript_ItemInPocketMessage
+	compare_var_to_value VAR_0x8007, 0
+	goto_if_eq EventScript_BagIsFullMessage
+	end
+
+EventScript_GiveItem::
+	additem VAR_0x8005, VAR_0x8006
+	copyvar VAR_0x8007, VAR_RESULT
+	getitemname 1, VAR_0x8005
+	checkitemtype VAR_0x8005
+	call EventScript_1A66BC
+	return
+
+EventScript_ItemInPocketMessage::
+	compare_var_to_value VAR_0x8006, 1
+	call_if 1, EventScript_FoundSingleItemMessage
+	compare_var_to_value VAR_0x8006, 1
+	call_if 5, EventScript_FoundMultipleItemsMessage
+	waitfanfare
+	waitmessage
+	msgbox gUnknown_81A5218
+	special Special_SetHiddenItemFlag
+	releaseall
+	end
+
+EventScript_FoundSingleItemMessage::
+	message Text_1A5231
+	return
+
+EventScript_FoundCoinsMessage::
+	getnumberstring 0, VAR_0x8006
+	message Text_1A525C
+	return
+
+EventScript_FoundMultipleItemsMessage::
+	getnumberstring 0, VAR_0x8006
+	message Text_1A52DD
+	return
+
+EventScript_BagIsFullMessage::
+	msgbox Text_1A5231
+	msgbox gUnknown_81A5242
+	setvar VAR_RESULT, 0
+	releaseall
+	end
+
+EventScript_PickUpHiddenCoins::
+	checkflag FLAG_GOT_COIN_CASE
+	goto_if 0, EventScript_HiddenCoinsButNoCoinCase
+	checkcoins VAR_RESULT
+	specialvar VAR_RESULT, Special_CheckAddCoins
+	compare_var_to_value VAR_RESULT, 0
+	goto_if_eq EventScript_HiddenCoinsButTheCoinCaseIsFull
+	givecoins VAR_0x8006
+	getstdstring 1, 0x17
+	call EventScript_1A6764
+	call EventScript_FoundCoinsMessage
+	waitfanfare
+	waitmessage
+	msgbox Text_1A526C
+	special Special_SetHiddenItemFlag
+	releaseall
+	end
+
+EventScript_HiddenCoinsButTheCoinCaseIsFull::
+	getnumberstring 0, VAR_0x8006
+	getstdstring 1, 0x17
+	msgbox Text_1A525C
+	msgbox Text_1A5294
+	setvar VAR_RESULT, 0
+	releaseall
+	end
+
+EventScript_HiddenCoinsButNoCoinCase::
+	getnumberstring 0, VAR_0x8006
+	getstdstring 1, 0x17
+	msgbox Text_1A525C
+	msgbox Text_1A52B4
+	setvar VAR_RESULT, 0
+	releaseall
+	end
 
 gUnknown_81A6955:: @ 81A6955
 	.incbin "baserom.gba", 0x1A6955, 0x173
@@ -2275,8 +2353,33 @@ ViridianCity_PokemonCenter_2F_EventScript_1A8D02:: @ 81A8D02
 VermilionCity_PokemonCenter_1F_EventScript_1A8D08:: @ 81A8D08
 	.incbin "baserom.gba", 0x1A8D08, 0x41
 
-gUnknown_81A8D49:: @ 81A8D49
+EventScript_ItemfinderDigUpUnderfootItem:: @ 81A8D49
-	.incbin "baserom.gba", 0x1A8D49, 0x4E
+	lockall
+	textcolor 3
+	waitse
+	call EventScript_GiveItem
+	compare_var_to_value VAR_0x8007, 1
+	goto_if_eq EventScript_DigUpItemPutInPocket
+	compare_var_to_value VAR_0x8007, 0
+	goto_if_eq EventScript_DigUpItemBagIsFull
+	end
+
+EventScript_DigUpItemPutInPocket::
+	message Text_1A5700
+	waitfanfare
+	waitmessage
+	delay 60
+	msgbox gUnknown_81A5218
+	special Special_SetHiddenItemFlag
+	releaseall
+	end
+
+EventScript_DigUpItemBagIsFull::
+	msgbox Text_1A5700
+	msgbox gUnknown_81A5242
+	setvar VAR_RESULT, 0
+	releaseall
+	end
 
 gUnknown_81A8D97:: @ 81A8D97
 	.incbin "baserom.gba", 0x1A8D97, 0x41

data/maps/CeladonCity_GameCorner/scripts.inc

@@ -39,7 +39,7 @@ CeladonCity_GameCorner_EventScript_16C68D:: @ 816C68D
 	end
 
 EventScript_16C6E6:: @ 816C6E6
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16C790
 	compare_var_to_value VAR_0x8009, 0
 	goto_if_eq EventScript_16C734
@@ -134,7 +134,7 @@ CeladonCity_GameCorner_EventScript_16C7E7:: @ 816C7E7
 	checkflag FLAG_0x26E
 	goto_if_eq EventScript_16C849
 	msgbox gUnknown_8196AF3
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16C839
 	checkcoins VAR_0x4001
 	compare_var_to_value VAR_0x4001, 9990
@@ -198,7 +198,7 @@ CeladonCity_GameCorner_EventScript_16C89E:: @ 816C89E
 	checkflag FLAG_0x26F
 	goto_if_eq EventScript_16C8F0
 	msgbox gUnknown_8196D2B
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16C839
 	checkcoins VAR_0x4001
 	compare_var_to_value VAR_0x4001, 9980
@@ -228,7 +228,7 @@ CeladonCity_GameCorner_EventScript_16C8FE:: @ 816C8FE
 	checkflag FLAG_0x270
 	goto_if_eq EventScript_16C950
 	msgbox gUnknown_8196DB7
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16C839
 	checkcoins VAR_0x4001
 	compare_var_to_value VAR_0x4001, 9980
@@ -263,7 +263,7 @@ EventScript_16C96A:: @ 816C96A
 	end
 
 EventScript_16C96C:: @ 816C96C
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16CAA0
 	msgbox gUnknown_8196F46, MSGBOX_YESNO
 	compare_var_to_value VAR_RESULT, 0

data/maps/CeladonCity_GameCorner_PrizeRoom/scripts.inc

@@ -12,7 +12,7 @@ CeladonCity_GameCorner_PrizeRoom_EventScript_16CB7F:: @ 816CB7F
 CeladonCity_GameCorner_PrizeRoom_EventScript_16CB88:: @ 816CB88
 	lock
 	faceplayer
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16CD99
 	special sub_8110AB4
 	compare_var_to_value VAR_RESULT, 2
@@ -191,7 +191,7 @@ EventScript_16CE12:: @ 816CE12
 CeladonCity_GameCorner_PrizeRoom_EventScript_16CE1D:: @ 816CE1D
 	lock
 	faceplayer
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16CD99
 	special sub_8110AB4
 	compare_var_to_value VAR_RESULT, 2
@@ -289,7 +289,7 @@ EventScript_16CF79:: @ 816CF79
 CeladonCity_GameCorner_PrizeRoom_EventScript_16CF88:: @ 816CF88
 	lock
 	faceplayer
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if 0, EventScript_16CD99
 	special sub_8110AB4
 	compare_var_to_value VAR_RESULT, 2

data/maps/CeladonCity_Restaurant/scripts.inc

@@ -12,7 +12,7 @@ CeladonCity_Restaurant_EventScript_16D1F4:: @ 816D1F4
 CeladonCity_Restaurant_EventScript_16D1FD:: @ 816D1FD
 	lock
 	faceplayer
-	checkflag FLAG_0x243
+	checkflag FLAG_GOT_COIN_CASE
 	goto_if_eq EventScript_16D24B
 	msgbox gUnknown_81979C1
 	checkitemspace ITEM_COIN_CASE, 1
@@ -20,7 +20,7 @@ CeladonCity_Restaurant_EventScript_16D1FD:: @ 816D1FD
 	goto_if_eq EventScript_16D241
 	additem ITEM_COIN_CASE, 1
 	giveitemfanfaremsg gUnknown_8197A38, ITEM_COIN_CASE
-	setflag FLAG_0x243
+	setflag FLAG_GOT_COIN_CASE
 	release
 	end
 

data/specials.inc

@@ -159,7 +159,7 @@ gSpecials:: @ 815FD60
 	def_special sub_80CA6BC
 	def_special sub_80CA6DC
 	def_special sub_80CA714
-	def_special sub_80CA758
+	def_special Special_SetHiddenItemFlag
 	def_special nullsub_75
 	def_special nullsub_75
 	def_special Overworld_PlaySpecialMapMusic
@@ -359,7 +359,7 @@ gSpecials:: @ 815FD60
 	def_special sub_80CADEC
 	def_special sub_805D1A8
 	def_special sub_80CB0A8
-	def_special sub_80CB1D8
+	def_special Special_CheckAddCoins
 	def_special GetDaycarePokemonCount
 	def_special sub_80CB63C
 	def_special sub_80CBD80

data/strings.s

@@ -582,13 +582,13 @@ gUnknown_8416425:: @ 8416425
 gUnknown_8416451:: @ 8416451
 	.string "You can't dismount your BIKE here.{PAUSE_UNTIL_PRESS}$"
 
-gUnknown_8416476:: @ 8416476
+gText_ItemfinderResponding:: @ 8416476
 	.string "Huh?\nThe ITEMFINDER's responding!\pThere's an item buried around here!{PAUSE_UNTIL_PRESS}$"
 
-gUnknown_84164BE:: @ 84164BE
+gText_ItemfinderShakingWildly:: @ 84164BE
 	.string "Oh!\nThe ITEMFINDER's shaking wildly!\pThere's an item buried underfoot!\p‥ ‥ ‥ ‥ ‥ ‥{PAUSE_UNTIL_PRESS}$"
 
-gUnknown_8416513:: @ 8416513
+gText_NopeTheresNoResponse:: @ 8416513
 	.string "‥ ‥ ‥ ‥Nope!\nThere's no response.{PAUSE_UNTIL_PRESS}$"
 
 gUnknown_8416537:: @ 8416537

include/constants/flags.h

@@ -668,7 +668,7 @@
 #define FLAG_0x240               0x240
 #define FLAG_0x241               0x241
 #define FLAG_0x242               0x242
-#define FLAG_0x243               0x243
+#define FLAG_GOT_COIN_CASE               0x243
 #define FLAG_0x244               0x244
 #define FLAG_0x245               0x245
 #define FLAG_0x246               0x246

include/event_scripts.h

@@ -1153,4 +1153,6 @@ extern const u8 EventScript_SafariRetire[];
 extern const u8 EventScript_SafariWarpOut[];
 extern const u8 EventScript_SafariOutOfBalls[];
 
+extern const u8 EventScript_ItemfinderDigUpUnderfootItem[];
+
 #endif //GUARD_EVENT_SCRIPTS_H

include/field_specials.h

@@ -3,6 +3,14 @@
 
 #include "global.h"
 
+enum HiddenItemAttr
+{
+    HIDDEN_ITEM_ID = 0,
+    HIDDEN_ITEM_FLAG,
+    HIDDEN_ITEM_QUANTITY,
+    HIDDEN_ITEM_UNDERFOOT
+};
+
 u8 GetLeadMonIndex(void);
 u8 CountDigits(u16 number);
 void TV_PrintIntToStringVar(u8, int);
@@ -14,5 +22,6 @@ u8 ContextNpcGetTextColor(void);
 void set_unknown_box_id(u8);
 u16 get_unknown_box_id(void);
 bool8 sub_80CC7B4(void);
+u16 GetHiddenItemAttr(struct HiddenItemStruct hiddenItem, u8 attr);
 
 #endif // GUARD_FIELD_SPECIALS_H

include/fieldmap.h

@@ -23,5 +23,7 @@ bool8 MapGridIsImpassableAt(s32, s32);
 s32 GetMapBorderIdAt(s32, s32);
 bool32 CanCameraMoveInDirection(s32);
 u32 GetBehaviorByMetatileIdAndMapData(struct MapData *mapData, u16 metatile, u8 attr);
+const struct MapHeader * mapconnection_get_mapheader(struct MapConnection * connection);
+struct MapConnection * GetMapConnectionAtPos(s16 x, s16 y);
 
 #endif //GUARD_FIELDMAP_H

include/global.fieldmap.h

@@ -120,26 +120,34 @@ struct CoordEvent
     u8 *script;
 };
 
+struct HiddenItemStruct
+{
+    u32 itemId:16;
+    u32 hiddenItemId:8; // flag offset to determine flag lookup
+    u32 quantity:7;
+    u32 isUnderfoot:1;
+};
+
+union BgUnion
+{ // carried over from diego's FR/LG work, seems to be the same struct
+    // in gen 3, "kind" (0x3 in BgEvent struct) determines the method to read the union.
+    u8 *script;
+
+    // hidden item type probably
+    struct HiddenItemStruct hiddenItem;
+
+    // secret base type
+    u32 secretBaseId;
+
+};
+
 struct BgEvent
 {
     u16 x, y;
     u8 unk4;
     u8 kind;
     // 0x2 padding for the union beginning.
-    union { // carried over from diego's FR/LG work, seems to be the same struct
+    union BgUnion bgUnion;
-        // in gen 3, "kind" (0x3 in BgEvent struct) determines the method to read the union.
-        u8 *script;
-
-        // hidden item type probably
-        struct {
-            u8 filler6[0x2];
-            u16 hiddenItemId; // flag offset to determine flag lookup
-        } hiddenItem;
-
-        // secret base type
-        u32 secretBaseId;
-
-    } bgUnion;
 };
 
 struct MapEvents

include/itemfinder.h

@@ -1,6 +1,6 @@
 #ifndef GUARD_ITEMFINDER_H
 #define GUARD_ITEMFINDER_H
 
-void sub_813EC8C(u8 taskId);
+void ItemUseOnFieldCB_Itemfinder(u8 taskId);
 
 #endif //GUARD_ITEMFINDER_H

include/strings.h

@@ -324,4 +324,9 @@ extern const u8 gText_ThrowAwayStrVar2OfThisItemQM[];
 extern const u8 gText_BerryPouch[];
 extern const u8 gText_TheBerryPouchWillBePutAway[];
 
+// itemfinder
+extern const u8 gText_ItemfinderResponding[];
+extern const u8 gText_ItemfinderShakingWildly[];
+extern const u8 gText_NopeTheresNoResponse[];
+
 #endif //GUARD_STRINGS_H

ld_script.txt

@@ -252,7 +252,7 @@ SECTIONS {
         asm/wild_pokemon_area.o(.text);
         src/dynamic_placeholder_text_util.o(.text);
         src/berry_pouch.o(.text);
-        asm/itemfinder.o(.text);
+        src/itemfinder.o(.text);
         src/buy_menu_helpers.o(.text);
         src/slot_machine.o(.text);
         src/roamer.o(.text);
@@ -467,7 +467,7 @@ SECTIONS {
         data/wild_pokemon_area.o(.rodata);
         src/dynamic_placeholder_text_util.o(.rodata);
         src/berry_pouch.o(.rodata);
-        data/itemfinder.o(.rodata);
+        src/itemfinder.o(.rodata);
         src/buy_menu_helpers.o(.rodata);
         src/slot_machine.o(.rodata);
         src/roamer.o(.rodata);

src/fieldmap.c

@@ -833,7 +833,7 @@ s32 sub_80596FC(struct MapConnection *connection, s32 x, s32 y)
     return FALSE;
 }
 
-struct MapConnection *sub_805973C(s16 x, s16 y)
+struct MapConnection *GetMapConnectionAtPos(s16 x, s16 y)
 {
     s32 count;
     struct MapConnection *connection;

src/item_use.c

@@ -274,7 +274,7 @@ void ItemUseOnFieldCB_Rod(u8 taskId)
 void ItemUseOutOfBattle_Itemfinder(u8 taskId)
 {
     IncrementGameStat(GAME_STAT_USED_ITEMFINDER);
-    sItemUseOnFieldCB = sub_813EC8C;
+    sItemUseOnFieldCB = ItemUseOnFieldCB_Itemfinder;
     sub_80A103C(taskId);
 }
 

src/itemfinder.c

@@ -0,0 +1,659 @@
+#include "global.h"
+#include "task.h"
+#include "new_menu_helpers.h"
+#include "strings.h"
+#include "event_scripts.h"
+#include "map_obj_lock.h"
+#include "script.h"
+#include "sound.h"
+#include "event_data.h"
+#include "field_player_avatar.h"
+#include "field_specials.h"
+#include "fieldmap.h"
+#include "itemfinder.h"
+#include "constants/songs.h"
+
+static void Task_NoResponse_CleanUp(u8 taskId);
+static void Task_ItemfinderResponseSoundsAndAnims(u8 taskId);
+static void Task_ItemfinderUnderfootSoundsAndAnims(u8 taskId);
+static bool8 HiddenItemIsWithinRangeOfPlayer(struct MapEvents * events, u8 taskId);
+static void SetUnderfootHiddenItem(u8 taskId, struct HiddenItemStruct hiddenItem);
+static void SetNormalHiddenItem(u8 taskId);
+static void FindHiddenItemsInConnectedMaps(u8 taskId);
+static void RegisterHiddenItemRelativeCoordsIfCloser(u8 taskId, s16 dx, s16 dy);
+static u8 GetPlayerDirectionTowardsHiddenItem(s16 itemX, s16 itemY);
+static void Task_ItemfinderResponsePrintMessage(u8 taskId);
+static void Task_ItemfinderResponseCleanUp(u8 taskId);
+static void Task_ItemfinderUnderfootPrintMessage(u8 taskId);
+static void Task_ItemfinderUnderfootDigUpItem(u8 taskId);
+static void DestroyArrowAndStarTiles(void);
+static void LoadArrowAndStarTiles(void);
+static void CreateArrowSprite(u8 animNum, u8 direction);
+static void SpriteCallback_Arrow(struct Sprite * sprite);
+static void SpriteCallback_DestroyArrow(struct Sprite * sprite);
+static u8 CreateStarSprite(void);
+static void SpriteCallback_Star(struct Sprite * sprite);
+static void SpriteCallback_DestroyStar(struct Sprite * sprite);
+
+#define ARROW_TILE_TAG 2000
+
+static const u16 sArrowAndStarSpriteTiles[] = INCBIN_U16("data/itemfinder/spr_tiles.4bpp");
+
+static const union AnimCmd sArrowAnim0[] = {
+    ANIMCMD_FRAME( 0, 10),
+    ANIMCMD_END
+};
+
+static const union AnimCmd sArrowAnim1[] = {
+    ANIMCMD_FRAME( 4, 10),
+    ANIMCMD_END
+};
+
+static const union AnimCmd sArrowAnim2[] = {
+    ANIMCMD_FRAME( 8, 10),
+    ANIMCMD_END
+};
+
+static const union AnimCmd sArrowAnim3[] = {
+    ANIMCMD_FRAME(12, 10),
+    ANIMCMD_END
+};
+
+static const union AnimCmd sStarAnim[] = {
+    ANIMCMD_FRAME(16, 10),
+    ANIMCMD_END
+};
+
+static const union AnimCmd *const sArrowAndStarSpriteAnimTable[] = {
+    sArrowAnim0,
+    sArrowAnim1,
+    sArrowAnim2,
+    sArrowAnim3,
+    sStarAnim
+};
+
+static const struct OamData sArrowAndStarSpriteOamData = {
+    .affineMode = ST_OAM_AFFINE_NORMAL,
+    .shape = ST_OAM_SQUARE,
+    .size = ST_OAM_SIZE_1
+};
+
+static const union AffineAnimCmd sAffineAnim_Left[] = {
+    AFFINEANIMCMD_FRAME(0, 0, 0x00, 1),
+    AFFINEANIMCMD_END
+};
+
+static const union AffineAnimCmd sAffineAnim_Down[] = {
+    AFFINEANIMCMD_FRAME(0, 0, 0x40, 1),
+    AFFINEANIMCMD_END
+};
+
+static const union AffineAnimCmd sAffineAnim_Right[] = {
+    AFFINEANIMCMD_FRAME(0, 0, 0x80, 1),
+    AFFINEANIMCMD_END
+};
+
+static const union AffineAnimCmd sAffineAnim_Up[] = {
+    AFFINEANIMCMD_FRAME(0, 0, 0xc0, 1),
+    AFFINEANIMCMD_END
+};
+
+static const union AffineAnimCmd *const sArrowAndStarSpriteAffineAnimTable[] = {
+    sAffineAnim_Left,
+    sAffineAnim_Down,
+    sAffineAnim_Right,
+    sAffineAnim_Up
+};
+
+static const struct SpriteTemplate gUnknown_84647E4 = {
+    .tileTag = ARROW_TILE_TAG,
+    .paletteTag = 0xFFFF,
+    .oam = &sArrowAndStarSpriteOamData,
+    .anims = sArrowAndStarSpriteAnimTable,
+    .affineAnims = sArrowAndStarSpriteAffineAnimTable,
+    .callback = SpriteCallback_Arrow
+};
+
+static const struct SpriteSheet sArrowAndStarSpriteSheet = {
+    .data = sArrowAndStarSpriteTiles,
+    .size = sizeof(sArrowAndStarSpriteTiles),
+    .tag = ARROW_TILE_TAG
+};
+
+#define tItemX data[0]
+#define tItemY data[1]
+#define tHiddenItemFound data[2]
+#define tDingTimer data[3]
+#define tNumDingsRemaining data[4]
+#define tDingNum data[5]
+#define tUnderfoot data[6]
+#define tStartSpriteId data[7]
+
+void ItemUseOnFieldCB_Itemfinder(u8 taskId)
+{
+    u8 i;
+    for (i = 0; i < 16; i++)
+        gTasks[taskId].data[i] = 0;
+    if (HiddenItemIsWithinRangeOfPlayer(gMapHeader.events, taskId) == TRUE)
+    {
+        LoadArrowAndStarTiles();
+        if (gTasks[taskId].tUnderfoot == TRUE)
+            gTasks[taskId].func = Task_ItemfinderUnderfootSoundsAndAnims;
+        else
+            gTasks[taskId].func = Task_ItemfinderResponseSoundsAndAnims;
+    }
+    else
+    {
+        DisplayItemMessageOnField(taskId, 2, gText_NopeTheresNoResponse, Task_NoResponse_CleanUp);
+    }
+}
+
+static void Task_NoResponse_CleanUp(u8 taskId)
+{
+    ClearDialogWindowAndFrame(0, TRUE);
+    sub_80696C0();
+    ScriptContext2_Disable();
+    DestroyTask(taskId);
+}
+
+static void Task_ItemfinderResponseSoundsAndAnims(u8 taskId)
+{
+    s16 *data = gTasks[taskId].data;
+    u8 direction;
+    if (tDingTimer % 25 == 0)
+    {
+        direction = GetPlayerDirectionTowardsHiddenItem(tItemX, tItemY);
+        if (tNumDingsRemaining == 0)
+        {
+            gTasks[taskId].func = Task_ItemfinderResponsePrintMessage;
+            return;
+        }
+        else
+        {
+            PlaySE(SE_TOY_F);
+            CreateArrowSprite(tDingNum, direction);
+            tDingNum++;
+            tNumDingsRemaining--;
+        }
+    }
+    tDingTimer++;
+}
+
+static void Task_ItemfinderUnderfootSoundsAndAnims(u8 taskId)
+{
+    s16 *data = gTasks[taskId].data;
+    if (tDingTimer % 25 == 0)
+    {
+        if (tNumDingsRemaining == 0)
+        {
+            gTasks[taskId].func = Task_ItemfinderUnderfootPrintMessage;
+            return;
+        }
+        else
+        {
+            PlaySE(SE_TOY_F);
+            tStartSpriteId = CreateStarSprite();
+            tDingNum++;
+            tNumDingsRemaining--;
+        }
+    }
+    tDingTimer++;
+}
+
+static bool8 HiddenItemIsWithinRangeOfPlayer(struct MapEvents * events, u8 taskId)
+{
+    s16 x, y, i, dx, dy;
+    PlayerGetDestCoords(&x, &y);
+    gTasks[taskId].tHiddenItemFound = FALSE;
+    for (i = 0; i < events->bgEventCount; i++)
+    {
+        if (events->bgEvents[i].kind == 7 && !FlagGet(GetHiddenItemAttr(events->bgEvents[i].bgUnion.hiddenItem, HIDDEN_ITEM_FLAG)))
+        {
+            dx = events->bgEvents[i].x + 7 - x;
+            dy = events->bgEvents[i].y + 7 - y;
+            if (GetHiddenItemAttr(events->bgEvents[i].bgUnion.hiddenItem, HIDDEN_ITEM_UNDERFOOT) == TRUE)
+            {
+                if (dx == 0 && dy == 0)
+                {
+                    SetUnderfootHiddenItem(taskId, events->bgEvents[i].bgUnion.hiddenItem);
+                    return TRUE;
+                }
+            }
+            else if (
+                dx >= -7
+             && dx <=  7
+             && dy >= -5
+             && dy <=  5
+            )
+            {
+                RegisterHiddenItemRelativeCoordsIfCloser(taskId, dx, dy);
+            }
+        }
+    }
+    FindHiddenItemsInConnectedMaps(taskId);
+    if (gTasks[taskId].tHiddenItemFound == TRUE)
+    {
+        SetNormalHiddenItem(taskId);
+        return TRUE;
+    }
+    return FALSE;
+}
+
+static void SetUnderfootHiddenItem(u8 taskId, struct HiddenItemStruct hiddenItem)
+{
+    s16 *data = gTasks[taskId].data;
+    gSpecialVar_0x8004 = GetHiddenItemAttr(hiddenItem, HIDDEN_ITEM_FLAG);
+    gSpecialVar_0x8005 = GetHiddenItemAttr(hiddenItem, HIDDEN_ITEM_ID);
+    gSpecialVar_0x8006 = 1;
+    TV_PrintIntToStringVar(0, gSpecialVar_0x8005);
+    tHiddenItemFound = TRUE;
+    tItemX = 0;
+    tItemY = 0;
+    tNumDingsRemaining = 3;
+    tUnderfoot = TRUE;
+}
+
+static void SetNormalHiddenItem(u8 taskId)
+{
+    s16 *data = gTasks[taskId].data;
+    s16 absY = tItemY;
+    s16 absX = tItemX;
+    
+    // The strength of the response increases inversely with distance to the item.
+    if (tItemX == 0 && tItemY == 0)
+        tNumDingsRemaining = 4;
+    else
+    {
+        if (tItemX < 0)
+            absX = tItemX * -1;
+        if (tItemY < 0)
+            absY = tItemY * -1;
+        if (absX > absY)
+        {
+            if (absX > 3)
+                tNumDingsRemaining = 2;
+            else
+                tNumDingsRemaining = 4;
+        }
+        else
+        {
+            if (absY > 3)
+                tNumDingsRemaining = 2;
+            else
+                tNumDingsRemaining = 4;
+        }
+    }
+}
+
+static bool8 HiddenItemAtPos(struct MapEvents * events, s16 x, s16 y)
+{
+    u8 bgEventCount = events->bgEventCount;
+    struct BgEvent * bgEvents = events->bgEvents;
+    u16 eventFlag;
+    int i;
+
+    for (i = 0; i < bgEventCount; i++)
+    {
+        if (
+            bgEvents[i].kind == 7
+         && x == bgEvents[i].x
+         && y == bgEvents[i].y
+        )
+        {
+            eventFlag = GetHiddenItemAttr(bgEvents[i].bgUnion.hiddenItem, HIDDEN_ITEM_FLAG);
+            if (GetHiddenItemAttr(bgEvents[i].bgUnion.hiddenItem, HIDDEN_ITEM_UNDERFOOT) != TRUE && !FlagGet(eventFlag))
+                return TRUE;
+            else
+                return FALSE;
+        }
+    }
+    return FALSE;
+}
+
+static bool8 HiddenItemInConnectedMapAtPos(struct MapConnection * connection, s32 x, s32 y)
+{
+    const struct MapHeader * mapHeader;
+    u16 localX, localY;
+    u32 localOffset;
+    s32 localLength;
+
+    mapHeader = mapconnection_get_mapheader(connection);
+
+    switch (connection->direction)
+    {
+    // same weird temp variable behavior seen in HiddenItemAtPos
+    case 2:
+        localOffset = connection->offset + 7;
+        localX = x - localOffset;
+        localLength = mapHeader->mapData->height - 7;
+        localY = localLength + y; // additions are reversed for some reason
+        break;
+    case 1:
+        localOffset = connection->offset + 7;
+        localX = x - localOffset;
+        localLength = gMapHeader.mapData->height + 7;
+        localY = y - localLength;
+        break;
+    case 3:
+        localLength = mapHeader->mapData->width - 7;
+        localX = localLength + x; // additions are reversed for some reason
+        localOffset = connection->offset + 7;
+        localY = y - localOffset;
+        break;
+    case 4:
+        localLength = gMapHeader.mapData->width + 7;
+        localX = x - localLength;
+        localOffset = connection->offset + 7;
+        localY = y - localOffset;
+        break;
+    default:
+        return FALSE;
+    }
+    return HiddenItemAtPos(mapHeader->events, localX, localY);
+}
+
+static void FindHiddenItemsInConnectedMaps(u8 taskId)
+{
+    s16 x, y;
+    s16 curX, curY;
+    s16 width = gMapHeader.mapData->width + 7;
+    s16 height = gMapHeader.mapData->height + 7;
+
+    s16 var1 = 7;
+    s16 var2 = 7;
+
+    PlayerGetDestCoords(&x, &y);
+
+    for (curX = x - 7; curX <= x + 7; curX++)
+    {
+        for (curY = y - 5; curY <= y + 5; curY++)
+        {
+            if (var1 > curX
+                || curX >= width
+                || var2 > curY
+                || curY >= height)
+            {
+                struct MapConnection * conn = GetMapConnectionAtPos(curX, curY);
+                if (conn != NULL && HiddenItemInConnectedMapAtPos(conn, curX, curY) == TRUE)
+                    RegisterHiddenItemRelativeCoordsIfCloser(taskId, curX - x, curY - y);
+            }
+        }
+    }
+}
+
+static void RegisterHiddenItemRelativeCoordsIfCloser(u8 taskId, s16 dx, s16 dy)
+{
+    s16 *data = gTasks[taskId].data;
+    s16 dx2, dy2, dx3, dy3;
+
+    if (tHiddenItemFound == FALSE)
+    {
+        tItemX = dx;
+        tItemY = dy;
+        tHiddenItemFound = TRUE;
+    }
+    else
+    {
+        // tItemX and tItemY contain the player's coordinates.
+        // dx and dy contain the item's coordinates.
+        if (tItemX < 0)
+            dx2 = tItemX * -1; // item is to the left
+        else
+            dx2 = tItemX; // item is to the right
+
+        if (tItemY < 0)
+            dy2 = tItemY * -1; // item is to the north
+        else
+            dy2 = tItemY; // item is to the south
+
+        if (dx < 0)
+            dx3 = dx * -1;
+        else
+            dx3 = dx;
+
+        if (dy < 0)
+            dy3 = dy * -1;
+        else
+            dy3 = dy;
+
+        if (dx2 + dy2 > dx3 + dy3)
+        {
+            tItemX = dx;
+            tItemY = dy;
+        }
+        else
+        {
+            if (dx2 + dy2 == dx3 + dy3 && (dy2 > dy3 || (dy2 == dy3 && tItemY < dy)))
+            {
+                tItemX = dx;
+                tItemY = dy;
+            }
+        }
+    }
+}
+
+static u8 GetPlayerDirectionTowardsHiddenItem(s16 itemX, s16 itemY)
+{
+    s16 abX, abY;
+
+    if (itemX == 0 && itemY == 0)
+        return DIR_NONE; // player is standing on the item.
+
+    // get absolute X distance.
+    if (itemX < 0)
+        abX = itemX * -1;
+    else
+        abX = itemX;
+
+    // get absolute Y distance.
+    if (itemY < 0)
+        abY = itemY * -1;
+    else
+        abY = itemY;
+
+    if (abX > abY)
+    {
+        if (itemX < 0)
+            return DIR_EAST;
+        else
+            return DIR_NORTH;
+    }
+    else
+    {
+        if (abX < abY)
+        {
+            if (itemY < 0)
+                return DIR_SOUTH;
+            else
+                return DIR_WEST;
+        }
+        if (abX == abY)
+        {
+            if (itemY < 0)
+                return DIR_SOUTH;
+            else
+                return DIR_WEST;
+        }
+        return DIR_NONE; // should never get here. return something so it doesnt crash.
+    }
+}
+
+static void Task_ItemfinderResponsePrintMessage(u8 taskId)
+{
+    DisplayItemMessageOnField(taskId, 2, gText_ItemfinderResponding, Task_ItemfinderResponseCleanUp);
+}
+
+static void Task_ItemfinderResponseCleanUp(u8 taskId)
+{
+    DestroyArrowAndStarTiles();
+    ClearDialogWindowAndFrame(0, TRUE);
+    sub_80696C0();
+    ScriptContext2_Disable();
+    DestroyTask(taskId);
+}
+
+static void Task_ItemfinderUnderfootPrintMessage(u8 taskId)
+{
+    DisplayItemMessageOnField(taskId, 2, gText_ItemfinderShakingWildly, Task_ItemfinderUnderfootDigUpItem);
+}
+
+static void Task_ItemfinderUnderfootDigUpItem(u8 taskId)
+{
+    DestroyArrowAndStarTiles();
+    DestroyTask(taskId);
+    ScriptContext1_SetupScript(EventScript_ItemfinderDigUpUnderfootItem);
+    ScriptContext2_Enable();
+}
+
+#undef tStartSpriteId
+#undef tUnderfoot
+#undef tDingNum
+#undef tNumDingsRemaining
+#undef tDingTimer
+#undef tHiddenItemFound
+#undef tItemY
+#undef tItemX
+
+#define spData0 data[0]
+#define spDeltaX data[1]
+#define spDeltaY data[2]
+#define spCurX data[3]
+#define spCurY data[4]
+#define spCenterX data[5]
+#define spCenterY data[6]
+#define spAnimNum data[7]
+
+static void LoadArrowAndStarTiles(void)
+{
+    LoadSpriteSheet(&sArrowAndStarSpriteSheet);
+}
+
+static void DestroyArrowAndStarTiles(void)
+{
+    FreeSpriteTilesByTag(ARROW_TILE_TAG);
+}
+
+static void CreateArrowSprite(u8 animNum, u8 direction)
+{
+    u8 spriteId = CreateSprite(&gUnknown_84647E4, 120, 76, 0);
+    gSprites[spriteId].oam.paletteNum = 0;
+    StartSpriteAnim(&gSprites[spriteId], animNum);
+    gSprites[spriteId].spAnimNum = animNum;
+    gSprites[spriteId].spData0 = 0;
+    gSprites[spriteId].spCurX = 0;
+    gSprites[spriteId].spCurY = 0;
+    gSprites[spriteId].spCenterX = 120;
+    gSprites[spriteId].spCenterY = 76;
+    switch (direction)
+    {
+    case DIR_NONE:
+        switch (GetPlayerFacingDirection())
+        {
+        case DIR_WEST:
+            gSprites[spriteId].spDeltaX = -100;
+            gSprites[spriteId].spDeltaY = 0;
+            StartSpriteAffineAnim(&gSprites[spriteId], 0);
+            break;
+        case DIR_NORTH:
+            gSprites[spriteId].spDeltaX = 0;
+            gSprites[spriteId].spDeltaY = -100;
+            StartSpriteAffineAnim(&gSprites[spriteId], 3);
+            break;
+        case DIR_EAST:
+            gSprites[spriteId].spDeltaX = 100;
+            gSprites[spriteId].spDeltaY = 0;
+            StartSpriteAffineAnim(&gSprites[spriteId], 2);
+            break;
+        case DIR_SOUTH:
+            gSprites[spriteId].spDeltaX = 0;
+            gSprites[spriteId].spDeltaY = 100;
+            StartSpriteAffineAnim(&gSprites[spriteId], 1);
+            break;
+        }
+        break;
+    case DIR_SOUTH:
+        gSprites[spriteId].spDeltaX = 0;
+        gSprites[spriteId].spDeltaY = -100;
+        StartSpriteAffineAnim(&gSprites[spriteId], 3);
+        break;
+    case DIR_NORTH:
+        gSprites[spriteId].spDeltaX = 100;
+        gSprites[spriteId].spDeltaY = 0;
+        StartSpriteAffineAnim(&gSprites[spriteId], 2);
+        break;
+    case DIR_WEST:
+        gSprites[spriteId].spDeltaX = 0;
+        gSprites[spriteId].spDeltaY = 100;
+        StartSpriteAffineAnim(&gSprites[spriteId], 1);
+        break;
+    case DIR_EAST:
+        gSprites[spriteId].spDeltaX = -100;
+        gSprites[spriteId].spDeltaY = 0;
+        break;
+    }
+}
+
+static void SpriteCallback_Arrow(struct Sprite * sprite)
+{
+    s16 x, y;
+    sprite->spCurX += sprite->spDeltaX;
+    sprite->spCurY += sprite->spDeltaY;
+    sprite->pos1.x = sprite->spCenterX + (sprite->spCurX >> 8);
+    sprite->pos1.y = sprite->spCenterY + (sprite->spCurY >> 8);
+    if (sprite->pos1.x <= 104
+     || sprite->pos1.x > 132
+     || sprite->pos1.y <= 60
+     || sprite->pos1.y > 88)
+        sprite->callback = SpriteCallback_DestroyArrow;
+}
+
+static void SpriteCallback_DestroyArrow(struct Sprite * sprite)
+{
+    FreeSpriteOamMatrix(sprite);
+    DestroySprite(sprite);
+}
+
+static u8 CreateStarSprite(void)
+{
+    u8 spriteId = CreateSprite(&gUnknown_84647E4, 120, 76, 0);
+    gSprites[spriteId].oam.paletteNum = 0;
+    gSprites[spriteId].callback = SpriteCallback_Star;
+    StartSpriteAnim(&gSprites[spriteId], 4);
+    gSprites[spriteId].spAnimNum = 0;
+    gSprites[spriteId].spData0 = 0;
+    gSprites[spriteId].spCurX = 0;
+    gSprites[spriteId].spCurY = 0;
+    gSprites[spriteId].spCenterX = 120;
+    gSprites[spriteId].spCenterY = 76;
+    gSprites[spriteId].spDeltaX = 0;
+    gSprites[spriteId].spDeltaY = -100;
+    return spriteId;
+}
+
+static void SpriteCallback_Star(struct Sprite * sprite)
+{
+    s16 x, y;
+    sprite->spCurX += sprite->spDeltaX;
+    sprite->spCurY += sprite->spDeltaY;
+    sprite->pos1.x = sprite->spCenterX + (sprite->spCurX >> 8);
+    sprite->pos1.y = sprite->spCenterY + (sprite->spCurY >> 8);
+    if (sprite->pos1.x <= 104
+        || sprite->pos1.x > 132
+        || sprite->pos1.y <= 60
+        || sprite->pos1.y > 88)
+        sprite->callback = SpriteCallback_DestroyStar;
+}
+
+static void SpriteCallback_DestroyStar(struct Sprite * sprite)
+{
+    DestroySprite(sprite);
+}
+
+#undef spAnimNum
+#undef spCenterY
+#undef spCenterX
+#undef spCurY
+#undef spCurX
+#undef spDeltaY
+#undef spDeltaX
+#undef spData0