PKHeX/PKHeX.Core/Legality/Verifiers/LevelVerifier.cs
Kurt 95fbf66a6e
Refactor: Gen3/4 Lead Encounters, property fixing (#4193)
In addition to the Method 1 (and other sibling PIDIV types) correlation, an encounter can only be triggered if the calls prior land on the Method {1} seed. The RNG community has dubbed these patterns as "Method J" (D/P/Pt), "Method K" (HG/SS), and "Method H" (Gen3, coined by yours truly). The basic gist of these is that they are pre-requisites, like the Shadow locks of Colosseum/XD. 

Rename/re-type a bunch of properties to get the codebase more in line with correct property names & more obvious underlying types.
2024-02-22 21:20:54 -06:00

140 lines
5.2 KiB
C#

using static PKHeX.Core.LegalityCheckStrings;
namespace PKHeX.Core;
/// <summary>
/// Verifies the <see cref="PKM.CurrentLevel"/>.
/// </summary>
public sealed class LevelVerifier : Verifier
{
protected override CheckIdentifier Identifier => CheckIdentifier.Level;
public override void Verify(LegalityAnalysis data)
{
var pk = data.Entity;
var enc = data.EncounterOriginal;
if (enc is MysteryGift gift)
{
if (!IsMetLevelMatchEncounter(gift, pk))
{
data.AddLine(GetInvalid(LLevelMetGift));
return;
}
if (gift.Level > pk.CurrentLevel)
{
data.AddLine(GetInvalid(LLevelMetGiftFail));
return;
}
}
if (pk.IsEgg)
{
if (pk.CurrentLevel != enc.LevelMin)
{
data.AddLine(GetInvalid(string.Format(LEggFMetLevel_0, enc.LevelMin)));
return;
}
var reqEXP = enc is EncounterStatic2 { DizzyPunchEgg: true }
? 125 // Gen2 Dizzy Punch gifts always have 125 EXP, even if it's more than the Lv5 exp required.
: Experience.GetEXP(enc.LevelMin, pk.PersonalInfo.EXPGrowth);
if (reqEXP != pk.EXP)
data.AddLine(GetInvalid(LEggEXP));
return;
}
var lvl = pk.CurrentLevel;
if (lvl >= 100)
{
var expect = Experience.GetEXP(100, pk.PersonalInfo.EXPGrowth);
if (pk.EXP != expect)
data.AddLine(GetInvalid(LLevelEXPTooHigh));
}
if (lvl < pk.MetLevel)
data.AddLine(GetInvalid(LLevelMetBelow));
else if (!enc.IsWithinEncounterRange(pk) && lvl != 100 && pk.EXP == Experience.GetEXP(lvl, pk.PersonalInfo.EXPGrowth))
data.AddLine(Get(LLevelEXPThreshold, Severity.Fishy));
else
data.AddLine(GetValid(LLevelMetSane));
}
private static bool IsMetLevelMatchEncounter(MysteryGift gift, PKM pk)
{
if (gift.Level == pk.MetLevel)
return true;
if (!pk.HasOriginalMetLocation)
return true;
return gift switch
{
WC3 wc3 when wc3.MetLevel == pk.MetLevel || wc3.IsEgg => true,
WC7 wc7 when wc7.MetLevel == pk.MetLevel => true,
PGT { IsManaphyEgg: true } when pk.MetLevel == 0 => true,
_ => false,
};
}
public void VerifyG1(LegalityAnalysis data)
{
var pk = data.Entity;
var enc = data.EncounterMatch;
if (pk.IsEgg)
{
const int elvl = 5;
if (elvl != pk.CurrentLevel)
data.AddLine(GetInvalid(string.Format(LEggFMetLevel_0, elvl)));
return;
}
if (pk.MetLocation != 0) // crystal
{
int lvl = pk.CurrentLevel;
if (lvl < pk.MetLevel)
data.AddLine(GetInvalid(LLevelMetBelow));
}
if (IsTradeEvolutionRequired(data, enc))
{
// Pokémon has been traded illegally between games without evolving.
// Trade evolution species IDs for Gen1 are sequential dex numbers.
var species = enc.Species;
var evolved = ParseSettings.SpeciesStrings[species + 1];
var unevolved = ParseSettings.SpeciesStrings[species];
data.AddLine(GetInvalid(string.Format(LEvoTradeReqOutsider, unevolved, evolved)));
}
}
/// <summary>
/// Checks if a Gen1 trade evolution must have occurred.
/// </summary>
private static bool IsTradeEvolutionRequired(LegalityAnalysis data, IEncounterTemplate enc)
{
// There is no way to prevent a Gen1 trade evolution, as held items (Everstone) did not exist.
// Machoke, Graveler, Haunter and Kadabra captured in the second phase evolution, excluding in-game trades, are already checked
var pk = data.Entity;
var species = pk.Species;
// This check is only applicable if it's a trade evolution that has not been evolved.
if (enc.Species != species)
return false;
if (!GBRestrictions.IsTradeEvolution1(enc.Species))
return false;
// Context check is only applicable to Gen1/2; transferring to Gen2 is a trade.
// Stadium 2 can transfer across game/generation boundaries without initiating a trade.
// Ignore this check if the environment's loaded trainer is not from Gen1/2 or is from GB Era.
if (ParseSettings.ActiveTrainer.Generation >= 3 || ParseSettings.AllowGBStadium2)
return false;
var moves = data.Info.Moves;
// Gen2 stuff can be traded between Gen2 games holding an Everstone, assuming it hasn't been transferred to Gen1 for special moves.
if (enc.Generation == 2)
return MoveInfo.IsAnyFromGeneration(1, moves);
// Gen1 stuff can only be un-evolved if it was never traded from the OT.
if (MoveInfo.IsAnyFromGeneration(2, moves))
return true; // traded to Gen2 for special moves
if (pk.Format != 1)
return true; // traded to Gen2 (current state)
return !ParseSettings.IsFromActiveTrainer(pk); // not with OT
}
}