Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves
In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.
The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.
The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.
* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 23:15:27 +00:00
|
|
|
using System;
|
2020-01-04 19:44:16 +00:00
|
|
|
using static PKHeX.Core.Encounters8Nest;
|
2022-01-09 06:34:04 +00:00
|
|
|
using static PKHeX.Core.AbilityPermission;
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Generation 8 Nest Encounter (Raid)
|
|
|
|
/// </summary>
|
|
|
|
/// <inheritdoc cref="EncounterStatic"/>
|
|
|
|
public abstract record EncounterStatic8Nest<T>(GameVersion Version) : EncounterStatic(Version), IGigantamax, IDynamaxLevel where T : EncounterStatic8Nest<T>
|
2020-01-04 19:44:16 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
public sealed override int Generation => 8;
|
Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves
In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.
The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.
The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.
* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 23:15:27 +00:00
|
|
|
public override EntityContext Context => EntityContext.Gen8;
|
2022-06-18 18:04:24 +00:00
|
|
|
public static Func<PKM, T, bool>? VerifyCorrelation { private get; set; }
|
|
|
|
public static Action<PKM, T, EncounterCriteria>? GenerateData { private get; set; }
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public bool CanGigantamax { get; set; }
|
|
|
|
public byte DynamaxLevel { get; set; }
|
|
|
|
public override int Location { get => SharedNest; init { } }
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public override bool IsMatchExact(PKM pk, EvoCriteria evo)
|
|
|
|
{
|
|
|
|
if (pk is PK8 d && d.DynamaxLevel < DynamaxLevel)
|
|
|
|
return false;
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
// Required Ability
|
|
|
|
if (Ability == OnlyHidden && pk.AbilityNumber != 4)
|
|
|
|
return false; // H
|
2020-12-03 05:39:45 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
if (Version != GameVersion.SWSH && pk.Version != (int)Version && pk.Met_Location != SharedNest)
|
|
|
|
return false;
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
if (VerifyCorrelation != null && !VerifyCorrelation(pk, (T)this))
|
|
|
|
return false;
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
if (pk is IRibbonSetMark8 m8 && m8.HasMark())
|
|
|
|
return false;
|
|
|
|
if (pk.Species == (int)Core.Species.Shedinja && pk is IRibbonSetAffixed { AffixedRibbon: >= (int)RibbonIndex.MarkLunchtime })
|
|
|
|
return false;
|
2021-01-23 04:28:54 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
return base.IsMatchExact(pk, evo);
|
|
|
|
}
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected sealed override EncounterMatchRating IsMatchDeferred(PKM pk)
|
|
|
|
{
|
|
|
|
if (Ability != Any12H)
|
2020-01-04 19:44:16 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
// HA-Only is a strict match. Ability Capsule and Patch can potentially change these.
|
|
|
|
var num = pk.AbilityNumber;
|
|
|
|
if (num == 4)
|
2020-06-20 18:14:44 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
if (Ability is not OnlyHidden && !AbilityVerifier.CanAbilityPatch(8, PersonalTable.SWSH.GetFormEntry(Species, Form).Abilities, pk.Species))
|
|
|
|
return EncounterMatchRating.DeferredErrors;
|
|
|
|
}
|
|
|
|
else if (Ability.IsSingleValue(out int index) && 1 << index != num) // Fixed regular ability
|
|
|
|
{
|
|
|
|
if (Ability is OnlyFirst or OnlySecond && !AbilityVerifier.CanAbilityCapsule(8, PersonalTable.SWSH.GetFormEntry(Species, Form).Abilities))
|
|
|
|
return EncounterMatchRating.DeferredErrors;
|
2020-06-20 18:14:44 +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
|
|
|
}
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
return base.IsMatchDeferred(pk);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected override bool IsMatchPartial(PKM pk)
|
|
|
|
{
|
|
|
|
if (pk is PK8 and IGigantamax g && g.CanGigantamax != CanGigantamax && !g.CanToggleGigantamax(pk.Species, pk.Form, Species, Form))
|
|
|
|
return true;
|
|
|
|
if (Species == (int)Core.Species.Alcremie && pk is IFormArgument { FormArgument: not 0 })
|
|
|
|
return true;
|
|
|
|
if (Species == (int)Core.Species.Runerigus && pk is IFormArgument { FormArgument: not 0 })
|
|
|
|
return true;
|
|
|
|
|
|
|
|
switch (Shiny)
|
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
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
case Shiny.Never when pk.IsShiny:
|
|
|
|
case Shiny.Always when !pk.IsShiny:
|
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 true;
|
2022-06-18 18:04:24 +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
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
return base.IsMatchPartial(pk);
|
|
|
|
}
|
2020-04-16 01:30:29 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected override void ApplyDetails(ITrainerInfo tr, EncounterCriteria criteria, PKM pk)
|
|
|
|
{
|
|
|
|
base.ApplyDetails(tr, criteria, pk);
|
|
|
|
if (GenerateData == null)
|
|
|
|
pk.SetRandomEC();
|
|
|
|
}
|
2020-01-04 19:44:16 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected sealed override void SetPINGA(PKM pk, EncounterCriteria criteria)
|
|
|
|
{
|
|
|
|
if (GenerateData != null)
|
2021-02-14 20:27:14 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
GenerateData(pk, (T)this, criteria);
|
|
|
|
return;
|
2021-02-14 20:27:14 +00:00
|
|
|
}
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
base.SetPINGA(pk, criteria);
|
|
|
|
if (Species == (int) Core.Species.Toxtricity)
|
2020-01-04 19:44:16 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
while (true)
|
2021-01-31 03:58:05 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
var result = EvolutionMethod.GetAmpLowKeyResult(pk.Nature);
|
|
|
|
if (result == pk.Form)
|
|
|
|
break;
|
|
|
|
pk.Nature = Util.Rand.Next(25);
|
2021-01-31 03:58:05 +00:00
|
|
|
}
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
// Might be originally generated with a Neutral nature, then above logic changes to another.
|
|
|
|
// Realign the stat nature to Serious mint.
|
|
|
|
if (pk.Nature != pk.StatNature && ((Nature)pk.StatNature).IsNeutral())
|
|
|
|
pk.StatNature = (int)Nature.Serious;
|
2020-01-04 19:44:16 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
var pid = pk.PID;
|
|
|
|
RaidRNG.ForceShinyState(pk, Shiny == Shiny.Always, ref pid);
|
|
|
|
pk.PID = pid;
|
2020-01-04 19:44:16 +00:00
|
|
|
}
|
|
|
|
}
|