2022-06-18 18:04:24 +00:00
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
/// Generation 7 Static Encounter
|
|
|
|
/// </summary>
|
|
|
|
/// <inheritdoc cref="EncounterStatic"/>
|
|
|
|
public sealed record EncounterStatic7(GameVersion Version) : EncounterStatic(Version), IRelearn
|
2020-08-21 23:35:49 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
public override int Generation => 7;
|
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.Gen7;
|
2022-08-22 00:34:32 +00:00
|
|
|
public Moveset Relearn { get; init; }
|
2020-08-21 23:35:49 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public bool IsTotem => FormInfo.IsTotemForm(Species, Form);
|
|
|
|
public bool IsTotemNoTransfer => Legal.Totem_NoTransfer.Contains(Species);
|
|
|
|
public int GetTotemBaseForm() => FormInfo.GetTotemBaseForm(Species, Form);
|
2021-04-17 20:24:57 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected override bool IsMatchLocation(PKM pk)
|
|
|
|
{
|
2022-08-22 00:34:32 +00:00
|
|
|
if (EggLocation == Locations.Daycare5 && !Relearn.HasMoves && pk.RelearnMove1 != 0) // Gift Eevee edge case
|
2022-06-18 18:04:24 +00:00
|
|
|
return false;
|
|
|
|
return base.IsMatchLocation(pk);
|
|
|
|
}
|
2020-08-21 23:35:49 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected override bool IsMatchEggLocation(PKM pk)
|
|
|
|
{
|
|
|
|
if (!EggEncounter)
|
|
|
|
return base.IsMatchEggLocation(pk);
|
2021-05-21 20:57:07 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
var eggloc = pk.Egg_Location;
|
|
|
|
if (!pk.IsEgg) // hatched
|
|
|
|
return eggloc == EggLocation || eggloc == Locations.LinkTrade6;
|
2021-05-21 20:57:07 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
// Unhatched:
|
|
|
|
if (eggloc != EggLocation)
|
|
|
|
return false;
|
|
|
|
if (pk.Met_Location is not (0 or Locations.LinkTrade6))
|
|
|
|
return false;
|
|
|
|
return true;
|
|
|
|
}
|
2021-05-21 20:57:07 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
protected override bool IsMatchForm(PKM pk, EvoCriteria evo)
|
|
|
|
{
|
|
|
|
if (IsTotem)
|
2020-08-21 23:35:49 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
var expectForm = pk.Format == 7 ? Form : FormInfo.GetTotemBaseForm(Species, Form);
|
|
|
|
return expectForm == evo.Form;
|
2020-08-21 23:35:49 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
return base.IsMatchForm(pk, evo);
|
|
|
|
}
|
2020-09-05 19:11:43 +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 (Species == (int)Core.Species.Magearna && pk is IRibbonSetEvent4 e4)
|
|
|
|
e4.RibbonWishing = true;
|
|
|
|
if (Form == FormVivillon && pk is PK7 pk7)
|
|
|
|
pk.Form = Vivillon3DS.GetPattern(pk7.Country, pk7.Region);
|
|
|
|
pk.SetRandomEC();
|
|
|
|
}
|
2020-09-13 21:40:10 +00:00
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
internal static EncounterStatic7 GetVC1(ushort species, byte metLevel)
|
2022-06-18 18:04:24 +00:00
|
|
|
{
|
|
|
|
bool mew = species == (int)Core.Species.Mew;
|
|
|
|
return new EncounterStatic7(GameVersion.RBY)
|
2020-09-05 19:11:43 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
Species = species,
|
|
|
|
Gift = true, // Forces Poké Ball
|
|
|
|
Ability = Legal.TransferSpeciesDefaultAbilityGen1(species) ? AbilityPermission.OnlyFirst : AbilityPermission.OnlyHidden, // Hidden by default, else first
|
|
|
|
Shiny = mew ? Shiny.Never : Shiny.Random,
|
|
|
|
Fateful = mew,
|
|
|
|
Location = Locations.Transfer1,
|
|
|
|
Level = metLevel,
|
|
|
|
FlawlessIVCount = mew ? (byte)5 : (byte)3,
|
|
|
|
};
|
|
|
|
}
|
2020-09-05 19:11:43 +00:00
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
internal static EncounterStatic7 GetVC2(ushort species, byte metLevel)
|
2022-06-18 18:04:24 +00:00
|
|
|
{
|
|
|
|
bool mew = species == (int)Core.Species.Mew;
|
|
|
|
bool fateful = mew || species == (int)Core.Species.Celebi;
|
|
|
|
return new EncounterStatic7(GameVersion.GSC)
|
2020-09-05 19:11:43 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
Species = species,
|
|
|
|
Gift = true, // Forces Poké Ball
|
|
|
|
Ability = Legal.TransferSpeciesDefaultAbilityGen2(species) ? AbilityPermission.OnlyFirst : AbilityPermission.OnlyHidden, // Hidden by default, else first
|
|
|
|
Shiny = mew ? Shiny.Never : Shiny.Random,
|
|
|
|
Fateful = fateful,
|
|
|
|
Location = Locations.Transfer2,
|
|
|
|
Level = metLevel,
|
|
|
|
FlawlessIVCount = fateful ? (byte)5 : (byte)3,
|
|
|
|
};
|
2020-08-21 23:35:49 +00:00
|
|
|
}
|
2020-09-05 19:11:43 +00:00
|
|
|
}
|