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

65 lines
2.2 KiB
C#

using System;
namespace PKHeX.Core;
/// <summary>
/// Encounter Slot found in <see cref="GameVersion.ORAS"/>.
/// </summary>
/// <inheritdoc cref="EncounterSlot"/>
public sealed record EncounterSlot6AO : EncounterSlot
{
public override int Generation => 6;
public override EntityContext Context => EntityContext.Gen6;
public bool CanDexNav => Area.Type != SlotType.Rock_Smash;
public bool IsHorde => Area.Type == SlotType.Horde;
public bool Pressure { get; init; }
public bool DexNav { get; init; }
public bool WhiteFlute { get; init; }
public bool BlackFlute { get; init; }
public EncounterSlot6AO(EncounterArea6AO area, ushort species, byte form, byte min, byte max) : base(area, species, form, min, max)
{
}
protected override void SetFormatSpecificData(PKM pk)
{
var pk6 = (PK6)pk;
if (CanDexNav)
{
var eggMoves = GetDexNavMoves();
if (eggMoves.Length > 0)
pk6.RelearnMove1 = eggMoves[Util.Rand.Next(eggMoves.Length)];
}
pk6.SetRandomMemory6();
pk6.SetRandomEC();
}
public override string GetConditionString(out bool valid)
{
valid = true;
if (WhiteFlute) // Decreased Level Encounters
return Pressure ? LegalityCheckStrings.LEncConditionWhiteLead : LegalityCheckStrings.LEncConditionWhite;
if (BlackFlute) // Increased Level Encounters
return Pressure ? LegalityCheckStrings.LEncConditionBlackLead : LegalityCheckStrings.LEncConditionBlack;
if (DexNav)
return LegalityCheckStrings.LEncConditionDexNav;
return Pressure ? LegalityCheckStrings.LEncConditionLead : LegalityCheckStrings.LEncCondition;
}
protected override HiddenAbilityPermission IsHiddenAbilitySlot() => CanDexNav || IsHorde ? HiddenAbilityPermission.Possible : HiddenAbilityPermission.Never;
private ReadOnlySpan<int> GetDexNavMoves()
{
var et = EvolutionTree.Evolves6;
var baby = et.GetBaseSpeciesForm((ushort)Species, (byte)Form);
return MoveEgg.GetEggMoves(6, baby.Species, baby.Form, Version);
}
public bool CanBeDexNavMove(int move)
{
var baseEgg = GetDexNavMoves();
return baseEgg.Contains(move);
}
}