PKHeX/PKHeX.Core/Saves/SAV5B2W2.cs
Kurt 9166d0eb64
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 16:15:27 -07:00

74 lines
2.7 KiB
C#

using System;
using System.Collections.Generic;
namespace PKHeX.Core;
/// <summary>
/// Generation 5 <see cref="SaveFile"/> object for <see cref="GameVersion.B2W2"/>.
/// </summary>
/// <inheritdoc cref="SAV5" />
public sealed class SAV5B2W2 : SAV5, ISaveBlock5B2W2
{
public SAV5B2W2() : base(SaveUtil.SIZE_G5RAW)
{
Blocks = new SaveBlockAccessor5B2W2(this);
Initialize();
}
public SAV5B2W2(byte[] data) : base(data)
{
Blocks = new SaveBlockAccessor5B2W2(this);
Initialize();
}
public override IPersonalTable Personal => PersonalTable.B2W2;
public SaveBlockAccessor5B2W2 Blocks { get; }
protected override SaveFile CloneInternal() => new SAV5B2W2((byte[]) Data.Clone());
public override int EventWorkCount => 0x1AF; // this doesn't seem right?
public override int EventFlagCount => 0xBF8;
protected override int EventWorkOffset => 0x1FF00;
protected override int EventFlagOffset => EventWorkOffset + 0x35E;
public override int MaxItemID => Legal.MaxItemID_5_B2W2;
private void Initialize()
{
BattleBoxOffset = 0x20900;
CGearInfoOffset = 0x1C000;
CGearDataOffset = 0x52800;
EntreeForestOffset = 0x22A00;
PokeDex = Blocks.Zukan.PokeDex;
WondercardData = Blocks.Mystery.Offset;
DaycareOffset = Blocks.Daycare.Offset;
}
public override IReadOnlyList<BlockInfo> AllBlocks => Blocks.BlockInfo;
public override MyItem Items => Blocks.Items;
public override Zukan5 Zukan => Blocks.Zukan;
public override Misc5 Misc => Blocks.Misc;
public override MysteryBlock5 Mystery => Blocks.Mystery;
public override Daycare5 Daycare => Blocks.Daycare;
public override BoxLayout5 BoxLayout => Blocks.BoxLayout;
public override PlayerData5 PlayerData => Blocks.PlayerData;
public override BattleSubway5 BattleSubway => Blocks.BattleSubway;
public override Entralink5 Entralink => Blocks.Entralink;
public override Musical5 Musical => Blocks.Musical;
public override Encount5 Encount => Blocks.Encount;
public FestaBlock5 Festa => Blocks.Festa;
public PWTBlock5 PWT => Blocks.PWT;
public override int Fused => 0x1FA00 + sizeof(uint);
public override int GTS => 0x20400;
public string Rival
{
get => GetString(Rival_Trash);
set => SetString(Rival_Trash, value.AsSpan(), OTLength, StringConverterOption.ClearZero);
}
public Span<byte> Rival_Trash
{
get => Data.AsSpan(0x23BA4, OTLength * 2);
set { if (value.Length == OTLength * 2) value.CopyTo(Data.AsSpan(0x23BA4)); }
}
public override string GetDaycareRNGSeed(int loc) => $"{Daycare.GetSeed()!:X16}";
}