mirror of
https://github.com/kwsch/PKHeX.git
synced 2026-07-15 00:30:52 -05:00
cb967ef283
Inline some gameversion calls, replace `is IAlpha` with immutable interface instead Add interface to get the mastery object for a given a learnset source & species-form (rather than calling it statically) Shorten the BallUseLegality expression Defer ec%100 context to PKX (easy to miss in a future update if any others added down the road) Rewrite Alpha mark check logic to require entry in to HOME (tracker present) as that's the method of obtaining the mark Make SaveUtil not allocate, and let the compiler optimize size checks.
88 lines
3.6 KiB
C#
88 lines
3.6 KiB
C#
using System;
|
|
using System.Diagnostics.CodeAnalysis;
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
/// <summary>
|
|
/// Exposes information about how moves are learned in game.
|
|
/// </summary>
|
|
public interface ILearnSource
|
|
{
|
|
/// <summary>
|
|
/// Yields an iterable list of all potential moves that an <see cref="evo"/> can learn from this <see cref="ILearnSource"/>.
|
|
/// </summary>
|
|
/// <param name="result">Result storage for flags</param>
|
|
/// <param name="pk">Entity reference</param>
|
|
/// <param name="evo">Details about the state of the entity</param>
|
|
/// <param name="types">Types of move sources to iterate</param>
|
|
public void GetAllMoves(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types = MoveSourceType.All);
|
|
|
|
/// <summary>
|
|
/// Gets the learnset for the given <see cref="species"/> and <see cref="form"/>.
|
|
/// </summary>
|
|
/// <param name="species">Entity species</param>
|
|
/// <param name="form">Entity form</param>
|
|
public Learnset GetLearnset(ushort species, byte form);
|
|
|
|
public void SetEncounterMoves(ushort species, byte form, int level, Span<ushort> init)
|
|
{
|
|
var start = (init.LastIndexOfAnyExcept<ushort>(0) + 1) & 3;
|
|
var learn = GetLearnset(species, form);
|
|
learn.SetEncounterMoves(level, init, start);
|
|
}
|
|
|
|
public ReadOnlySpan<ushort> GetEggMoves(ushort species, byte form) => [];
|
|
|
|
public ReadOnlySpan<ushort> GetInheritMoves(ushort species, byte form)
|
|
{
|
|
if (!Breeding.GetCanInheritMoves(species))
|
|
return default;
|
|
return GetLearnset(species, form).GetAllMoves();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Indication of what environment this source is for.
|
|
/// </summary>
|
|
public LearnEnvironment Environment { get; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Exposes information about how moves are learned in game based on the game's <see cref="PersonalInfo"/>.
|
|
/// </summary>
|
|
public interface ILearnSource<T> : ILearnSource where T : PersonalInfo
|
|
{
|
|
/// <summary>
|
|
/// Checks if the <see cref="pk"/> can learn the requested <see cref="move"/> while existing as <see cref="evo"/>.
|
|
/// </summary>
|
|
/// <param name="pk">Entity reference</param>
|
|
/// <param name="pi">Entity game stats</param>
|
|
/// <param name="evo">Details about the state of the entity</param>
|
|
/// <param name="move">Move ID to check</param>
|
|
/// <param name="types">Types of move sources to iterate</param>
|
|
/// <param name="option">Option to check if it can be currently known, or previously known.</param>
|
|
/// <returns>Details about how the move can be learned. Will be equivalent to default if it cannot learn.</returns>
|
|
public MoveLearnInfo GetCanLearn(PKM pk, T pi, EvoCriteria evo, ushort move, MoveSourceType types = MoveSourceType.All, LearnOption option = LearnOption.Current);
|
|
|
|
/// <summary>
|
|
/// Gets the <see cref="T"/> for the given <see cref="species"/> and <see cref="form"/>.
|
|
/// </summary>
|
|
/// <param name="species">Entity species</param>
|
|
/// <param name="form">Entity form</param>
|
|
/// <param name="pi">Result value</param>
|
|
/// <returns>True if the <see cref="T"/> reference is a valid entity reference.</returns>
|
|
public bool TryGetPersonal(ushort species, byte form, [NotNullWhen(true)] out T? pi);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Interface for learnsets with paired learn behavior.
|
|
/// </summary>
|
|
public interface ILearnSourceBonus
|
|
{
|
|
/// <summary>
|
|
/// Gets the levelup learnset and other learnset for the given <see cref="species"/> and <see cref="form"/>.
|
|
/// </summary>
|
|
/// <param name="species">Entity species</param>
|
|
/// <param name="form">Entity form</param>
|
|
(Learnset Learn, Learnset Other) GetLearnsetAndOther(ushort species, byte form);
|
|
}
|