PKHeX/PKHeX.Core/Saves/Substructures/Gen7/BattleTree7.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

129 lines
4.3 KiB
C#

using System;
using System.ComponentModel;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
public sealed class BattleTree7 : SaveBlock
{
public BattleTree7(SAV7SM sav, int offset) : base(sav) => Offset = offset;
public BattleTree7(SAV7USUM sav, int offset) : base(sav) => Offset = offset;
public int GetTreeStreak(int battletype, bool super, bool max)
{
if (battletype > 3)
throw new ArgumentOutOfRangeException(nameof(battletype));
var offset = GetStreakOffset(battletype, super, max);
return ReadUInt16LittleEndian(Data.AsSpan(Offset + offset));
}
public void SetTreeStreak(int value, int battletype, bool super, bool max)
{
if (battletype > 3)
throw new ArgumentOutOfRangeException(nameof(battletype));
if (value > ushort.MaxValue)
value = ushort.MaxValue;
var offset = GetStreakOffset(battletype, super, max);
WriteUInt16LittleEndian(Data.AsSpan(Offset + offset), (ushort)value);
}
private static int GetStreakOffset(int battletype, bool super, bool max)
{
int offset = 8 * battletype;
if (super)
offset += 2;
if (max)
offset += 4;
return offset;
}
private const int ScoutCount = 50;
public BattleTreeTrainer GetTrainer(in int index)
{
if ((uint)index >= ScoutCount)
throw new ArgumentOutOfRangeException(nameof(index));
var id = ReadInt16LittleEndian(Data.AsSpan(Offset + 0x24 + (index * 2)));
var p1 = ReadInt16LittleEndian(Data.AsSpan(Offset + 0x88 + (index * 2)));
var p2 = ReadInt16LittleEndian(Data.AsSpan(Offset + 0xEC + (index * 2)));
var a1 = (sbyte)Data[Offset + 0x154 + index];
var a2 = (sbyte)Data[Offset + 0x186 + index];
var poke1 = new BattleTreePokemon(p1, a1);
var poke2 = new BattleTreePokemon(p2, a2);
return new BattleTreeTrainer(id, poke1, poke2);
}
public void SetTrainer(BattleTreeTrainer tr, in int index)
{
if ((uint)index >= ScoutCount)
throw new ArgumentOutOfRangeException(nameof(index));
WriteInt16LittleEndian(Data.AsSpan(Offset + 0x24 + (index * 2)), tr.ID );
WriteInt16LittleEndian(Data.AsSpan(Offset + 0x88 + (index * 2)), tr.Poke1.ID);
WriteInt16LittleEndian(Data.AsSpan(Offset + 0xEC + (index * 2)), tr.Poke2.ID);
Data[Offset + 0x154 + index] = (byte)tr.Poke1.AbilityIndex;
Data[Offset + 0x186 + index] = (byte)tr.Poke2.AbilityIndex;
}
public int Music
{
get => ReadInt32LittleEndian(Data.AsSpan(Offset + 0x18));
set => WriteInt32LittleEndian(Data.AsSpan(Offset + 0x18), value);
}
public BattleTreeTrainer[] ScoutedTrainers
{
get
{
var result = new BattleTreeTrainer[ScoutCount];
for (int i = 0; i < result.Length; i++)
result[i] = GetTrainer(i);
return result;
}
set
{
for (int i = 0; i < value.Length; i++)
SetTrainer(value[i], i);
}
}
}
[TypeConverter(typeof(ValueTypeTypeConverter))]
public sealed class BattleTreeTrainer
{
public short ID { get; set; }
public BattleTreePokemon Poke1 { get; set; }
public BattleTreePokemon Poke2 { get; set; }
public BattleTreeTrainer(short id, BattleTreePokemon poke1, BattleTreePokemon poke2)
{
ID = id;
Poke1 = poke1;
Poke2 = poke2;
}
public override string ToString() => $"{ID}: [{Poke1}] & [{Poke2}]";
}
[TypeConverter(typeof(ValueTypeTypeConverter))]
public sealed class BattleTreePokemon
{
public short ID { get; set; }
public sbyte AbilityIndex { get; set; }
public BattleTreePokemon(short p1, sbyte a1)
{
ID = p1;
AbilityIndex = a1;
}
public override string ToString() => $"{ID},{AbilityIndex}";
}
}