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

194 lines
7.5 KiB
C#

using System;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
public sealed class EventWork7b : SaveBlock, IEventVar<int>
{
public EventWork7b(SAV7b sav, int offset) : base(sav)
{
Offset = offset;
// Zone @ 0x21A0 - 0x21AF (128 flags)
// System @ 0x21B0 - 0x21EF (512 flags) -- is this really 256 instead, with another 256 region after for the small vanish?
// Vanish @ 0x21F0 - 0x22AF (1536 flags)
// Event @ 0x22B0 - 0x23A7 (rest of the flags) (512) -- I think trainer flags are afterwards.... For now, this is a catch-all
// time flags (39 used flags of 42) = 6 bytes 0x22F0-0x22F5
// trainer flags (???) = 0x22F6 - end?
// Title flags @ 0x2498 - 0x24AB (160 flags): unlocked Master Trainer Titles (last 4 unused)
}
// Overall Layout
private const int WorkCount = 1000;
private const int WorkSize = sizeof(int);
private const int FlagStart = WorkCount * WorkSize;
private const int FlagCount = EventFlagStart + EventFlagCount;
// Breakdown!
private const int ZoneWorkCount = 0x20; // 32
private const int SystemWorkCount = 0x80; // 128
private const int SceneWorkCount = 0x200; // 512
private const int EventWorkCount = 0x100; // 256
// private const int UnusedWorkCount = 72;
private const int ZoneWorkStart = 0;
private const int SystemWorkStart = ZoneWorkStart + ZoneWorkCount;
private const int SceneWorkStart = SystemWorkStart + SystemWorkCount;
private const int EventWorkStart = SceneWorkStart + SceneWorkCount;
private const int ZoneFlagCount = 0x80; // 128
private const int SystemFlagCount = 0x200; // 512
private const int VanishFlagCount = 0x600; // 1536
private const int EventFlagCount = 0x7C0; // 1984
private const int ZoneFlagStart = 0;
private const int SystemFlagStart = ZoneFlagStart + ZoneFlagCount;
private const int VanishFlagStart = SystemFlagStart + SystemFlagCount;
private const int EventFlagStart = VanishFlagStart + VanishFlagCount;
// Work/Flag ends at 0x11A8 (relative to block start). Other data undocumented unless noted below.
private const int TitleFlagStart = 0x1298; // 0x1298
public const int MaxTitleFlag = 156; // Trainer, [1..153], Grand, Battle
public int CountFlag => FlagCount;
public int CountWork => WorkCount;
public int GetWork(int index) => ReadInt32LittleEndian(Data.AsSpan(Offset + (index * WorkSize)));
public void SetWork(int index, int value) => WriteInt32LittleEndian(Data.AsSpan(Offset + (index * WorkSize)), value);
public int GetWork(EventVarType type, int index) => GetWork(GetWorkRawIndex(type, index));
public void SetWork(EventVarType type, int index, int value) => SetWork(GetWorkRawIndex(type, index), value);
public bool GetFlag(EventVarType type, int index) => GetFlag(GetFlagRawIndex(type, index));
public void SetFlag(EventVarType type, int index, bool value = true) => SetFlag(GetFlagRawIndex(type, index), value);
public int GetFlagRawIndex(EventVarType type, int index)
{
int max = GetFlagCount(type);
if ((uint)index > max)
throw new ArgumentOutOfRangeException(nameof(index));
var start = GetFlagStart(type);
return start + index;
}
public int GetWorkRawIndex(EventVarType type, int index)
{
int max = GetWorkCount(type);
if ((uint)index > max)
throw new ArgumentOutOfRangeException(nameof(index));
var start = GetWorkStart(type);
return start + index;
}
public bool GetFlag(int index)
{
var offset = Offset + FlagStart + (index >> 3);
return FlagUtil.GetFlag(Data, offset, index);
}
public void SetFlag(int index, bool value = true)
{
var offset = Offset + FlagStart + (index >> 3);
FlagUtil.SetFlag(Data, offset, index, value);
}
public EventVarType GetFlagType(int index, out int subIndex)
{
subIndex = index;
if (index < ZoneFlagCount)
return EventVarType.Zone;
subIndex -= ZoneFlagCount;
if (subIndex < SystemFlagCount)
return EventVarType.System;
subIndex -= SystemFlagCount;
if (subIndex < VanishFlagCount)
return EventVarType.Vanish;
subIndex -= VanishFlagCount;
if (subIndex < EventFlagCount)
return EventVarType.Event;
throw new ArgumentOutOfRangeException(nameof(index));
}
public EventVarType GetWorkType(int index, out int subIndex)
{
subIndex = index;
if (subIndex < ZoneWorkCount)
return EventVarType.Zone;
subIndex -= ZoneWorkCount;
if (subIndex < SystemWorkCount)
return EventVarType.System;
subIndex -= SystemWorkCount;
if (subIndex < SceneWorkCount)
return EventVarType.Scene;
subIndex -= SceneWorkCount;
if (subIndex < EventWorkCount)
return EventVarType.Event;
throw new ArgumentOutOfRangeException(nameof(index));
}
private static int GetFlagStart(EventVarType type) => type switch
{
EventVarType.Zone => ZoneFlagStart,
EventVarType.System => SystemFlagStart,
EventVarType.Vanish => VanishFlagStart,
EventVarType.Event => EventFlagStart,
_ => throw new ArgumentOutOfRangeException(nameof(type)),
};
private static int GetWorkStart(EventVarType type) => type switch
{
EventVarType.Zone => ZoneWorkStart,
EventVarType.System => SystemWorkStart,
EventVarType.Scene => SceneWorkStart,
EventVarType.Event => EventWorkStart,
_ => throw new ArgumentOutOfRangeException(nameof(type)),
};
private static int GetFlagCount(EventVarType type) => type switch
{
EventVarType.Zone => ZoneFlagCount,
EventVarType.System => SystemFlagCount,
EventVarType.Vanish => VanishFlagCount,
EventVarType.Event => EventFlagCount,
_ => throw new ArgumentOutOfRangeException(nameof(type)),
};
private static int GetWorkCount(EventVarType type) => type switch
{
EventVarType.Zone => ZoneWorkCount,
EventVarType.System => SystemWorkCount,
EventVarType.Scene => SceneWorkCount,
EventVarType.Event => EventWorkCount,
_ => throw new ArgumentOutOfRangeException(nameof(type)),
};
public bool GetTitleFlag(int index)
{
if ((uint)index >= MaxTitleFlag)
throw new ArgumentOutOfRangeException(nameof(index));
return FlagUtil.GetFlag(Data, Offset + TitleFlagStart + (index >> 3), index);
}
public void SetTitleFlag(int index, bool value = true)
{
if ((uint)index >= MaxTitleFlag)
throw new ArgumentOutOfRangeException(nameof(index));
FlagUtil.SetFlag(Data, Offset + TitleFlagStart + (index >> 3), index, value);
}
public void UnlockAllTitleFlags()
{
for (int i = 0; i < MaxTitleFlag; i++)
SetTitleFlag(i);
}
}
}