Add rng rigging and config to function test engines; add pokerus tests; misc pokerus changes

Author: FosterProgramming

include/config/pokerus.h

@@ -2,13 +2,20 @@
 #define GUARD_CONFIG_POKERUS_H
 
 //For pokerus, we refer to infection as a pokemon catching Pokerus from an enemy pokemon (trainer or wild) and we refer to spreading as pokemon catching pokerus from another infected pokemon in the party
-#define P_POKERUS_ENABLED                TRUE       // If FALSE, Pokerus will have no effect, won't be shown and won't be aquired in any way but save data won't be affected
-#define P_POKERUS_STRAIN_DISTRIBUTION    GEN_LATEST // Pokerus has 16 different strains and their probability distribution change depending on generation
-#define P_POKERUS_SPREAD_ADJACENECY      GEN_LATEST // In Gen 2, Pokerus spread to one adjacent pokemon but it spreads to both adjacent pokemon in gen 3+
-#define P_POKERUS_SPREAD_DAYS_LEFT       GEN_LATEST // In Gen 2, a freshly spreaded pokemon will get its full infection duration based on strain. In gen 3+, the pokerus duration will copy the duration from the pokemon it was spreaded from
-#define P_POKERUS_INFECT_AGAIN           TRUE       // If TRUE, your party can get infected even when it is already infected with Pokerus (doesn't affect spreading, only TRUE in gen 2)
-#define P_POKERUS_INFECT_EGG             FALSE      // If TRUE, eggs can receive Pokerus from spread and direction infection (gen 2). If FALSE, eggs can receive Pokerus from spread but not direct infection (gen 3). Behavior is unknown in other gens.
-#define P_POKERUS_VISIBLE_ON_EGG         TRUE       // Controls if eggs can show pokerus symbol in summary screen (TRUE from gen 3 to 6, FALSE in gen 2,7 and 8)
-#define P_POKERUS_INFECTION_FLAG         0          // If Pokerus can only get infected if this flag is set or undefined (0). This emulates a gen 2 mechanic where Pokemon can only get infected by Pokerus after visiting Goldernrod. This does not affect spreading
+#define POKERUS_ENABLED                TRUE       // If FALSE, Pokerus will have no effect, won't be shown and won't be aquired in any way but save data won't be affected
+#define POKERUS_STRAIN_DISTRIBUTION    GEN_LATEST // Pokerus has 16 different strains and their probability distribution change depending on generation
+#define POKERUS_SPREAD_ADJACENCY       GEN_LATEST // In Gen 2, Pokerus spread to one adjacent pokemon but it spreads to both adjacent pokemon in gen 3+
+#define POKERUS_SPREAD_DAYS_LEFT       GEN_LATEST // In Gen 2, a freshly spreaded pokemon will get its full infection duration based on strain. In gen 3+, the pokerus duration will copy the duration from the pokemon it was spreaded from
+#define POKERUS_INFECT_AGAIN           TRUE       // If TRUE, your party can get infected even when it is already infected with Pokerus (doesn't affect spreading, only TRUE in gen 2)
+#define POKERUS_INFECT_EGG             FALSE      // If TRUE, eggs can receive Pokerus from spread and direction infection (gen 2). If FALSE, eggs can receive Pokerus from spread but not direct infection (gen 3). Behavior is unknown in other gens.
+#define POKERUS_VISIBLE_ON_EGG         TRUE       // Controls if eggs can show pokerus symbol in summary screen (TRUE from gen 3 to 6, FALSE in gen 2,7 and 8)
+#define POKERUS_FLAG_INFECTION         0          // If Pokerus can only get infected if this flag is set or undefined (0). This emulates a gen 2 mechanic where Pokemon can only get infected by Pokerus after visiting Goldernrod. This does not affect spreading
+
+//Weird Pokerus behaviors that could be considered bugs. They are TRUE in vanilla Emerald but set to FALSE by default in Expansion (behaviors in other gens is unknown)
+#define POKERUS_HERD_IMMUNITY          FALSE      // If TRUE, pokemon who have been previously infected by the pokerus in your party reduce the chances of your party getting infected by the Pokerus (because they can be rolled at the target of the infection but are now "immune")
+#define POKERUS_WEAK_VARIANT           FALSE      // If TRUE, the variant 0 of pokerus can be erased by stronger variant when Pokerus is spreading
+
+#define POKERUS_INFECTION_ODDS 3 // Actual probability is POKERUS_INFECTION_ODDS/65536
+#define POKERUS_SPREAD_ODDS 21846 // Actual probability is POKERUS_SPREAD_ODDS/65536 (21846 should correspond to the vanilla Random() % 3)
 
 #endif // GUARD_CONFIG_POKERUS_H

include/constants/generational_changes.h

@@ -41,6 +41,14 @@ enum GenConfigTag
     GEN_CONFIG_PRANKSTER_DARK_TYPES,
     GEN_CONFIG_DESTINY_BOND_FAIL,
     GEN_CONFIG_POWDER_RAIN,
+    POKERUS_CONFIG_ENABLED,
+    POKERUS_CONFIG_STRAIN_DISTRIBUTION,
+    POKERUS_CONFIG_SPREAD_ADJACENCY,
+    POKERUS_CONFIG_SPREAD_DAYS_LEFT,
+    POKERUS_CONFIG_INFECT_AGAIN,
+    POKERUS_CONFIG_INFECT_EGG,
+    POKERUS_CONFIG_HERD_IMMUNITY,
+    POKERUS_CONFIG_WEAK_VARIANT,
     GEN_CONFIG_COUNT
 };
 

include/generational_changes.h

@@ -3,7 +3,7 @@
 
 #include "constants/generational_changes.h"
 #include "config/battle.h"
-
+#include "config/pokerus.h"
 static const u8 sGenerationalChanges[GEN_CONFIG_COUNT] =
 {
     [GEN_CONFIG_CRIT_CHANCE]               = B_CRIT_CHANCE,
@@ -44,6 +44,13 @@ static const u8 sGenerationalChanges[GEN_CONFIG_COUNT] =
     [GEN_CONFIG_PRANKSTER_DARK_TYPES]      = B_PRANKSTER_DARK_TYPES,
     [GEN_CONFIG_DESTINY_BOND_FAIL]         = B_DESTINY_BOND_FAIL,
     [GEN_CONFIG_POWDER_RAIN]               = B_POWDER_RAIN,
+    [POKERUS_CONFIG_ENABLED]               = POKERUS_ENABLED,
+    [POKERUS_CONFIG_SPREAD_ADJACENCY]      = POKERUS_SPREAD_ADJACENCY,
+    [POKERUS_CONFIG_SPREAD_DAYS_LEFT]      = POKERUS_SPREAD_DAYS_LEFT,
+    [POKERUS_CONFIG_INFECT_AGAIN]          = POKERUS_INFECT_AGAIN,
+    [POKERUS_CONFIG_INFECT_EGG]            = POKERUS_INFECT_EGG,
+    [POKERUS_CONFIG_HERD_IMMUNITY]         = POKERUS_HERD_IMMUNITY,
+    [POKERUS_CONFIG_WEAK_VARIANT]          = POKERUS_WEAK_VARIANT,
 };
 
 #if TESTING

include/pokerus.h

@@ -1,11 +1,12 @@
 #ifndef GUARD_POKERUS_H
 #define GUARD_POKERUS_H
 
-void RandomlyGivePartyPokerus(struct Pokemon *party);
-u8 CheckPartyPokerus(struct Pokemon *party);
-u8 CheckMonPokerus(struct Pokemon *mon);
-u8 CheckMonHasHadPokerus(struct Pokemon *mon);
+u32 GetDaysLeftBasedOnStrain(u32 strain);
+void RandomlyGivePartyPokerus(void);
+bool32 CheckPartyPokerus(void);
+bool32 CheckMonPokerus(struct Pokemon *mon);
+bool32 CheckMonHasHadPokerus(struct Pokemon *mon);
 void UpdatePartyPokerusTime(u16 days);
-void PartySpreadPokerus(struct Pokemon *party);
+void PartySpreadPokerus(void);
 
 #endif // GUARD_POKERUS_H

include/random.h

@@ -215,6 +215,11 @@ enum RandomTag
     RNG_AI_REFRESH_TRICK_ROOM_ON_LAST_TURN,
     RNG_AI_APPLY_TAILWIND_ON_LAST_TURN_OF_TRICK_ROOM,
     RNG_WRAP,
+    RNG_POKERUS_PARTY_MEMBER,
+    RNG_POKERUS_INFECTION,
+    RNG_POKERUS_STRAIN_DISTRIBUTION,
+    RNG_POKERUS_SPREAD,
+    RNG_POKERUS_SPREAD_SIDE,
 };
 
 #define RandomWeighted(tag, ...) \

include/test/battle.h

@@ -622,18 +622,12 @@ struct QueuedEvent
     } as;
 };
 
-struct TurnRNG
-{
-    u16 tag;
-    u16 value;
-};
-
 struct BattlerTurn
 {
     u8 hit:2;
     u8 criticalHit:2;
     u8 secondaryEffect:2;
-    struct TurnRNG rng;
+    struct RiggedRNG rng;
 };
 
 struct ExpectedAIAction
@@ -969,7 +963,7 @@ enum { TURN_CLOSED, TURN_OPEN, TURN_CLOSING };
 #define SKIP_TURN(battler) SkipTurn(__LINE__, battler)
 #define SEND_OUT(battler, partyIndex) SendOut(__LINE__, battler, partyIndex)
 #define USE_ITEM(battler, ...) UseItem(__LINE__, battler, (struct ItemContext) { R_APPEND_TRUE(__VA_ARGS__) })
-#define WITH_RNG(tag, value) rng: ((struct TurnRNG) { tag, value })
+#define WITH_RNG(tag, value) rng: ((struct RiggedRNG) { tag, value })
 
 struct MoveContext
 {
@@ -994,7 +988,7 @@ struct MoveContext
     u16 explicitNotExpected:1;
     struct BattlePokemon *target;
     bool8 explicitTarget;
-    struct TurnRNG rng;
+    struct RiggedRNG rng;
     bool8 explicitRNG;
 };
 

include/test/test.h

@@ -2,6 +2,7 @@
 #define GUARD_TEST_H
 
 #include "test_runner.h"
+#include "random.h"
 
 #define MAX_PROCESSES 32 // See also tools/mgba-rom-test-hydra/main.c
 
@@ -89,6 +90,14 @@ extern struct FunctionTestRunnerState *gFunctionTestRunnerState;
 extern struct TestRunnerState gTestRunnerState;
 extern struct PersistentTestRunnerState gPersistentTestRunnerState;
 
+struct RiggedRNG
+{
+    u16 tag;
+    u16 value;
+};
+
+extern EWRAM_DATA struct RiggedRNG gRiggedRngList[8];
+
 void CB2_TestRunner(void);
 
 void Test_ExpectedResult(enum TestResult);
@@ -97,6 +106,8 @@ void Test_ExpectCrash(bool32);
 void Test_ExitWithResult(enum TestResult, u32 stopLine, const char *fmt, ...);
 u32 SourceLine(u32 sourceLineOffset);
 u32 SourceLineOffset(u32 sourceLine);
+void SetupRiggedRng(u32 sourceLine, enum RandomTag randomTag, u32 value);
+void ClearRiggedRng();
 
 s32 Test_MgbaPrintf(const char *fmt, ...);
 
@@ -245,6 +256,8 @@ static inline struct Benchmark BenchmarkStop(void)
 
 #define PARAMETRIZE_LABEL(f, label) if (gFunctionTestRunnerState->parameters++ == gFunctionTestRunnerState->runParameter && (Test_MgbaPrintf(":N%s: " f " (%d/%d)", gTestRunnerState.test->name, label, gFunctionTestRunnerState->runParameter + 1, gFunctionTestRunnerState->parameters), 1))
 
+#define SET_RNG(tag, value) SetupRiggedRng(__LINE__, tag, value)
+
 #define TO_DO \
     do { \
         Test_ExpectedResult(TEST_RESULT_TODO); \

src/battle_main.c

@@ -5733,8 +5733,9 @@ static void ReturnFromBattleToOverworld(void)
 {
     if (!(gBattleTypeFlags & BATTLE_TYPE_LINK))
     {
-        RandomlyGivePartyPokerus(gPlayerParty);
-        PartySpreadPokerus(gPlayerParty);
+        CalculatePlayerPartyCount();
+        RandomlyGivePartyPokerus();
+        PartySpreadPokerus();
     }
 
     if (gBattleTypeFlags & BATTLE_TYPE_LINK && gReceivedRemoteLinkPlayers)

src/field_specials.c

@@ -1490,7 +1490,7 @@ bool8 ScriptCheckFreePokemonStorageSpace(void)
 
 bool8 IsPokerusInParty(void)
 {
-    return CheckPartyPokerus(gPlayerParty);
+    return CheckPartyPokerus();
 }
 
 // Task data for Task_ShakeCamera

src/party_menu.c

@@ -2135,7 +2135,7 @@ u8 GetMonAilment(struct Pokemon *mon)
     ailment = GetAilmentFromStatus(GetMonData(mon, MON_DATA_STATUS));
     if (ailment != AILMENT_NONE)
         return ailment;
-    if (CheckMonPokerus(mon) && (P_POKERUS_VISIBLE_ON_EGG || !GetMonData(mon, MON_DATA_IS_EGG)))
+    if (CheckMonPokerus(mon) && (POKERUS_VISIBLE_ON_EGG || !GetMonData(mon, MON_DATA_IS_EGG)))
         return AILMENT_PKRS;
     return AILMENT_NONE;
 }