mirror of
https://github.com/kwsch/PKHeX.git
synced 2026-05-21 05:09:35 -05:00
9166d0eb64
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
73 lines
2.2 KiB
C#
73 lines
2.2 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using static PKHeX.Core.LegalityCheckStrings;
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
/// <summary>
|
|
/// Default formatter for Legality Result displays.
|
|
/// </summary>
|
|
public sealed class BaseLegalityFormatter : ILegalityFormatter
|
|
{
|
|
public string GetReport(LegalityAnalysis l)
|
|
{
|
|
if (l.Valid)
|
|
return L_ALegal;
|
|
if (!l.Parsed)
|
|
return L_AnalysisUnavailable;
|
|
|
|
var lines = GetLegalityReportLines(l);
|
|
return string.Join(Environment.NewLine, lines);
|
|
}
|
|
|
|
public string GetReportVerbose(LegalityAnalysis l)
|
|
{
|
|
if (!l.Parsed)
|
|
return L_AnalysisUnavailable;
|
|
|
|
var lines = GetVerboseLegalityReportLines(l);
|
|
return string.Join(Environment.NewLine, lines);
|
|
}
|
|
|
|
private static List<string> GetLegalityReportLines(LegalityAnalysis l)
|
|
{
|
|
var lines = new List<string>();
|
|
var info = l.Info;
|
|
var pk = l.Entity;
|
|
|
|
LegalityFormatting.AddMoves(info.Moves, lines, pk.Format, false, pk, l.Info.EvoChainsAllGens);
|
|
if (pk.Format >= 6)
|
|
LegalityFormatting.AddRelearn(info.Relearn, lines, false, pk, l.Info.EvoChainsAllGens);
|
|
LegalityFormatting.AddSecondaryChecksInvalid(l.Results, lines);
|
|
return lines;
|
|
}
|
|
|
|
private static IReadOnlyList<string> GetVerboseLegalityReportLines(LegalityAnalysis l)
|
|
{
|
|
var lines = l.Valid ? new List<string> {L_ALegal} : GetLegalityReportLines(l);
|
|
var info = l.Info;
|
|
var pk = l.Entity;
|
|
const string separator = "===";
|
|
lines.Add(separator);
|
|
lines.Add(string.Empty);
|
|
int initialCount = lines.Count;
|
|
|
|
var format = pk.Format;
|
|
LegalityFormatting.AddMoves(info.Moves, lines, format, true, pk, l.Info.EvoChainsAllGens);
|
|
|
|
if (format >= 6)
|
|
LegalityFormatting.AddRelearn(info.Relearn, lines, true, pk, l.Info.EvoChainsAllGens);
|
|
|
|
if (lines.Count != initialCount) // move info added, break for next section
|
|
lines.Add(string.Empty);
|
|
|
|
LegalityFormatting.AddSecondaryChecksValid(l.Results, lines);
|
|
|
|
lines.Add(separator);
|
|
lines.Add(string.Empty);
|
|
LegalityFormatting.AddEncounterInfo(l, lines);
|
|
|
|
return lines;
|
|
}
|
|
}
|