Merge pull request #2319 from AsparagusEduardo/RHH/pr/Lures

Implemented Lures and Repel/Lure "use another" menu

data/event_scripts.s

@@ -30,6 +30,7 @@
 #include "constants/frontier_util.h"
 #include "constants/game_stat.h"
 #include "constants/item.h"
+#include "constants/item_config.h"
 #include "constants/items.h"
 #include "constants/heal_locations.h"
 #include "constants/layouts.h"

data/scripts/repel.inc

@@ -1,6 +1,115 @@
 EventScript_RepelWoreOff::
+.if I_REPEL_LURE_MENU == TRUE
+	checkitem ITEM_REPEL, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_RepelUseAnother
+	checkitem ITEM_SUPER_REPEL, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_RepelUseAnother
+	checkitem ITEM_MAX_REPEL, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_RepelUseAnother
+.else
+	checkitem VAR_LAST_REPEL_LURE_USED, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_RepelUseAnother
+.endif
+	lock
 	msgbox Text_RepelWoreOff, MSGBOX_SIGN
+	release
+	end
+
+EventScript_RepelUseAnother:
+	lock
+	msgbox Text_UseAnotherRepel, MSGBOX_YESNO
+.if I_REPEL_LURE_MENU == TRUE
+	callnative TryDrawRepelMenu
+	goto_if_eq VAR_RESULT, FALSE, EventScript_RepelWoreOff_Chose
+	waitstate
+	goto_if_eq VAR_RESULT, 127, EventScript_RepelWoreOff_End
+EventScript_RepelWoreOff_Chose:
+	callnative HandleRepelMenuChoice
+	bufferitemname 1, VAR_0x8004
+	removeitem VAR_0x8004, 1
+	playse SE_REPEL
+	msgbox Text_UsedNewRepelLure, MSGBOX_SIGN
+.else
+	goto_if_eq VAR_RESULT, YES, EventScript_UsedRepel
+.endif
+EventScript_RepelWoreOff_End:
+	release
+	end
+
+EventScript_UsedRepel:
+	bufferitemname 1, VAR_LAST_REPEL_LURE_USED
+	playse SE_REPEL
+	lock
+	msgbox Text_UsedNewRepelLure, MSGBOX_SIGN
+	removeitem VAR_LAST_REPEL_LURE_USED, 1
+	waitse
+	callnative HandleUseExpiredRepel
+	release
+	end
+
+EventScript_LureWoreOff::
+.if I_REPEL_LURE_MENU == TRUE
+	checkitem ITEM_LURE, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_LureUseAnother
+	checkitem ITEM_SUPER_LURE, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_LureUseAnother
+	checkitem ITEM_MAX_LURE, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_LureUseAnother
+.else
+	checkitem VAR_LAST_REPEL_LURE_USED, 1
+	goto_if_eq VAR_RESULT, TRUE, EventScript_LureUseAnother
+.endif
+	lock
+	msgbox Text_LureWoreOff, MSGBOX_SIGN
+	release
+	end
+
+EventScript_LureUseAnother:
+	lock
+	msgbox Text_UseAnotherLure, MSGBOX_YESNO
+.if I_REPEL_LURE_MENU == TRUE
+	callnative TryDrawLureMenu
+	goto_if_eq VAR_RESULT, FALSE, EventScript_LureWoreOff_Chose
+	waitstate
+	goto_if_eq VAR_RESULT, 127, EventScript_LureWoreOff_End
+EventScript_LureWoreOff_Chose:
+	callnative HandleLureMenuChoice
+	bufferitemname 1, VAR_0x8004
+	removeitem VAR_0x8004, 1
+	playse SE_REPEL
+	msgbox Text_UsedNewRepelLure, MSGBOX_SIGN
+.else
+	goto_if_eq VAR_RESULT, YES, EventScript_UsedLure
+.endif
+EventScript_LureWoreOff_End:
+	release
+	end
+
+EventScript_UsedLure:
+	bufferitemname 1, VAR_LAST_REPEL_LURE_USED
+	playse SE_REPEL
+	lock
+	msgbox Text_UsedNewRepelLure, MSGBOX_SIGN
+	removeitem VAR_LAST_REPEL_LURE_USED, 1
+	waitse
+	callnative HandleUseExpiredLure
+	release
 	end
 
 Text_RepelWoreOff:
 	.string "REPEL's effect wore off…$"
+
+Text_UseAnotherRepel::
+	.string "REPEL's effect wore off!\n"
+	.string "Use another?$"
+
+Text_LureWoreOff:
+	.string "Lure's effect wore off…$"
+
+Text_UseAnotherLure::
+	.string "Lure's effect wore off!\n"
+	.string "Use another?$"
+
+Text_UsedNewRepelLure::
+	.string "{PLAYER} used the\n"
+	.string "{STR_VAR_2}.$"

include/constants/item.h

@@ -16,4 +16,10 @@
 #define KEYITEMS_POCKET    4
 #define POCKETS_COUNT      5
 
+#define REPEL_LURE_MASK         (1 << 15)
+#define IS_LAST_USED_LURE(var)  (var & REPEL_LURE_MASK)
+#define REPEL_LURE_STEPS(var)   (var & (REPEL_LURE_MASK - 1))
+#define LURE_STEP_COUNT         (IS_LAST_USED_LURE(VarGet(VAR_REPEL_STEP_COUNT)) ? REPEL_LURE_STEPS(VarGet(VAR_REPEL_STEP_COUNT)) : 0)
+#define REPEL_STEP_COUNT        (!IS_LAST_USED_LURE(VarGet(VAR_REPEL_STEP_COUNT)) ? REPEL_LURE_STEPS(VarGet(VAR_REPEL_STEP_COUNT)) : 0)
+
 #endif // GUARD_ITEM_CONSTANTS_H

include/constants/item_config.h

@@ -9,4 +9,9 @@
 #define I_SITRUS_BERRY_HEAL     GEN_LATEST  // In Gen4+, Sitrus Berry was changed from healing 30 HP to healing 25% of Max HP.
 #define I_VITAMIN_EV_CAP        GEN_LATEST  // In Gen8, the Vitamins no longer have a cap of 100 EV per stat.
 
+// Repel/Lure config
+// These two settings are both independent and complementary.
+#define VAR_LAST_REPEL_LURE_USED    0       // If this var has been assigned, last Repel/Lure used will be saved and the player will get prompted with the vanilla repel YES/NO option, unless I_REPEL_LURE_MENU is set to TRUE.
+#define I_REPEL_LURE_MENU           TRUE    // If TRUE, the player is able to choose which Repel/Lure to use once the previous one runs out. Cursor position is saved by VAR_LAST_REPEL_LURE_USED if not 0.
+
 #endif // GUARD_CONSTANTS_ITEM_CONFIG_H

include/item_use.h

@@ -20,6 +20,7 @@ void ItemUseOutOfBattle_PPUp(u8);
 void ItemUseOutOfBattle_RareCandy(u8);
 void ItemUseOutOfBattle_TMHM(u8);
 void ItemUseOutOfBattle_Repel(u8);
+void ItemUseOutOfBattle_Lure(u8);
 void ItemUseOutOfBattle_EscapeRope(u8);
 void ItemUseOutOfBattle_BlackWhiteFlute(u8);
 void ItemUseOutOfBattle_EvolutionStone(u8);

include/strings.h

@@ -938,6 +938,7 @@ extern const u8 gText_BootedUpTM[];
 extern const u8 gText_TMHMContainedVar1[];
 extern const u8 gText_PlayerUsedVar2[];
 extern const u8 gText_RepelEffectsLingered[];
+extern const u8 gText_LureEffectsLingered[];
 extern const u8 gText_UsedVar2WildLured[];
 extern const u8 gText_UsedVar2WildRepelled[];
 extern const u8 gText_BoxFull[];

src/data/items.h

@@ -1565,7 +1565,7 @@ const struct Item gItems[] =
         .description = sLureDesc,
         .pocket = POCKET_ITEMS,
         .type = ITEM_USE_BAG_MENU,
-        .fieldUseFunc = ItemUseOutOfBattle_CannotUse,
+        .fieldUseFunc = ItemUseOutOfBattle_Lure,
         .secondaryId = 0,
         .flingPower = 30,
     },
@@ -1579,7 +1579,7 @@ const struct Item gItems[] =
         .description = sSuperLureDesc,
         .pocket = POCKET_ITEMS,
         .type = ITEM_USE_BAG_MENU,
-        .fieldUseFunc = ItemUseOutOfBattle_CannotUse,
+        .fieldUseFunc = ItemUseOutOfBattle_Lure,
         .secondaryId = 0,
         .flingPower = 30,
     },
@@ -1593,7 +1593,7 @@ const struct Item gItems[] =
         .description = sMaxLureDesc,
         .pocket = POCKET_ITEMS,
         .type = ITEM_USE_BAG_MENU,
-        .fieldUseFunc = ItemUseOutOfBattle_CannotUse,
+        .fieldUseFunc = ItemUseOutOfBattle_Lure,
         .secondaryId = 0,
         .flingPower = 30,
     },

src/item_use.c

@@ -67,7 +67,9 @@ static void Task_ShowTMHMContainedMessage(u8);
 static void UseTMHMYesNo(u8);
 static void UseTMHM(u8);
 static void Task_StartUseRepel(u8);
+static void Task_StartUseLure(u8 taskId);
 static void Task_UseRepel(u8);
+static void Task_UseLure(u8 taskId);
 static void Task_CloseCantUseKeyItemMessage(u8);
 static void SetDistanceOfClosestHiddenItem(u8, s16, s16);
 static void CB2_OpenPokeblockFromBag(void);
@@ -846,7 +848,7 @@ static void RemoveUsedItem(void)
 
 void ItemUseOutOfBattle_Repel(u8 taskId)
 {
-    if (VarGet(VAR_REPEL_STEP_COUNT) == 0)
+    if (REPEL_STEP_COUNT == 0)
         gTasks[taskId].func = Task_StartUseRepel;
     else if (!InBattlePyramid())
         DisplayItemMessage(taskId, FONT_NORMAL, gText_RepelEffectsLingered, CloseItemMessage);
@@ -871,6 +873,53 @@ static void Task_UseRepel(u8 taskId)
     if (!IsSEPlaying())
     {
         VarSet(VAR_REPEL_STEP_COUNT, ItemId_GetHoldEffectParam(gSpecialVar_ItemId));
+    #if VAR_LAST_REPEL_LURE_USED != 0
+        VarSet(VAR_LAST_REPEL_LURE_USED, gSpecialVar_ItemId);
+    #endif
+        RemoveUsedItem();
+        if (!InBattlePyramid())
+            DisplayItemMessage(taskId, FONT_NORMAL, gStringVar4, CloseItemMessage);
+        else
+            DisplayItemMessageInBattlePyramid(taskId, gStringVar4, Task_CloseBattlePyramidBagMessage);
+    }
+}
+void HandleUseExpiredRepel(void)
+{
+#if VAR_LAST_REPEL_LURE_USED != 0
+    VarSet(VAR_REPEL_STEP_COUNT, ItemId_GetHoldEffectParam(VarGet(VAR_LAST_REPEL_LURE_USED)));
+#endif
+}
+
+void ItemUseOutOfBattle_Lure(u8 taskId)
+{
+    if (LURE_STEP_COUNT == 0)
+        gTasks[taskId].func = Task_StartUseLure;
+    else if (!InBattlePyramid())
+        DisplayItemMessage(taskId, FONT_NORMAL, gText_LureEffectsLingered, CloseItemMessage);
+    else
+        DisplayItemMessageInBattlePyramid(taskId, gText_LureEffectsLingered, Task_CloseBattlePyramidBagMessage);
+}
+
+static void Task_StartUseLure(u8 taskId)
+{
+    s16* data = gTasks[taskId].data;
+
+    if (++data[8] > 7)
+    {
+        data[8] = 0;
+        PlaySE(SE_REPEL);
+        gTasks[taskId].func = Task_UseLure;
+    }
+}
+
+static void Task_UseLure(u8 taskId)
+{
+    if (!IsSEPlaying())
+    {
+        VarSet(VAR_REPEL_STEP_COUNT, ItemId_GetHoldEffectParam(gSpecialVar_ItemId) | REPEL_LURE_MASK);
+    #if VAR_LAST_REPEL_LURE_USED != 0
+        VarSet(VAR_LAST_REPEL_LURE_USED, gSpecialVar_ItemId);
+    #endif
         RemoveUsedItem();
         if (!InBattlePyramid())
             DisplayItemMessage(taskId, FONT_NORMAL, gStringVar4, CloseItemMessage);
@@ -879,6 +928,13 @@ static void Task_UseRepel(u8 taskId)
     }
 }
 
+void HandleUseExpiredLure(void)
+{
+#if VAR_LAST_REPEL_LURE_USED != 0
+    VarSet(VAR_REPEL_STEP_COUNT, ItemId_GetHoldEffectParam(VarGet(VAR_LAST_REPEL_LURE_USED)) | REPEL_LURE_MASK);
+#endif
+}
+
 static void Task_UsedBlackWhiteFlute(u8 taskId)
 {
     if(++gTasks[taskId].data[8] > 7)

src/pokemon.c

@@ -3329,30 +3329,31 @@ void CreateBoxMon(struct BoxPokemon *boxMon, u16 species, u8 level, u8 fixedIV,
     }
     else // Player is the OT
     {
-        u32 shinyValue;
         value = gSaveBlock2Ptr->playerTrainerId[0]
               | (gSaveBlock2Ptr->playerTrainerId[1] << 8)
               | (gSaveBlock2Ptr->playerTrainerId[2] << 16)
               | (gSaveBlock2Ptr->playerTrainerId[3] << 24);
 
         if (gBaseStats[species].flags & SPECIES_FLAG_SHINY_LOCKED)
         {
-            do
+            while (GET_SHINY_VALUE(value, personality) < SHINY_ODDS)
             {
-                // Choose random personalities until one that results in a non-shiny Pokémon
                 personality = Random32();
-                shinyValue = HIHALF(value) ^ LOHALF(value) ^ HIHALF(personality) ^ LOHALF(personality);
-            } while (shinyValue < SHINY_ODDS);
+            }
         }
-        else if (CheckBagHasItem(ITEM_SHINY_CHARM, 1))
+        else
         {
-            u32 rolls = 0;
-            do
+            u32 totalRerolls = 0;
+            if (CheckBagHasItem(ITEM_SHINY_CHARM, 1))
+                totalRerolls += I_SHINY_CHARM_REROLLS;
+            if (LURE_STEP_COUNT != 0)
+                totalRerolls += 1;
+
+            while (GET_SHINY_VALUE(value, personality) >= SHINY_ODDS && totalRerolls > 0)
             {
                 personality = Random32();
-                shinyValue = HIHALF(value) ^ LOHALF(value) ^ HIHALF(personality) ^ LOHALF(personality);
-                rolls++;
-            } while (shinyValue >= SHINY_ODDS && rolls < I_SHINY_CHARM_REROLLS);
+                totalRerolls--;
+            }
         }
     }