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

88 lines
2.8 KiB
C#

using System;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core
{
public sealed class ConfigSave7 : SaveBlock
{
/* ===32 bits===
* talkSpeed:2 0,1
* battleAnim:1 2
* battleStyle:1 3
* unknown:9 4..12
* buttonMode:2 13,14
* boxStatus:1 15
* everything else: unknown
*/
public ConfigSave7(SAV7SM sav, int offset) : base(sav) => Offset = offset;
public ConfigSave7(SAV7USUM sav, int offset) : base(sav) => Offset = offset;
public int ConfigValue
{
get => ReadInt32LittleEndian(Data.AsSpan(Offset));
set => WriteInt32LittleEndian(Data.AsSpan(Offset), value);
}
public int TalkingSpeed
{
get => ConfigValue & 3;
set => ConfigValue = (ConfigValue & ~3) | (value & 3);
}
public BattleAnimationSetting BattleAnimation
{
// Effects OFF = 1, Effects ON = 0
get => (BattleAnimationSetting)((ConfigValue >> 2) & 1);
set => ConfigValue = (ConfigValue & ~(1 << 2)) | ((byte)value << 2);
}
public BattleStyleSetting BattleStyle
{
// SET = 1, SWITCH = 0
get => (BattleStyleSetting)((ConfigValue >> 3) & 1);
set => ConfigValue = (ConfigValue & ~(1 << 3)) | ((byte)value << 3);
}
// UNKNOWN?
public int ButtonMode
{
get => (ConfigValue >> 13) & 3;
set => ConfigValue = (ConfigValue & ~(1 << 13)) | (value << 13);
}
public int BoxStatus
{
// MANUAL = 1, AUTOMATIC = 0
get => (ConfigValue >> 15) & 1;
set => ConfigValue = (ConfigValue & ~(1 << 15)) | (value << 15);
}
// NOTE: BELOW COMES FROM LGPE. MAYBE THIS IS WHAT THEY USE THE FLAGS FOR?
/// <summary>
/// <see cref="LanguageID"/> for messages, stored with <see cref="LanguageID.UNUSED_6"/> skipped in the enumeration.
/// </summary>
public int Language
{
get => GetLanguageID((ConfigValue >> 4) & 0xF);
set => ConfigValue = ((ConfigValue & ~0xF0) | SetLanguageID(value) << 4);
}
private static int GetLanguageID(int rawValue) => rawValue >= (int)LanguageID.UNUSED_6 ? rawValue + 1 : rawValue; // sets langBank to LanguageID
private static int SetLanguageID(int rawValue) => rawValue > (int)LanguageID.UNUSED_6 ? rawValue - 1 : rawValue; // sets LanguageID to langBank
public enum BattleAnimationSetting
{
EffectsON,
EffectsOFF,
}
public enum BattleStyleSetting
{
SWITCH,
SET,
}
}
}