2020-10-24 18:16:01 +00:00
|
|
|
|
using System;
|
|
|
|
|
using System.Collections.Generic;
|
2021-02-15 00:00:43 +00:00
|
|
|
|
using static PKHeX.Core.OverworldCorrelation8Requirement;
|
2020-10-24 18:16:01 +00:00
|
|
|
|
|
|
|
|
|
namespace PKHeX.Core
|
2019-11-19 03:23:01 +00:00
|
|
|
|
{
|
2020-11-27 19:51:02 +00:00
|
|
|
|
/// <summary>
|
|
|
|
|
/// Generation 8 Static Encounter
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <inheritdoc cref="EncounterStatic"/>
|
2021-02-14 18:20:35 +00:00
|
|
|
|
public record EncounterStatic8 : EncounterStatic, IDynamaxLevel, IGigantamax, IRelearn, IOverworldCorrelation8
|
2019-11-19 03:23:01 +00:00
|
|
|
|
{
|
2020-09-07 20:51:13 +00:00
|
|
|
|
public sealed override int Generation => 8;
|
2020-12-22 07:37:07 +00:00
|
|
|
|
public bool ScriptedNoMarks { get; init; }
|
2020-08-30 23:10:24 +00:00
|
|
|
|
public bool CanGigantamax { get; set; }
|
2020-10-24 18:16:01 +00:00
|
|
|
|
public byte DynamaxLevel { get; set; }
|
2020-12-24 08:06:40 +00:00
|
|
|
|
public IReadOnlyList<int> Relearn { get; init; } = Array.Empty<int>();
|
2020-08-30 23:10:24 +00:00
|
|
|
|
|
2021-01-16 17:31:21 +00:00
|
|
|
|
public AreaWeather8 Weather {get; init; } = AreaWeather8.Normal;
|
|
|
|
|
|
2021-01-04 00:49:49 +00:00
|
|
|
|
public EncounterStatic8(GameVersion game) : base(game) { }
|
|
|
|
|
|
2020-08-21 23:35:49 +00:00
|
|
|
|
protected override bool IsMatchLevel(PKM pkm, DexLevel evo)
|
2019-11-19 03:23:01 +00:00
|
|
|
|
{
|
2020-08-21 23:35:49 +00:00
|
|
|
|
var met = pkm.Met_Level;
|
2020-11-06 05:17:13 +00:00
|
|
|
|
var lvl = Level;
|
|
|
|
|
if (met == lvl)
|
2019-11-19 03:23:01 +00:00
|
|
|
|
return true;
|
2021-07-26 22:01:21 +00:00
|
|
|
|
if (lvl < EncounterArea8.BoostLevel && EncounterArea8.IsBoostedArea60(Location))
|
|
|
|
|
return met == EncounterArea8.BoostLevel;
|
2019-11-19 03:23:01 +00:00
|
|
|
|
return false;
|
|
|
|
|
}
|
2020-10-24 18:16:01 +00:00
|
|
|
|
|
Fracture the encounter matching checks to allow progressive validation (#3137)
## Issue
We want to discard-but-remember any slots that aren't a perfect fit, on the off chance that a better one exists later in the search space. If there's no better match, then we gotta go with what we got.
## Example:
Wurmple exists in area `X`, and also has a more rare slot for Silcoon, with the same level for both slots.
* We have a Silcoon that we've leveled up a few times.
Was our Silcoon originally a Wurmple, or was it caught as a Silcoon?
* To be sure, we have to check the EC/PID if the Wurmple wouldn't evolve into Cascoon instead.
* We don't want to wholly reject that Wurmple slot, as maybe the Met Level isn't within Silcoon's slot range.
---
Existing implementation would store "deferred" matches in a list; we only need to keep 1 of these matches around (less allocation!). We also want to differentiate between a "good" deferral and a "bad" deferral; I don't think this is necessary but it's currently used by Mystery Gift matching (implemented for the Eeveelution mystery gifts which matter for evolution moves).
The existing logic didn't use inheritance, and instead had static methods being reused across generations. Quite kludgy. Also, the existing logic was a pain to modify the master encounter yield methods, as one generation's quirks had to not impact all other generations that used the method.
---
The new implementation splits out the encounter yielding methods to be separate for each generation / subset. Now, things don't have to check `WasLink` for Gen7 origin, because Pokémon Link wasn't a thing in Gen7.
---
## Future
Maybe refactoring yielders into "GameCores" that expose yielding behaviors / properties, rather than the static logic. As more generations and side-gamegroups get added (thanks LGPE/GO/GameCube), all this switch stuff gets annoying to maintain instead of just overriding/inheritance.
## Conclusion
This shouldn't impact any legality results negatively; if you notice any regressions, report them! This should reduce false flags where we didn't defer-discard an encounter when we should have (wild area mons being confused with raids).
2021-01-30 01:55:27 +00:00
|
|
|
|
public override bool IsMatchExact(PKM pkm, DexLevel evo)
|
2020-10-24 18:16:01 +00:00
|
|
|
|
{
|
|
|
|
|
if (pkm is IDynamaxLevel d && d.DynamaxLevel < DynamaxLevel)
|
|
|
|
|
return false;
|
2021-08-06 16:42:27 +00:00
|
|
|
|
if (pkm.Met_Level < EncounterArea8.BoostLevel && Weather is AreaWeather8.Heavy_Fog && EncounterArea8.IsBoostedArea60(Location))
|
2021-07-26 22:01:21 +00:00
|
|
|
|
return false;
|
Fracture the encounter matching checks to allow progressive validation (#3137)
## Issue
We want to discard-but-remember any slots that aren't a perfect fit, on the off chance that a better one exists later in the search space. If there's no better match, then we gotta go with what we got.
## Example:
Wurmple exists in area `X`, and also has a more rare slot for Silcoon, with the same level for both slots.
* We have a Silcoon that we've leveled up a few times.
Was our Silcoon originally a Wurmple, or was it caught as a Silcoon?
* To be sure, we have to check the EC/PID if the Wurmple wouldn't evolve into Cascoon instead.
* We don't want to wholly reject that Wurmple slot, as maybe the Met Level isn't within Silcoon's slot range.
---
Existing implementation would store "deferred" matches in a list; we only need to keep 1 of these matches around (less allocation!). We also want to differentiate between a "good" deferral and a "bad" deferral; I don't think this is necessary but it's currently used by Mystery Gift matching (implemented for the Eeveelution mystery gifts which matter for evolution moves).
The existing logic didn't use inheritance, and instead had static methods being reused across generations. Quite kludgy. Also, the existing logic was a pain to modify the master encounter yield methods, as one generation's quirks had to not impact all other generations that used the method.
---
The new implementation splits out the encounter yielding methods to be separate for each generation / subset. Now, things don't have to check `WasLink` for Gen7 origin, because Pokémon Link wasn't a thing in Gen7.
---
## Future
Maybe refactoring yielders into "GameCores" that expose yielding behaviors / properties, rather than the static logic. As more generations and side-gamegroups get added (thanks LGPE/GO/GameCube), all this switch stuff gets annoying to maintain instead of just overriding/inheritance.
## Conclusion
This shouldn't impact any legality results negatively; if you notice any regressions, report them! This should reduce false flags where we didn't defer-discard an encounter when we should have (wild area mons being confused with raids).
2021-01-30 01:55:27 +00:00
|
|
|
|
return base.IsMatchExact(pkm, evo);
|
2020-10-24 18:16:01 +00:00
|
|
|
|
}
|
2021-02-14 18:20:35 +00:00
|
|
|
|
|
2021-02-14 20:27:14 +00:00
|
|
|
|
protected override void ApplyDetails(ITrainerInfo sav, EncounterCriteria criteria, PKM pk)
|
|
|
|
|
{
|
|
|
|
|
base.ApplyDetails(sav, criteria, pk);
|
2021-08-06 16:42:27 +00:00
|
|
|
|
if (Weather is AreaWeather8.Heavy_Fog && EncounterArea8.IsBoostedArea60(Location))
|
2021-07-26 22:01:21 +00:00
|
|
|
|
pk.CurrentLevel = pk.Met_Level = EncounterArea8.BoostLevel;
|
|
|
|
|
|
2021-02-15 00:00:43 +00:00
|
|
|
|
var req = GetRequirement(pk);
|
|
|
|
|
if (req != MustHave)
|
|
|
|
|
{
|
2021-02-14 20:27:14 +00:00
|
|
|
|
pk.SetRandomEC();
|
|
|
|
|
return;
|
2021-02-15 00:00:43 +00:00
|
|
|
|
}
|
2021-02-14 20:27:14 +00:00
|
|
|
|
var shiny = Shiny == Shiny.Random ? Shiny.FixedValue : Shiny;
|
|
|
|
|
Overworld8RNG.ApplyDetails(pk, criteria, shiny, FlawlessIVCount);
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-14 23:14:45 +00:00
|
|
|
|
public bool IsOverworldCorrelation
|
2021-02-14 18:20:35 +00:00
|
|
|
|
{
|
|
|
|
|
get
|
|
|
|
|
{
|
|
|
|
|
if (Gift)
|
|
|
|
|
return false; // gifts can have any 128bit seed from overworld
|
|
|
|
|
if (ScriptedNoMarks)
|
|
|
|
|
return false; // scripted encounters don't act as saved spawned overworld encounters
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-15 00:00:43 +00:00
|
|
|
|
public OverworldCorrelation8Requirement GetRequirement(PKM pk) => IsOverworldCorrelation
|
|
|
|
|
? MustHave
|
|
|
|
|
: MustNotHave;
|
2021-02-14 23:14:45 +00:00
|
|
|
|
|
2021-02-14 18:20:35 +00:00
|
|
|
|
public bool IsOverworldCorrelationCorrect(PKM pk)
|
|
|
|
|
{
|
|
|
|
|
return Overworld8RNG.ValidateOverworldEncounter(pk, Shiny == Shiny.Random ? Shiny.FixedValue : Shiny, FlawlessIVCount);
|
|
|
|
|
}
|
2021-02-14 23:14:45 +00:00
|
|
|
|
|
|
|
|
|
public override EncounterMatchRating GetMatchRating(PKM pkm)
|
|
|
|
|
{
|
2021-02-15 05:24:31 +00:00
|
|
|
|
var rating = base.GetMatchRating(pkm);
|
|
|
|
|
if (rating != EncounterMatchRating.Match)
|
|
|
|
|
return rating;
|
|
|
|
|
|
2021-02-15 00:00:43 +00:00
|
|
|
|
var req = GetRequirement(pkm);
|
|
|
|
|
bool correlation = IsOverworldCorrelationCorrect(pkm);
|
|
|
|
|
if ((req == MustHave) != correlation)
|
2021-02-14 23:14:45 +00:00
|
|
|
|
return EncounterMatchRating.Deferred;
|
2021-02-15 05:24:31 +00:00
|
|
|
|
|
2021-02-15 06:25:59 +00:00
|
|
|
|
// Only encounter slots can have these marks; defer for collisions.
|
2021-04-21 22:20:16 +00:00
|
|
|
|
if (pkm.Species == (int) Core.Species.Shedinja)
|
|
|
|
|
{
|
|
|
|
|
// Loses Mark on evolution to Shedinja, but not affixed ribbon value.
|
|
|
|
|
return pkm switch
|
|
|
|
|
{
|
|
|
|
|
IRibbonSetMark8 {RibbonMarkCurry: true} => EncounterMatchRating.Deferred,
|
|
|
|
|
PK8 {AffixedRibbon: (int) RibbonIndex.MarkCurry} => EncounterMatchRating.Deferred,
|
|
|
|
|
_ => EncounterMatchRating.Match
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2021-07-26 21:28:05 +00:00
|
|
|
|
if (pkm is IRibbonSetMark8 m && (m.RibbonMarkCurry || m.RibbonMarkFishing || m.HasWeatherMark()))
|
2021-02-15 05:24:31 +00:00
|
|
|
|
return EncounterMatchRating.Deferred;
|
|
|
|
|
|
|
|
|
|
return EncounterMatchRating.Match;
|
2021-02-14 23:14:45 +00:00
|
|
|
|
}
|
2021-02-14 18:20:35 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public interface IOverworldCorrelation8
|
|
|
|
|
{
|
2021-02-15 00:00:43 +00:00
|
|
|
|
OverworldCorrelation8Requirement GetRequirement(PKM pk);
|
2021-02-14 18:20:35 +00:00
|
|
|
|
bool IsOverworldCorrelationCorrect(PKM pk);
|
2019-11-19 03:23:01 +00:00
|
|
|
|
}
|
2021-02-15 00:00:43 +00:00
|
|
|
|
|
|
|
|
|
public enum OverworldCorrelation8Requirement
|
|
|
|
|
{
|
|
|
|
|
CanBeEither,
|
|
|
|
|
MustHave,
|
|
|
|
|
MustNotHave,
|
|
|
|
|
}
|
2020-10-24 18:16:01 +00:00
|
|
|
|
}
|