PKHeX/PKHeX.Core/Legality/Encounters/EncounterSlot/EncounterSlot4.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

55 lines
2 KiB
C#

namespace PKHeX.Core;
/// <summary>
/// Encounter Slot found in <see cref="GameVersion.Gen4"/>.
/// </summary>
/// <inheritdoc cref="EncounterSlot"/>
public sealed record EncounterSlot4 : EncounterSlot, IMagnetStatic, INumberedSlot, IGroundTypeTile, ISlotRNGType
{
public override int Generation => 4;
public override EntityContext Context => EntityContext.Gen4;
public GroundTileAllowed GroundTile => ((EncounterArea4)Area).GroundTile;
public byte StaticIndex { get; }
public byte MagnetPullIndex { get; }
public byte StaticCount { get; }
public byte MagnetPullCount { get; }
public SlotType Type => Area.Type;
public byte SlotNumber { get; }
public override Ball FixedBall => GetRequiredBallValue();
public bool CanUseRadar => !GameVersion.HGSS.Contains(Version) && GroundTile.HasFlag(GroundTileAllowed.Grass);
public EncounterSlot4(EncounterArea4 area, ushort species, byte form, byte min, byte max, byte slot, byte mpi, byte mpc, byte sti, byte stc) : base(area, species, form, min, max)
{
SlotNumber = slot;
MagnetPullIndex = mpi;
MagnetPullCount = mpc;
StaticIndex = sti;
StaticCount = stc;
}
protected override void SetFormatSpecificData(PKM pk) => ((PK4)pk).GroundTile = GroundTile.GetIndex();
public override EncounterMatchRating GetMatchRating(PKM pk)
{
if ((pk.Ball == (int)Ball.Safari) != Locations.IsSafariZoneLocation4(Location))
return EncounterMatchRating.PartialMatch;
if ((pk.Ball == (int)Ball.Sport) != (Type == SlotType.BugContest))
{
// Nincada => Shedinja can wipe the ball back to Poke
if (pk.Species != (int)Core.Species.Shedinja || pk.Ball != (int)Ball.Poke)
return EncounterMatchRating.PartialMatch;
}
return base.GetMatchRating(pk);
}
private Ball GetRequiredBallValue()
{
if (Type is SlotType.BugContest)
return Ball.Sport;
return Locations.IsSafariZoneLocation4(Location) ? Ball.Safari : Ball.None;
}
}