PKHeX/PKHeX.Core/Legality/Structures/CheckMoveResult.cs
Kurt 69fafcab83 Performance: Slightly reduce allocations in moveset validation (#3460)
* Reuses move parse result objects for each encounter parsed in a LegalityCheck attempt, instead of creating a new object.
* Ensures the objects are never-null, and makes cleanup easier.

Slightly adjusts some other parts of the moveset validation to reduce allocations.
2022-03-12 17:39:00 -08:00

61 lines
2.5 KiB
C#

namespace PKHeX.Core;
/// <summary>
/// Move specific <see cref="CheckResult"/> to contain in which Generation it was learned &amp; source.
/// </summary>
public sealed record CheckMoveResult : ICheckResult
{
public Severity Judgement { get; private set; }
public CheckIdentifier Identifier { get; private set; }
public string Comment { get; private set; } = string.Empty;
public bool Valid => Judgement >= Severity.Fishy;
public string Rating => Judgement.Description();
/// <summary> Method of learning the move. </summary>
public MoveSource Source { get; private set; }
/// <summary> Generation the move was learned in. </summary>
public int Generation { get; private set; }
/// <summary> Indicates if the source of the move was validated from the <see cref="PKM.RelearnMoves"/> </summary>
public bool IsRelearn => Source == MoveSource.Relearn || (Source == MoveSource.EggMove && Generation >= 6);
/// <summary> Indicates if the source of the move was validated as originating from an egg. </summary>
public bool IsEggSource => Source is MoveSource.EggMove or MoveSource.InheritLevelUp;
/// <summary> Indicates if the entry was parsed by the legality checker. Should never be true when the parent legality check is finalized. </summary>
internal bool IsParsed => Source is not MoveSource.NotParsed;
/// <summary> Sets <see cref="IsParsed"/> to false. </summary>
internal void Reset() => Source = MoveSource.NotParsed;
/// <summary> Checks if the Move should be present in a Relearn move pool (assuming Gen6+ origins). </summary>
/// <remarks>Invalid moves that can't be validated should be here, hence the inclusion.</remarks>
public bool ShouldBeInRelearnMoves() => Source != MoveSource.None && (!Valid || IsRelearn);
internal void Set(MoveSource m, int g, Severity s, string c, CheckIdentifier i)
{
Judgement = s;
Comment = c;
Identifier = i;
Source = m;
Generation = g;
}
internal void FlagIllegal(string comment)
{
Judgement = Severity.Invalid;
Comment = comment;
}
internal void FlagIllegal(string comment, CheckIdentifier identifier)
{
Judgement = Severity.Invalid;
Comment = comment;
Identifier = identifier;
}
public string Format(string format) => string.Format(format, Rating, Comment);
public string Format(string format, int index) => string.Format(format, Rating, index, Comment);
}