PKHeX/PKHeX.Core/Saves/Substructures/Gen5/Misc5.cs
Kurt 47071b41f3
Refactoring: Span-based value writes and method signatures (#3361)
Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to.

`System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API.

The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder.

Other Fixes included:
- The Super Training UI for Gen6 has been reworked according to the latest block structure additions.
- Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list).
- Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-02 21:35:59 -08:00

67 lines
2.3 KiB
C#

using System;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
public abstract class Misc5 : SaveBlock, IGymTeamInfo
{
protected Misc5(SAV5 sav, int offset) : base(sav) => Offset = offset;
public uint Money
{
get => ReadUInt32LittleEndian(Data.AsSpan(Offset));
set => WriteUInt32LittleEndian(Data.AsSpan(Offset), value);
}
public int Badges
{
get => Data[Offset + 0x4];
set => Data[Offset + 0x4] = (byte)value;
}
public ushort PokeTransferMinigameScore
{
get => ReadUInt16LittleEndian(Data.AsSpan(Offset + TransferMinigameScoreOffset));
set => WriteUInt16LittleEndian(Data.AsSpan(Offset + TransferMinigameScoreOffset), value);
}
protected abstract int BadgeVictoryOffset { get; }
protected abstract int TransferMinigameScoreOffset { get; }
private int GetBadgeVictorySpeciesOffset(uint badge, uint slot)
{
if (badge >= 8)
throw new ArgumentOutOfRangeException(nameof(badge));
if (slot >= 6)
throw new ArgumentOutOfRangeException(nameof(slot));
return Offset + BadgeVictoryOffset + (int)(((6 * badge) + slot) * sizeof(ushort));
}
public ushort GetBadgeVictorySpecies(uint badge, uint slot)
{
var ofs = GetBadgeVictorySpeciesOffset(badge, slot);
return ReadUInt16LittleEndian(Data.AsSpan(ofs));
}
public void SetBadgeVictorySpecies(uint badge, uint slot, ushort species)
{
var ofs = GetBadgeVictorySpeciesOffset(badge, slot);
WriteUInt16LittleEndian(SAV.Data.AsSpan(ofs), species);
}
}
public sealed class Misc5BW : Misc5
{
public Misc5BW(SAV5BW sav, int offset) : base(sav, offset) { }
protected override int TransferMinigameScoreOffset => 0x14;
protected override int BadgeVictoryOffset => 0x58; // thru 0xB7
}
public sealed class Misc5B2W2 : Misc5
{
public Misc5B2W2(SAV5B2W2 sav, int offset) : base(sav, offset) { }
protected override int TransferMinigameScoreOffset => 0x18;
protected override int BadgeVictoryOffset => 0x5C; // thru 0xBB
}
}