PKHeX/PKHeX.Core/MysteryGifts/WR7.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

154 lines
6 KiB
C#

using System;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core;
/// <summary>
/// Record of a received <see cref="WB7"/> file.
/// </summary>
/// <remarks>
/// A full <see cref="WB7"/> is not stored in the <see cref="SAV7b"/> structure, as it is immediately converted to <see cref="PKM"/> upon receiving from server.
/// The save file just stores a summary of the received data for the user to look back at.
/// </remarks>
public sealed class WR7 : DataMysteryGift
{
public const int Size = 0x140;
public override int Generation => 7;
public override EntityContext Context => EntityContext.Gen7;
public override GameVersion Version { get => GameVersion.GG; set { } }
public WR7() : this(new byte[Size]) { }
public WR7(byte[] data) : base(data) { }
public override AbilityPermission Ability => AbilityPermission.Any12H; // undefined
public uint Epoch
{
get => ReadUInt32LittleEndian(Data.AsSpan(0x00));
set => WriteUInt32LittleEndian(Data.AsSpan(0x00), value);
}
public DateTime Date => new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc).AddSeconds(Epoch);
public override int CardID
{
get => ReadUInt16LittleEndian(Data.AsSpan(0x08));
set => WriteUInt16LittleEndian(Data.AsSpan(0x08), (ushort)value);
}
public ushort CardType
{
get => ReadUInt16LittleEndian(Data.AsSpan(0x0A));
set => WriteUInt16LittleEndian(Data.AsSpan(0x0A), value);
}
public WR7GiftType GiftType
{
get => (WR7GiftType)Data[0x0C];
set => Data[0x0C] = (byte)value;
}
public int ItemCount
{
get => Data[0x0D];
set => Data[0x0D] = (byte)value;
}
// unknown: region from 0x10 to 0xFF ?
public override int Species
{
get => ReadUInt16LittleEndian(Data.AsSpan(0x10C));
set => WriteUInt16LittleEndian(Data.AsSpan(0x10C), (ushort)value);
}
public override bool GiftUsed { get; set; }
public override byte Level // are moves stored? mew has '1' but this could be move
{
get => Data[0x10E];
set => Data[0x10E] = value;
}
public override int ItemID { get => ReadUInt16LittleEndian(Data.AsSpan(0x110)); set => WriteUInt16LittleEndian(Data.AsSpan(0x110), (ushort)value); }
public ushort ItemIDCount { get => ReadUInt16LittleEndian(Data.AsSpan(0x112)); set => WriteUInt16LittleEndian(Data.AsSpan(0x112), value); }
public ushort ItemSet2Item { get => ReadUInt16LittleEndian(Data.AsSpan(0x114)); set => WriteUInt16LittleEndian(Data.AsSpan(0x114), value); }
public ushort ItemSet2Count { get => ReadUInt16LittleEndian(Data.AsSpan(0x116)); set => WriteUInt16LittleEndian(Data.AsSpan(0x116), value); }
public ushort ItemSet3Item { get => ReadUInt16LittleEndian(Data.AsSpan(0x118)); set => WriteUInt16LittleEndian(Data.AsSpan(0x118), value); }
public ushort ItemSet3Count { get => ReadUInt16LittleEndian(Data.AsSpan(0x11A)); set => WriteUInt16LittleEndian(Data.AsSpan(0x11A), value); }
public ushort ItemSet4Item { get => ReadUInt16LittleEndian(Data.AsSpan(0x11C)); set => WriteUInt16LittleEndian(Data.AsSpan(0x11C), value); }
public ushort ItemSet4Count { get => ReadUInt16LittleEndian(Data.AsSpan(0x11E)); set => WriteUInt16LittleEndian(Data.AsSpan(0x11E), value); }
public ushort ItemSet5Item { get => ReadUInt16LittleEndian(Data.AsSpan(0x120)); set => WriteUInt16LittleEndian(Data.AsSpan(0x120), value); } // struct union overlaps OT Name data, beware!
public ushort ItemSet5Count { get => ReadUInt16LittleEndian(Data.AsSpan(0x122)); set => WriteUInt16LittleEndian(Data.AsSpan(0x122), value); }
public ushort ItemSet6Item { get => ReadUInt16LittleEndian(Data.AsSpan(0x124)); set => WriteUInt16LittleEndian(Data.AsSpan(0x124), value); }
public ushort ItemSet6Count { get => ReadUInt16LittleEndian(Data.AsSpan(0x126)); set => WriteUInt16LittleEndian(Data.AsSpan(0x126), value); }
public override int Gender { get; set; }
public override int Form { get; set; }
public override int TID { get; set; }
public override int SID { get; set; }
public override string OT_Name
{
get => StringConverter8.GetString(Data.AsSpan(0x120, 0x1A));
set => StringConverter8.SetString(Data.AsSpan(0x120, 0x1A), value.AsSpan(), 12, StringConverterOption.ClearZero);
}
public LanguageID LanguageReceived
{
get => (LanguageID)Data[0x13A];
set => Data[0x13A] = (byte)value;
}
// Mystery Gift implementation, unused.
public override bool IsMatchExact(PKM pk, EvoCriteria evo) => false;
protected override bool IsMatchDeferred(PKM pk) => false;
protected override bool IsMatchPartial(PKM pk) => false;
public override Shiny Shiny => Shiny.Never;
public override int Location { get; set; }
public override int EggLocation { get; set; }
public override int Ball { get; set; } = 4;
public override string CardTitle { get => $"{nameof(WB7)} Record ({OT_Name}) [{LanguageReceived}]"; set { } }
public override bool IsItem
{
get => GiftType == WR7GiftType.Item;
set
{
if (value)
GiftType = WR7GiftType.Item;
}
}
public override bool IsEntity
{
get => GiftType == WR7GiftType.Pokemon;
set
{
if (value)
GiftType = WR7GiftType.Pokemon;
}
}
public override PKM ConvertToPKM(ITrainerInfo tr, EncounterCriteria criteria)
{
// this method shouldn't really be called, use the WB7 data not the WR7 data.
if (!IsEntity)
throw new ArgumentException(nameof(IsEntity));
// we'll just generate something as close as we can, since we must return something!
var pk = new PB7();
tr.ApplyTo(pk);
if (!GameVersion.GG.Contains((GameVersion) tr.Game))
pk.Version = (int) GameVersion.GP;
pk.Species = Species;
pk.Met_Level = pk.CurrentLevel = Level;
pk.MetDate = Date;
return pk; // can't really do much more, just return the rough data
}
}