Refactoring: Move Source (Legality) (#3560)
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
2022-08-03 23:15:27 +00:00
|
|
|
using System;
|
2022-01-03 05:35:59 +00:00
|
|
|
using static System.Buffers.Binary.BinaryPrimitives;
|
2016-11-08 16:43:57 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
2022-08-21 08:39:16 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Stores the valid Move IDs the entry can be obtained with.
|
|
|
|
/// </summary>
|
2022-06-18 18:04:24 +00:00
|
|
|
public abstract class EggMoves
|
2016-11-08 16:43:57 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
public readonly int[] Moves;
|
|
|
|
protected EggMoves(int[] moves) => Moves = moves;
|
Refactoring: Move Source (Legality) (#3560)
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
2022-08-03 23:15:27 +00:00
|
|
|
public bool GetHasEggMove(int move) => Array.IndexOf(Moves, move) != -1;
|
2022-06-18 18:04:24 +00:00
|
|
|
}
|
2017-02-28 04:57:24 +00:00
|
|
|
|
2022-08-21 08:39:16 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Specialized Egg Move storage for Generation 2.
|
|
|
|
/// </summary>
|
2022-06-18 18:04:24 +00:00
|
|
|
public sealed class EggMoves2 : EggMoves
|
|
|
|
{
|
|
|
|
private EggMoves2(int[] moves) : base(moves) { }
|
|
|
|
|
|
|
|
public static EggMoves2[] GetArray(ReadOnlySpan<byte> data, int count)
|
2017-02-28 04:57:24 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
var entries = new EggMoves2[count + 1];
|
|
|
|
var empty = entries[0] = new EggMoves2(Array.Empty<int>());
|
2018-08-03 03:11:42 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
int baseOffset = ReadInt16LittleEndian(data) - (count * 2);
|
|
|
|
for (int i = 1; i < entries.Length; i++)
|
2017-02-28 04:57:24 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
int start = ReadInt16LittleEndian(data[((i - 1) * 2)..]) - baseOffset;
|
|
|
|
var slice = data[start..];
|
|
|
|
int moveCount = slice.IndexOf((byte)0xFF);
|
|
|
|
if (moveCount == 0)
|
2020-12-28 18:22:13 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
entries[i] = empty;
|
|
|
|
continue;
|
2020-12-28 18:22:13 +00:00
|
|
|
}
|
2017-02-28 04:57:24 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
int[] moves = new int[moveCount];
|
|
|
|
for (int m = 0; m < moves.Length; m++)
|
|
|
|
moves[m] = slice[m];
|
|
|
|
|
|
|
|
entries[i] = new EggMoves2(moves);
|
2017-02-28 04:57:24 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
|
|
|
return entries;
|
2017-02-28 04:57:24 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
}
|
2018-08-03 03:11:42 +00:00
|
|
|
|
2022-08-21 08:39:16 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Specialized Egg Move storage for Generation 3-6.
|
|
|
|
/// </summary>
|
2022-06-18 18:04:24 +00:00
|
|
|
public sealed class EggMoves6 : EggMoves
|
|
|
|
{
|
|
|
|
private EggMoves6(int[] moves) : base(moves) { }
|
PKHeX.Core Nullable cleanup (#2401)
* Handle some nullable cases
Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data)
Make some classes have explicit constructors instead of { } initialization
* Handle bits more obviously without null
* Make SaveFile.BAK explicitly readonly again
* merge constructor methods to have readonly fields
* Inline some properties
* More nullable handling
* Rearrange box actions
define straightforward classes to not have any null properties
* Make extrabyte reference array immutable
* Move tooltip creation to designer
* Rearrange some logic to reduce nesting
* Cache generated fonts
* Split mystery gift album purpose
* Handle more tooltips
* Disallow null setters
* Don't capture RNG object, only type enum
* Unify learnset objects
Now have readonly properties which are never null
don't new() empty learnsets (>800 Learnset objects no longer created,
total of 2400 objects since we also new() a move & level array)
optimize g1/2 reader for early abort case
* Access rewrite
Initialize blocks in a separate object, and get via that object
removes a couple hundred "might be null" warnings since blocks are now readonly getters
some block references have been relocated, but interfaces should expose all that's needed
put HoF6 controls in a groupbox, and disable
* Readonly personal data
* IVs non nullable for mystery gift
* Explicitly initialize forced encounter moves
* Make shadow objects readonly & non-null
Put murkrow fix in binary data resource, instead of on startup
* Assign dex form fetch on constructor
Fixes legality parsing edge cases
also handle cxd parse for valid; exit before exception is thrown in FrameGenerator
* Remove unnecessary null checks
* Keep empty value until init
SetPouch sets the value to an actual one during load, but whatever
* Readonly team lock data
* Readonly locks
Put locked encounters at bottom (favor unlocked)
* Mail readonly data / offset
Rearrange some call flow and pass defaults
Add fake classes for SaveDataEditor mocking
Always party size, no need to check twice in stat editor
use a fake save file as initial data for savedata editor, and for
gamedata (wow i found a usage)
constrain eventwork editor to struct variable types (uint, int, etc),
thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public static EggMoves6[] GetArray(BinLinkerAccessor entries)
|
|
|
|
{
|
|
|
|
var result = new EggMoves6[entries.Length];
|
|
|
|
var empty = result[0] = new EggMoves6(Array.Empty<int>());
|
|
|
|
for (int i = 1; i < result.Length; i++)
|
2016-11-08 16:43:57 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
var data = entries[i];
|
|
|
|
int count = ReadInt16LittleEndian(data);
|
|
|
|
if (count == 0)
|
2022-03-01 02:06:45 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
result[i] = empty;
|
|
|
|
continue;
|
2022-03-01 02:06:45 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
|
|
|
var moves = new int[count];
|
|
|
|
var span = data[2..];
|
|
|
|
for (int j = 0; j < moves.Length; j++)
|
|
|
|
moves[j] = ReadInt16LittleEndian(span[(j * 2)..]);
|
|
|
|
result[i] = new EggMoves6(moves);
|
2016-11-08 16:43:57 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
return result;
|
2016-11-08 16:43:57 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
}
|
2018-08-03 03:11:42 +00:00
|
|
|
|
2022-08-21 08:39:16 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Specialized Egg Move storage for Generation 7+.
|
|
|
|
/// </summary>
|
2022-06-18 18:04:24 +00:00
|
|
|
public sealed class EggMoves7 : EggMoves
|
|
|
|
{
|
2022-08-21 08:39:16 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Points to the index where form data is, within the parent Egg Move object array.
|
|
|
|
/// </summary>
|
2022-06-18 18:04:24 +00:00
|
|
|
public readonly int FormTableIndex;
|
PKHeX.Core Nullable cleanup (#2401)
* Handle some nullable cases
Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data)
Make some classes have explicit constructors instead of { } initialization
* Handle bits more obviously without null
* Make SaveFile.BAK explicitly readonly again
* merge constructor methods to have readonly fields
* Inline some properties
* More nullable handling
* Rearrange box actions
define straightforward classes to not have any null properties
* Make extrabyte reference array immutable
* Move tooltip creation to designer
* Rearrange some logic to reduce nesting
* Cache generated fonts
* Split mystery gift album purpose
* Handle more tooltips
* Disallow null setters
* Don't capture RNG object, only type enum
* Unify learnset objects
Now have readonly properties which are never null
don't new() empty learnsets (>800 Learnset objects no longer created,
total of 2400 objects since we also new() a move & level array)
optimize g1/2 reader for early abort case
* Access rewrite
Initialize blocks in a separate object, and get via that object
removes a couple hundred "might be null" warnings since blocks are now readonly getters
some block references have been relocated, but interfaces should expose all that's needed
put HoF6 controls in a groupbox, and disable
* Readonly personal data
* IVs non nullable for mystery gift
* Explicitly initialize forced encounter moves
* Make shadow objects readonly & non-null
Put murkrow fix in binary data resource, instead of on startup
* Assign dex form fetch on constructor
Fixes legality parsing edge cases
also handle cxd parse for valid; exit before exception is thrown in FrameGenerator
* Remove unnecessary null checks
* Keep empty value until init
SetPouch sets the value to an actual one during load, but whatever
* Readonly team lock data
* Readonly locks
Put locked encounters at bottom (favor unlocked)
* Mail readonly data / offset
Rearrange some call flow and pass defaults
Add fake classes for SaveDataEditor mocking
Always party size, no need to check twice in stat editor
use a fake save file as initial data for savedata editor, and for
gamedata (wow i found a usage)
constrain eventwork editor to struct variable types (uint, int, etc),
thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
private EggMoves7(int[] moves, int formIndex = 0) : base(moves) => FormTableIndex = formIndex;
|
PKHeX.Core Nullable cleanup (#2401)
* Handle some nullable cases
Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data)
Make some classes have explicit constructors instead of { } initialization
* Handle bits more obviously without null
* Make SaveFile.BAK explicitly readonly again
* merge constructor methods to have readonly fields
* Inline some properties
* More nullable handling
* Rearrange box actions
define straightforward classes to not have any null properties
* Make extrabyte reference array immutable
* Move tooltip creation to designer
* Rearrange some logic to reduce nesting
* Cache generated fonts
* Split mystery gift album purpose
* Handle more tooltips
* Disallow null setters
* Don't capture RNG object, only type enum
* Unify learnset objects
Now have readonly properties which are never null
don't new() empty learnsets (>800 Learnset objects no longer created,
total of 2400 objects since we also new() a move & level array)
optimize g1/2 reader for early abort case
* Access rewrite
Initialize blocks in a separate object, and get via that object
removes a couple hundred "might be null" warnings since blocks are now readonly getters
some block references have been relocated, but interfaces should expose all that's needed
put HoF6 controls in a groupbox, and disable
* Readonly personal data
* IVs non nullable for mystery gift
* Explicitly initialize forced encounter moves
* Make shadow objects readonly & non-null
Put murkrow fix in binary data resource, instead of on startup
* Assign dex form fetch on constructor
Fixes legality parsing edge cases
also handle cxd parse for valid; exit before exception is thrown in FrameGenerator
* Remove unnecessary null checks
* Keep empty value until init
SetPouch sets the value to an actual one during load, but whatever
* Readonly team lock data
* Readonly locks
Put locked encounters at bottom (favor unlocked)
* Mail readonly data / offset
Rearrange some call flow and pass defaults
Add fake classes for SaveDataEditor mocking
Always party size, no need to check twice in stat editor
use a fake save file as initial data for savedata editor, and for
gamedata (wow i found a usage)
constrain eventwork editor to struct variable types (uint, int, etc),
thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public static EggMoves7[] GetArray(BinLinkerAccessor entries)
|
|
|
|
{
|
|
|
|
var result = new EggMoves7[entries.Length];
|
|
|
|
var empty = result[0] = new EggMoves7(Array.Empty<int>());
|
|
|
|
for (int i = 1; i < result.Length; i++)
|
2016-11-08 16:43:57 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
var data = entries[i];
|
|
|
|
int count = ReadInt16LittleEndian(data[2..]);
|
|
|
|
int formIndex = ReadInt16LittleEndian(data);
|
|
|
|
if (count == 0)
|
2022-03-01 02:06:45 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
// Might need to keep track of the Form Index for unavailable forms pointing to valid forms.
|
|
|
|
if (formIndex != 0)
|
|
|
|
result[i] = new EggMoves7(Array.Empty<int>(), formIndex);
|
|
|
|
else
|
|
|
|
result[i] = empty;
|
|
|
|
continue;
|
2022-03-01 02:06:45 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
|
|
|
var moves = new int[count];
|
|
|
|
var span = data[4..];
|
|
|
|
for (int j = 0; j < moves.Length; j++)
|
|
|
|
moves[j] = ReadInt16LittleEndian(span[(j * 2)..]);
|
|
|
|
result[i] = new EggMoves7(moves, formIndex);
|
2016-11-08 16:43:57 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
return result;
|
2016-11-08 16:43:57 +00:00
|
|
|
}
|
|
|
|
}
|