mirror of
https://github.com/kwsch/PKHeX.git
synced 2026-05-23 20:16:31 -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
25 lines
746 B
C#
25 lines
746 B
C#
using System;
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
/// <summary>
|
|
/// Exposes information about how moves are learned via Breeding.
|
|
/// </summary>
|
|
public interface IEggSource
|
|
{
|
|
/// <summary>
|
|
/// Checks if the <see cref="move"/> can be learned.
|
|
/// </summary>
|
|
/// <param name="species">Entity base species</param>
|
|
/// <param name="form">Entity base form</param>
|
|
/// <param name="move">Move to check</param>
|
|
bool GetIsEggMove(int species, int form, int move);
|
|
|
|
/// <summary>
|
|
/// Gets the egg move list that is permitted to be inherited.
|
|
/// </summary>
|
|
/// <param name="species">Entity base species</param>
|
|
/// <param name="form">Entity base form</param>
|
|
ReadOnlySpan<int> GetEggMoves(int species, int form);
|
|
}
|