PKHeX/PKHeX.Core/PersonalInfo/Info/PersonalInfo1.cs

93 lines
3.7 KiB
C#
Raw Normal View History

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;
namespace PKHeX.Core;
/// <summary>
/// <see cref="PersonalInfo"/> class with values from Generation 1 games.
/// </summary>
public sealed class PersonalInfo1 : PersonalInfo, IPersonalInfoTM
2016-08-27 09:48:04 +00:00
{
public const int SIZE = 0x1C;
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
private readonly byte[] Data;
public PersonalInfo1(byte[] data) => Data = data;
public override byte[] Write() => Data;
2016-08-27 09:48:04 +00:00
public override byte Gender { get => Data[0x00]; set => Data[0x00] = value; }
public override int HP { get => Data[0x01]; set => Data[0x01] = (byte)value; }
public override int ATK { get => Data[0x02]; set => Data[0x02] = (byte)value; }
public override int DEF { get => Data[0x03]; set => Data[0x03] = (byte)value; }
public override int SPE { get => Data[0x04]; set => Data[0x04] = (byte)value; }
public int SPC { get => Data[0x05]; set => Data[0x05] = (byte)value; }
public override int SPA { get => SPC; set => SPC = value; }
public override int SPD { get => SPC; set => SPC = value; }
public override byte Type1 { get => Data[0x06]; set => Data[0x06] = value; }
public override byte Type2 { get => Data[0x07]; set => Data[0x07] = value; }
public override int CatchRate { get => Data[0x08]; set => Data[0x08] = (byte)value; }
public override int BaseEXP { get => Data[0x09]; set => Data[0x09] = (byte)value; }
public byte Move1 { get => Data[0x0F]; set => Data[0x0F] = value; }
public byte Move2 { get => Data[0x10]; set => Data[0x10] = value; }
public byte Move3 { get => Data[0x11]; set => Data[0x11] = value; }
public byte Move4 { get => Data[0x12]; set => Data[0x12] = value; }
public override byte EXPGrowth { get => Data[0x13]; set => Data[0x13] = value; }
2016-08-27 09:48:04 +00:00
// EV Yields are just aliases for base stats in Gen I
public override int EV_HP { get => HP; set { } }
public override int EV_ATK { get => ATK; set { } }
public override int EV_DEF { get => DEF; set { } }
public override int EV_SPE { get => SPE; set { } }
public int EV_SPC => SPC;
public override int EV_SPA { get => EV_SPC; set { } }
public override int EV_SPD { get => EV_SPC; set { } }
2016-08-27 11:33:21 +00:00
// Future game values, unused
public override int EggGroup1 { get => 0; set { } }
public override int EggGroup2 { get => 0; set { } }
public override int GetIndexOfAbility(int abilityID) => -1;
public override int GetAbilityAtIndex(int abilityIndex) => -1;
public override int AbilityCount => 0;
public override int HatchCycles { get => 0; set { } }
public override int BaseFriendship { get => 0; set { } }
public override int EscapeRate { get => 0; set { } }
public override int Color { get => 0; set { } }
public void GetMoves(Span<ushort> value)
{
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
value[3] = Move4;
value[2] = Move3;
value[1] = Move2;
value[0] = Move1;
2016-08-27 09:48:04 +00:00
}
private const int TMHM = 0x14;
private const int CountTMHM = 50 + 5; // 50 TMs, 5 HMs
private const int ByteCountTM = (CountTMHM + 7) / 8;
public bool GetIsLearnTM(int index)
{
if ((uint)index >= CountTMHM)
return false;
return (Data[TMHM + (index >> 3)] & (1 << (index & 7))) != 0;
}
public void SetIsLearnTM(int index, bool value)
{
if ((uint)index >= CountTMHM)
return;
if (value)
Data[TMHM + (index >> 3)] |= (byte)(1 << (index & 7));
else
Data[TMHM + (index >> 3)] &= (byte)~(1 << (index & 7));
}
public void SetAllLearnTM(Span<bool> result, ReadOnlySpan<byte> moves)
{
var span = Data.AsSpan(TMHM, ByteCountTM);
for (int index = CountTMHM - 1; index >= 0; index--)
{
if ((span[index >> 3] & (1 << (index & 7))) != 0)
result[moves[index]] = true;
}
}
2016-08-27 09:48:04 +00:00
}