PKHeX/PKHeX.Core/Legality/Encounters/EncounterTrade/EncounterTrade3.cs
Kurt 9166d0eb64
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 16:15:27 -07:00

94 lines
2.7 KiB
C#

using System.Collections.Generic;
namespace PKHeX.Core;
/// <summary>
/// Generation 3 Trade Encounter
/// </summary>
/// <inheritdoc cref="EncounterTrade"/>
public sealed record EncounterTrade3 : EncounterTrade, IContestStats
{
public override int Generation => 3;
public override EntityContext Context => EntityContext.Gen3;
public override int Location => Locations.LinkTrade3NPC;
/// <summary>
/// Fixed <see cref="PKM.PID"/> value the encounter must have.
/// </summary>
public readonly uint PID;
public override Shiny Shiny => Shiny.FixedValue;
public byte CNT_Cool { get; private init; }
public byte CNT_Beauty { get; private init; }
public byte CNT_Cute { get; private init; }
public byte CNT_Smart { get; private init; }
public byte CNT_Tough { get; private init; }
public byte CNT_Sheen { get; private init; }
public IReadOnlyList<byte> Contest
{
init
{
CNT_Cool = value[0];
CNT_Beauty = value[1];
CNT_Cute = value[2];
CNT_Smart = value[3];
CNT_Tough = value[4];
CNT_Sheen = value[5];
}
}
public EncounterTrade3(GameVersion game, uint pid, ushort species, byte level) : base(game)
{
PID = pid;
Species = species;
Level = level;
}
public override bool IsMatchExact(PKM pk, EvoCriteria evo)
{
if (!base.IsMatchExact(pk, evo))
return false;
if (pk is IContestStats s && s.IsContestBelow(this))
return false;
return true;
}
protected override void ApplyDetails(ITrainerInfo sav, EncounterCriteria criteria, PKM pk)
{
base.ApplyDetails(sav, criteria, pk);
var pk3 = (PK3) pk;
// Italian LG Jynx untranslated from English name
if (Species == (int)Core.Species.Jynx && pk3.Version == (int)GameVersion.LG && pk3.Language == (int)LanguageID.Italian)
{
pk3.OT_Name = GetOT((int)LanguageID.English);
pk3.SetNickname(GetNickname((int)LanguageID.English));
}
this.CopyContestStatsTo((PK3)pk);
}
protected override void SetPINGA(PKM pk, EncounterCriteria criteria)
{
var pi = pk.PersonalInfo;
int gender = criteria.GetGender(EntityGender.GetFromPID(Species, PID), pi);
int nature = (int)criteria.GetNature(Nature);
int ability = criteria.GetAbilityFromNumber(Ability);
pk.PID = PID;
pk.Nature = nature;
pk.Gender = gender;
pk.RefreshAbility(ability);
SetIVs(pk);
}
protected override bool IsMatchNatureGenderShiny(PKM pk)
{
return PID == pk.EncryptionConstant;
}
}