PKHeX/PKHeX.Core/Legality/LearnSource/Sources/LearnSource4HGSS.cs
Kurt 3c232505e5
Refactoring: Narrow some value types (Species, Move, Form) (#3575)
In this pull request I've changed a ton of method signatures to reflect the more-narrow types of Species, Move# and Form; additionally, I've narrowed other large collections that stored lists of species / permitted values, and reworked them to be more performant with the latest API spaghetti that PKHeX provides. Roamer met locations, usually in a range of [max-min]<64, can be quickly checked using a bitflag operation on a UInt64. Other collections (like "Is this from Colosseum or XD") were eliminated -- shadow state is not transferred COLO<->XD, so having a Shadow ID or matching the met location from a gift/wild encounter is a sufficient check for "originated in XD".
2022-08-26 23:43:36 -07:00

196 lines
6.6 KiB
C#

using System;
using System.Diagnostics.CodeAnalysis;
using static PKHeX.Core.LearnMethod;
using static PKHeX.Core.LearnEnvironment;
using static PKHeX.Core.LearnSource4;
namespace PKHeX.Core;
/// <summary>
/// Exposes information about how moves are learned in <see cref="HGSS"/>.
/// </summary>
public sealed class LearnSource4HGSS : ILearnSource, IEggSource
{
public static readonly LearnSource4HGSS Instance = new();
private static readonly PersonalTable4 Personal = PersonalTable.HGSS;
private static readonly Learnset[] Learnsets = Legal.LevelUpHGSS;
private static readonly EggMoves6[] EggMoves = Legal.EggMovesHGSS;
private const int MaxSpecies = Legal.MaxSpeciesID_4;
private const LearnEnvironment Game = HGSS;
private const int Generation = 4;
private const int CountTM = 92;
public Learnset GetLearnset(ushort species, int form) => Learnsets[Personal.GetFormIndex(species, form)];
public bool TryGetPersonal(ushort species, int form, [NotNullWhen(true)] out PersonalInfo? pi)
{
pi = null;
if ((uint)species > MaxSpecies)
return false;
pi = Personal[species];
return true;
}
public bool GetIsEggMove(ushort species, int form, ushort move)
{
if ((uint)species > MaxSpecies)
return false;
var moves = EggMoves[species];
return moves.GetHasEggMove(move);
}
public ReadOnlySpan<ushort> GetEggMoves(ushort species, int form)
{
if ((uint)species > MaxSpecies)
return ReadOnlySpan<ushort>.Empty;
return EggMoves[species].Moves;
}
public MoveLearnInfo GetCanLearn(PKM pk, PersonalInfo pi, EvoCriteria evo, ushort move, MoveSourceType types = MoveSourceType.All, LearnOption option = LearnOption.Current)
{
if (types.HasFlagFast(MoveSourceType.LevelUp))
{
var learn = GetLearnset(evo.Species, evo.Form);
var level = learn.GetLevelLearnMove(move);
if (level != -1 && level <= evo.LevelMax)
return new(LevelUp, Game, (byte)level);
}
if (types.HasFlagFast(MoveSourceType.Machine))
{
if (GetIsTM(pi, move))
return new(TMHM, Game);
if ((move is (int)Move.Whirlpool || pk.Format == Generation) && GetIsHM(pi, move))
return new(TMHM, Game);
}
if (types.HasFlagFast(MoveSourceType.TypeTutor) && GetIsTypeTutor(evo.Species, move))
return new(Tutor, Game);
if (types.HasFlagFast(MoveSourceType.SpecialTutor) && GetIsSpecialTutor(pi, move))
return new(Tutor, Game);
if (types.HasFlagFast(MoveSourceType.EnhancedTutor) && GetIsEnhancedTutor(evo, pk, move, option))
return new(Tutor, Game);
return default;
}
private static bool GetIsEnhancedTutor(EvoCriteria evo, ISpeciesForm current, ushort move, LearnOption option) => evo.Species is (int)Species.Rotom && move switch
{
(int)Move.Overheat => option == LearnOption.AtAnyTime || current.Form == 1,
(int)Move.HydroPump => option == LearnOption.AtAnyTime || current.Form == 2,
(int)Move.Blizzard => option == LearnOption.AtAnyTime || current.Form == 3,
(int)Move.AirSlash => option == LearnOption.AtAnyTime || current.Form == 4,
(int)Move.LeafStorm => option == LearnOption.AtAnyTime || current.Form == 5,
_ => false,
};
private static bool GetIsTypeTutor(ushort species, ushort move)
{
var index = Array.IndexOf(SpecialTutors_4, move);
if (index == -1)
return false;
var list = SpecialTutors_Compatibility_4[index];
return Array.IndexOf(list, species) != -1;
}
private static bool GetIsSpecialTutor(PersonalInfo pi, ushort move)
{
var index = Array.IndexOf(Tutors_4, move);
if (index == -1)
return false;
return pi.TypeTutors[index];
}
private static bool GetIsTM(PersonalInfo info, ushort move)
{
var index = Array.IndexOf(TM_4, move);
if (index == -1)
return false;
return info.TMHM[index];
}
private static bool GetIsHM(PersonalInfo info, ushort move)
{
var index = Array.IndexOf(HM_HGSS, move);
if (index == -1)
return false;
return info.TMHM[CountTM + index];
}
public void GetAllMoves(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types = MoveSourceType.All)
{
if (!TryGetPersonal(evo.Species, evo.Form, out var pi))
return;
if (types.HasFlagFast(MoveSourceType.LevelUp))
{
var learn = GetLearnset(evo.Species, evo.Form);
(bool hasMoves, int start, int end) = learn.GetMoveRange(evo.LevelMax);
if (hasMoves)
{
var moves = learn.Moves;
for (int i = end; i >= start; i--)
result[moves[i]] = true;
}
}
if (types.HasFlagFast(MoveSourceType.Machine))
{
var flags = pi.TMHM;
var moves = TM_4;
for (int i = 0; i < moves.Length; i++)
{
if (flags[i])
result[moves[i]] = true;
}
if (pk.Format == Generation)
{
moves = HM_HGSS;
for (int i = 0; i < moves.Length; i++)
{
if (flags[CountTM + i])
result[moves[i]] = true;
}
}
else
{
// Permit Whirlpool to leak through if transferred to Gen5+ (via D/P/Pt)
if (flags[CountTM + 4])
result[(int)Move.Whirlpool] = true;
}
}
if (types.HasFlagFast(MoveSourceType.TypeTutor))
{
// Elemental Beams
var species = SpecialTutors_Compatibility_4;
var moves = SpecialTutors_4;
for (int i = 0; i < species.Length; i++)
{
var index = Array.IndexOf(species[i], evo.Species);
if (index != -1)
result[moves[i]] = true;
}
}
if (types.HasFlagFast(MoveSourceType.SpecialTutor))
{
var flags = pi.TypeTutors;
var moves = Tutors_4;
for (int i = 0; i < moves.Length; i++)
{
if (flags[i])
result[moves[i]] = true;
}
}
if (types.HasFlagFast(MoveSourceType.EnhancedTutor))
{
if (evo.Species is (int)Species.Rotom && evo.Form is not 0)
result[MoveTutor.GetRotomFormMove(evo.Form)] = true;
}
}
}