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.Linq;
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Trade Encounter data with a fixed Catch Rate
|
|
|
|
/// </summary>
|
|
|
|
/// <remarks>
|
|
|
|
/// Generation 1 specific value used in detecting unmodified/un-traded Generation 1 Trade Encounter data.
|
|
|
|
/// Species & Minimum level (legal) possible to acquire at.
|
|
|
|
/// </remarks>
|
|
|
|
public sealed record EncounterTrade1 : EncounterTradeGB
|
2020-07-18 20:36:30 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
public override int Generation => 1;
|
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.Gen1;
|
2022-06-18 18:04:24 +00:00
|
|
|
public override byte LevelMin => CanObtainMinGSC() ? LevelMinGSC : LevelMinRBY;
|
|
|
|
|
|
|
|
private readonly byte LevelMinRBY;
|
|
|
|
private readonly byte LevelMinGSC;
|
|
|
|
public override int Location => 0;
|
|
|
|
public override Shiny Shiny => Shiny.Random;
|
|
|
|
|
|
|
|
public EncounterTrade1(int species, GameVersion game, byte rby, byte gsc) : base(species, gsc, game)
|
2020-07-18 20:36:30 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
TrainerNames = StringConverter12.G1TradeOTName;
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
LevelMinRBY = rby;
|
|
|
|
LevelMinGSC = gsc;
|
|
|
|
}
|
2020-09-05 20:06:08 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public EncounterTrade1(int species, GameVersion game, byte rby) : this(species, game, rby, rby) { }
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public byte GetInitialCatchRate()
|
|
|
|
{
|
|
|
|
var pt = Version == GameVersion.YW ? PersonalTable.Y : PersonalTable.RB;
|
|
|
|
return (byte)pt[Species].CatchRate;
|
|
|
|
}
|
2020-07-18 20:36:30 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected override void ApplyDetails(ITrainerInfo sav, EncounterCriteria criteria, PKM pk)
|
|
|
|
{
|
|
|
|
base.ApplyDetails(sav, criteria, pk);
|
|
|
|
var pk1 = (PK1)pk;
|
|
|
|
pk1.Catch_Rate = GetInitialCatchRate();
|
|
|
|
}
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
internal bool IsNicknameValid(PKM pk)
|
|
|
|
{
|
|
|
|
var nick = pk.Nickname;
|
|
|
|
if (pk.Format <= 2)
|
|
|
|
return Nicknames.Contains(nick);
|
|
|
|
|
|
|
|
// Converted string 1/2->7 to language specific value
|
|
|
|
// Nicknames can be from any of the languages it can trade between.
|
|
|
|
int lang = pk.Language;
|
|
|
|
if (lang == 1)
|
2020-07-18 20:36:30 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
// Special consideration for Hiragana strings that are transferred
|
|
|
|
if (Version == GameVersion.YW && Species == (int)Core.Species.Dugtrio)
|
|
|
|
return nick == "ぐりお";
|
|
|
|
return nick == Nicknames[1];
|
2020-07-18 20:36:30 +00:00
|
|
|
}
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
return GetNicknameIndex(nick) >= 2;
|
|
|
|
}
|
2020-07-18 20:36:30 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
internal bool IsTrainerNameValid(PKM pk)
|
|
|
|
{
|
|
|
|
string ot = pk.OT_Name;
|
|
|
|
if (pk.Format <= 2)
|
|
|
|
return ot == StringConverter12.G1TradeOTStr;
|
|
|
|
|
|
|
|
// Converted string 1/2->7 to language specific value
|
|
|
|
int lang = pk.Language;
|
|
|
|
var tr = GetOT(lang);
|
|
|
|
return ot == tr;
|
|
|
|
}
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
private int GetNicknameIndex(string nickname)
|
|
|
|
{
|
|
|
|
var nn = Nicknames;
|
|
|
|
for (int i = 0; i < nn.Count; i++)
|
2020-07-19 18:32:40 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
if (nn[i] == nickname)
|
|
|
|
return i;
|
2020-07-19 18:32:40 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
return -1;
|
|
|
|
}
|
2020-07-19 18:32:40 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
private bool CanObtainMinGSC()
|
|
|
|
{
|
|
|
|
if (!ParseSettings.AllowGen1Tradeback)
|
|
|
|
return false;
|
|
|
|
if (Version == GameVersion.BU && EvolveOnTrade)
|
|
|
|
return ParseSettings.AllowGBCartEra;
|
|
|
|
return true;
|
|
|
|
}
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
private bool IsMatchLevel(PKM pk, int lvl)
|
|
|
|
{
|
|
|
|
if (pk is not PK1)
|
|
|
|
return lvl >= LevelMinGSC;
|
|
|
|
return lvl >= LevelMin;
|
|
|
|
}
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public override bool IsMatchExact(PKM pk, EvoCriteria evo)
|
|
|
|
{
|
|
|
|
if (!IsMatchLevel(pk, pk.CurrentLevel)) // minimum required level
|
|
|
|
return false;
|
2020-11-23 00:19:03 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
if (Version == GameVersion.BU)
|
2020-07-18 20:36:30 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
// Encounters with this version have to originate from the Japanese Blue game.
|
|
|
|
if (!pk.Japanese)
|
|
|
|
return false;
|
|
|
|
// Stadium 2 can transfer from GSC->RBY without a "Trade", thus allowing un-evolved outsiders
|
|
|
|
if (EvolveOnTrade && !ParseSettings.AllowGBCartEra && pk.CurrentLevel < LevelMinRBY)
|
2020-07-18 20:36:30 +00:00
|
|
|
return false;
|
2022-06-18 18:04:24 +00:00
|
|
|
}
|
2020-07-18 20:36:30 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
return true;
|
|
|
|
}
|
2020-11-01 23:27:54 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected override bool IsMatchPartial(PKM pk)
|
|
|
|
{
|
|
|
|
if (!IsTrainerNameValid(pk))
|
|
|
|
return true;
|
|
|
|
if (!IsNicknameValid(pk))
|
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
|
|
|
if (ParseSettings.AllowGen1Tradeback)
|
|
|
|
return false;
|
|
|
|
if (pk is not PK1 pk1)
|
|
|
|
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
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
var req = GetInitialCatchRate();
|
|
|
|
return req != pk1.Catch_Rate;
|
2020-07-18 20:36:30 +00:00
|
|
|
}
|
|
|
|
}
|