PKHeX/PKHeX.Core/Saves/Substructures/Gen3/SecretBase3.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

86 lines
2.9 KiB
C#

using System;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
public sealed class SecretBase3
{
private readonly byte[] Data;
private readonly int Offset;
private bool Japanese => Language == (int) LanguageID.Japanese;
public SecretBase3(byte[] data, int offset)
{
Data = data;
Offset = offset;
}
public int SecretBaseLocation { get => Data[Offset + 0]; set => Data[Offset + 0] = (byte) value; }
public int OT_Gender
{
get => (Data[Offset + 1] >> 4) & 1;
set => Data[Offset + 1] = (byte) ((Data[Offset + 1] & 0xEF) | (value & 1) << 4);
}
public bool BattledToday
{
get => ((Data[Offset + 1] >> 5) & 1) == 1;
set => Data[Offset + 1] = (byte)((Data[Offset + 1] & 0xDF) | (value ? 1 : 0) << 5);
}
public int RegistryStatus
{
get => (Data[Offset + 1] >> 6) & 3;
set => Data[Offset + 1] = (byte)((Data[Offset + 1] & 0x3F) | (value & 3) << 6);
}
public string OT_Name
{
get => StringConverter3.GetString(Data.AsSpan(Offset + 2, 7), Japanese);
set => StringConverter3.SetString(Data.AsSpan(Offset + 2, 7), value.AsSpan(), 7, Japanese, StringConverterOption.ClearFF);
}
public uint OT_ID
{
get => ReadUInt32LittleEndian(Data.AsSpan(Offset + 9));
set => WriteUInt32LittleEndian(Data.AsSpan(Offset + 9), value);
}
public int OT_Class => Data[Offset + 9] % 5;
public int Language { get => Data[Offset + 0x0D]; set => Data[Offset + 0x0D] = (byte)value; }
public ushort SecretBasesReceived
{
get => ReadUInt16LittleEndian(Data.AsSpan(Offset + 0x0E));
set => WriteUInt16LittleEndian(Data.AsSpan(Offset + 0x0E), value);
}
public byte TimesEntered { get => Data[Offset + 0x10]; set => Data[Offset + 0x10] = value; }
public int Unused11 { get => Data[Offset + 0x11]; set => Data[Offset + 0x11] = (byte)value; } // alignment padding
public byte[] GetDecorations() => Data.Slice(Offset + 0x12, 0x10);
public void SetDecorations(byte[] value) => value.CopyTo(Data, Offset + 0x12);
public byte[] GetDecorationCoordinates() => Data.Slice(Offset + 0x22, 0x10);
public void SetDecorationCoordinates(byte[] value) => value.CopyTo(Data, Offset + 0x22);
public SecretBase3Team Team
{
get => new(Data.Slice(Offset + 50, 72));
set => value.Write().CopyTo(Data, Offset + 50);
}
public int TID
{
get => (ushort)OT_ID;
set => OT_ID = (ushort)(SID | (ushort)value);
}
public int SID
{
get => (ushort)OT_ID >> 8;
set => OT_ID = (ushort)(((ushort)value << 16) | TID);
}
}
}