PKHeX/PKHeX.Core/Saves/Substructures/Battle Videos/BV3.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

106 lines
3.1 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
public sealed class BV3 : BattleVideo
{
internal const int SIZE = 0xF80;
public override int Generation => 3;
public override IReadOnlyList<PKM> BattlePKMs => PlayerTeams.SelectMany(z => z).ToArray();
public readonly byte[] Data;
internal new static bool IsValid(ReadOnlySpan<byte> data)
{
if (data.Length != SIZE)
return false;
var chk = ReadUInt32LittleEndian(data[(SIZE-4)..]);
if (chk > 0xF7080)
return false; // max if all are FF
var expect = GetChecksum8(data);
return chk == expect;
}
public BV3(byte[] data) => Data = (byte[])data.Clone();
public BV3() : this(new byte[SIZE]) { }
public IReadOnlyList<PK3[]> PlayerTeams
{
get => new[]
{
GetTeam(0),
GetTeam(1),
};
set
{
SetTeam(value[0], 0);
SetTeam(value[1], 1);
}
}
public PK3[] GetTeam(int teamIndex)
{
if ((uint)teamIndex > 2)
throw new ArgumentOutOfRangeException(nameof(teamIndex));
var ofs = (6 * PokeCrypto.SIZE_3PARTY) * teamIndex;
var team = new PK3[6];
for (int p = 0; p < 6; p++)
{
int offset = ofs + (PokeCrypto.SIZE_3PARTY * p);
team[p] = new PK3(Data.Slice(offset, PokeCrypto.SIZE_3PARTY));
}
return team;
}
public void SetTeam(IReadOnlyList<PK3> team, int teamIndex)
{
var ofs = (6 * PokeCrypto.SIZE_3PARTY) * teamIndex;
for (int p = 0; p < 6; p++)
{
int offset = ofs + (PokeCrypto.SIZE_3PARTY * p);
team[p].EncryptedPartyData.CopyTo(Data, offset);
}
}
// 0x4B0 - string3[4][8] Trainer Names
// 0x4D0 - u8[4] Trainer Genders
// 0x4D4 - u32[4] Trainer IDs
// 0x4E4 - u8[4] Trainer Languages
public uint Seed
{
get => ReadUInt32LittleEndian(Data.AsSpan(0x4E8));
set => WriteUInt32LittleEndian(Data.AsSpan(0x4E8), value);
}
public uint Mode
{
get => ReadUInt32LittleEndian(Data.AsSpan(0x4EC));
set => WriteUInt32LittleEndian(Data.AsSpan(0x4EC), value);
}
// ...
public uint Checksum
{
get => ReadUInt32LittleEndian(Data.AsSpan(SIZE - 4));
set => WriteUInt32LittleEndian(Data.AsSpan(SIZE - 4), value);
}
public bool IsChecksumValid() => Checksum == GetChecksum8(Data);
public static uint GetChecksum8(ReadOnlySpan<byte> data)
{
uint result = 0;
for (int i = 0; i < data.Length - 4; i++)
result += data[i];
return result;
}
}
}