PKHeX/PKHeX.Core/Saves/Substructures/Gen6/MysteryBlock6.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

75 lines
No EOL
2.6 KiB
C#

using System;
namespace PKHeX.Core
{
public sealed class MysteryBlock6 : SaveBlock
{
private const int FlagStart = 0;
private const int MaxReceivedFlag = 2048;
private const int MaxCardsPresent = 24;
// private const int FlagRegionSize = (MaxReceivedFlag / 8); // 0x100
private const int CardStart = FlagStart + (MaxReceivedFlag / 8);
public MysteryBlock6(SAV6XY sav, int offset) : base(sav) => Offset = offset;
public MysteryBlock6(SAV6AO sav, int offset) : base(sav) => Offset = offset;
public bool[] GetReceivedFlags() => ArrayUtil.GitBitFlagArray(Data.AsSpan(Offset + FlagStart), MaxReceivedFlag);
public void SetReceivedFlags(bool[] value)
{
if (value.Length != MaxReceivedFlag)
return;
ArrayUtil.SetBitFlagArray(Data.AsSpan(Offset + FlagStart), value);
SAV.State.Edited = true;
}
public DataMysteryGift[] GetGifts()
{
var cards = new DataMysteryGift[MaxCardsPresent];
for (int i = 0; i < cards.Length; i++)
cards[i] = GetGift(i);
return cards;
}
public void SetGifts(DataMysteryGift[] value)
{
int count = Math.Min(MaxCardsPresent, value.Length);
for (int i = 0; i < count; i++)
SetGift(value[i], i);
for (int i = value.Length; i < MaxCardsPresent; i++)
SetGift(new WC6(), i);
}
public DataMysteryGift GetGift(int index)
{
if ((uint)index > MaxCardsPresent)
throw new ArgumentOutOfRangeException(nameof(index));
var offset = GetGiftOffset(index);
var data = SAV.GetData(offset, WC6.Size);
return new WC6(data);
}
private int GetGiftOffset(int index) => Offset + CardStart + (index * WC6.Size);
public void SetGift(DataMysteryGift wc6, int index)
{
if ((uint)index > MaxCardsPresent)
throw new ArgumentOutOfRangeException(nameof(index));
if (wc6.Data.Length != WC6.Size)
throw new InvalidCastException(nameof(wc6));
if (wc6.CardID == 2048 && wc6.ItemID == 726) // Eon Ticket (OR/AS)
{
if (SAV is not SAV6AO ao)
return;
// Set the special received data
var info = ao.Blocks.Sango;
info.ReceiveEon();
info.EnableSendEon();
}
SAV.SetData(wc6.Data, GetGiftOffset(index));
}
}
}