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

148 lines
4.8 KiB
C#

using System;
using System.Collections.Generic;
namespace PKHeX.Core
{
/// <inheritdoc cref="EncounterArea" />
/// <summary>
/// <see cref="GameVersion.GSC"/> encounter area
/// </summary>
public sealed record EncounterArea2 : EncounterArea
{
private static readonly byte[] BCC_SlotRates = { 20, 20, 10, 10, 05, 05, 10, 10, 05, 05 };
private static readonly byte[] RatesGrass = { 30, 30, 20, 10, 5, 4, 1 };
private static readonly byte[] RatesSurf = { 60, 30, 10 };
internal readonly EncounterTime Time;
public readonly int Rate;
public readonly IReadOnlyList<byte> Rates;
public readonly EncounterSlot2[] Slots;
protected override IReadOnlyList<EncounterSlot> Raw => Slots;
public static EncounterArea2[] GetAreas(byte[][] input, GameVersion game)
{
var result = new EncounterArea2[input.Length];
for (int i = 0; i < input.Length; i++)
result[i] = new EncounterArea2(input[i], game);
return result;
}
private EncounterArea2(ReadOnlySpan<byte> data, GameVersion game) : base(game)
{
Location = data[0];
Time = (EncounterTime)data[1];
var type = (Type = (SlotType)data[2]) & (SlotType)0xF;
var rate = data[3];
if (type is > SlotType.Surf and not SlotType.BugContest) // Not Grass/Surf
{
const int size = 5;
int count = (data.Length - 4) / size;
var rates = new byte[count];
for (int i = 0; i < rates.Length; i++)
rates[i] = data[4 + i];
Rates = rates;
Slots = ReadSlots(data, count, 4 + count);
}
else
{
Rate = rate;
const int size = 4;
int count = (data.Length - 4) / size;
Rates = type switch
{
SlotType.BugContest => BCC_SlotRates,
SlotType.Grass => RatesGrass,
_ => RatesSurf,
};
Slots = ReadSlots(data, count, 4);
}
}
private EncounterSlot2[] ReadSlots(ReadOnlySpan<byte> data, int count, int start)
{
var slots = new EncounterSlot2[count];
for (int i = 0; i < slots.Length; i++)
{
int offset = start + (4 * i);
var entry = data.Slice(offset, 4);
slots[i] = ReadSlot(entry);
}
return slots;
}
private EncounterSlot2 ReadSlot(ReadOnlySpan<byte> entry)
{
int species = entry[0];
int slotNum = entry[1];
int min = entry[2];
int max = entry[3];
return new EncounterSlot2(this, species, min, max, slotNum);
}
public override IEnumerable<EncounterSlot> GetMatchingSlots(PKM pkm, IReadOnlyList<EvoCriteria> chain)
{
if (pkm is not ICaughtData2 pk2 || pk2.CaughtData == 0)
return GetSlotsFuzzy(chain);
if (pk2.Met_Location != Location)
return Array.Empty<EncounterSlot>();
return GetSlotsSpecificLevelTime(chain, pk2.Met_TimeOfDay, pk2.Met_Level);
}
private IEnumerable<EncounterSlot2> GetSlotsSpecificLevelTime(IReadOnlyList<EvoCriteria> chain, int time, int lvl)
{
foreach (var slot in Slots)
{
foreach (var evo in chain)
{
if (slot.Species != evo.Species)
continue;
if (slot.Form != evo.Form)
{
if (slot.Species != (int)Species.Unown || evo.Form >= 26) // Don't yield !? forms
break;
}
if (!slot.IsLevelWithinRange(lvl))
break;
if (!Time.Contains(time))
break;
yield return slot;
break;
}
}
}
private IEnumerable<EncounterSlot2> 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)
{
if (slot.Species != (int) Species.Unown || evo.Form >= 26) // Don't yield !? forms
break;
}
if (slot.LevelMin > evo.Level)
break;
yield return slot;
break;
}
}
}
}
}