PKHeX/PKHeX.Core/Legality/Areas/EncounterArea3.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

165 lines
No EOL
5.2 KiB
C#

using System;
using System.Collections.Generic;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
/// <inheritdoc cref="EncounterArea" />
/// <summary>
/// <see cref="GameVersion.Gen3"/> encounter area
/// </summary>
public sealed record EncounterArea3 : EncounterArea
{
public readonly int Rate;
public readonly EncounterSlot3[] Slots;
protected override IReadOnlyList<EncounterSlot> Raw => Slots;
public static EncounterArea3[] GetAreas(byte[][] input, GameVersion game)
{
var result = new EncounterArea3[input.Length];
for (int i = 0; i < input.Length; i++)
result[i] = new EncounterArea3(input[i], game);
return result;
}
public static EncounterArea3[] GetAreasSwarm(byte[][] input, GameVersion game)
{
var result = new EncounterArea3[input.Length];
for (int i = 0; i < input.Length; i++)
result[i] = new EncounterArea3(input[i], game, SlotType.Swarm | SlotType.Grass);
return result;
}
private EncounterArea3(ReadOnlySpan<byte> data, GameVersion game) : base(game)
{
Location = data[0] | (data[1] << 8);
Type = (SlotType)data[2];
Rate = data[3];
Slots = ReadRegularSlots(data);
}
private EncounterArea3(ReadOnlySpan<byte> data, GameVersion game, SlotType type) : base(game)
{
Location = data[0] | (data[1] << 8);
Type = type;
Rate = data[3];
Slots = ReadSwarmSlots(data);
}
private EncounterSlot3[] ReadRegularSlots(ReadOnlySpan<byte> data)
{
const int size = 10;
int count = (data.Length - 4) / size;
var slots = new EncounterSlot3[count];
for (int i = 0; i < slots.Length; i++)
{
int offset = 4 + (size * i);
var entry = data.Slice(offset, size);
slots[i] = ReadRegularSlot(entry);
}
return slots;
}
private EncounterSlot3 ReadRegularSlot(ReadOnlySpan<byte> entry)
{
int species = ReadUInt16LittleEndian(entry);
int form = entry[2];
int slotNum = entry[3];
int min = entry[4];
int max = entry[5];
int mpi = entry[6];
int mpc = entry[7];
int sti = entry[8];
int stc = entry[9];
return new EncounterSlot3(this, species, form, min, max, slotNum, mpi, mpc, sti, stc);
}
private EncounterSlot3[] ReadSwarmSlots(ReadOnlySpan<byte> data)
{
const int size = 14;
int count = (data.Length - 4) / size;
var slots = new EncounterSlot3[count];
for (int i = 0; i < slots.Length; i++)
{
int offset = 4 + (size * i);
var entry = data.Slice(offset, size);
slots[i] = ReadSwarmSlot(entry);
}
return slots;
}
private EncounterSlot3Swarm ReadSwarmSlot(ReadOnlySpan<byte> entry)
{
int species = ReadUInt16LittleEndian(entry);
// form always 0
int slotNum = entry[3];
int min = entry[4];
int max = entry[5];
int[] moves =
{
ReadUInt16LittleEndian(entry[06..]),
ReadUInt16LittleEndian(entry[08..]),
ReadUInt16LittleEndian(entry[10..]),
ReadUInt16LittleEndian(entry[12..]),
};
return new EncounterSlot3Swarm(this, species, min, max, slotNum, moves);
}
public override IEnumerable<EncounterSlot> GetMatchingSlots(PKM pkm, IReadOnlyList<EvoCriteria> chain)
{
if (pkm.Format != 3) // Met Location and Met Level are changed on PK3->PK4
return GetSlotsFuzzy(chain);
if (pkm.Met_Location != Location)
return Array.Empty<EncounterSlot>();
return GetSlotsMatching(chain, pkm.Met_Level);
}
private IEnumerable<EncounterSlot3> GetSlotsMatching(IReadOnlyList<EvoCriteria> chain, int lvl)
{
foreach (var slot in Slots)
{
foreach (var evo in chain)
{
if (slot.Species != evo.Species)
continue;
if (slot.Form != evo.Form)
break;
if (!slot.IsLevelWithinRange(lvl))
break;
yield return slot;
break;
}
}
}
private IEnumerable<EncounterSlot3> GetSlotsFuzzy(IReadOnlyList<EvoCriteria> chain)
{
foreach (var slot in Slots)
{
foreach (var evo in chain)
{
if (slot.Species != evo.Species)
continue;
if (slot.Form != evo.Form)
break;
if (slot.LevelMin > evo.Level)
break;
yield return slot;
break;
}
}
}
}
}