mirror of
https://github.com/kwsch/PKHeX
synced 2024-11-23 12:33:06 +00:00
47071b41f3
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.
206 lines
7.7 KiB
C#
206 lines
7.7 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
|
|
namespace PKHeX.Core
|
|
{
|
|
/// <summary>
|
|
/// Generation 8 <see cref="SaveFile"/> object for <see cref="GameVersion.SWSH"/> games.
|
|
/// </summary>
|
|
public sealed class SAV8SWSH : SAV8, ISaveBlock8SWSH, ITrainerStatRecord, ISaveFileRevision
|
|
{
|
|
public SAV8SWSH(byte[] data) : base(data)
|
|
{
|
|
Data = Array.Empty<byte>();
|
|
AllBlocks = SwishCrypto.Decrypt(data);
|
|
Blocks = new SaveBlockAccessor8SWSH(this);
|
|
SaveRevision = Zukan.GetRevision();
|
|
Initialize();
|
|
}
|
|
|
|
private SAV8SWSH(byte[] data, IReadOnlyList<SCBlock> blocks) : base(data)
|
|
{
|
|
Data = Array.Empty<byte>();
|
|
AllBlocks = blocks;
|
|
Blocks = new SaveBlockAccessor8SWSH(this);
|
|
SaveRevision = Zukan.GetRevision();
|
|
Initialize();
|
|
}
|
|
|
|
public SAV8SWSH()
|
|
{
|
|
AllBlocks = Meta8.GetBlankDataSWSH();
|
|
Blocks = new SaveBlockAccessor8SWSH(this);
|
|
SaveRevision = Zukan.GetRevision();
|
|
Initialize();
|
|
ClearBoxes();
|
|
}
|
|
|
|
public override void CopyChangesFrom(SaveFile sav)
|
|
{
|
|
// Absorb changes from all blocks
|
|
var z = (SAV8SWSH)sav;
|
|
var mine = AllBlocks;
|
|
var newB = z.AllBlocks;
|
|
for (int i = 0; i < mine.Count; i++)
|
|
newB[i].Data.CopyTo(mine[i].Data, 0);
|
|
State.Edited = true;
|
|
}
|
|
|
|
public int SaveRevision { get; }
|
|
|
|
public string SaveRevisionString => SaveRevision switch
|
|
{
|
|
0 => "-Base", // Vanilla
|
|
1 => "-IoA", // DLC 1: Isle of Armor
|
|
2 => "-CT", // DLC 2: Crown Tundra
|
|
_ => throw new ArgumentOutOfRangeException(nameof(SaveRevision)),
|
|
};
|
|
|
|
public IReadOnlyList<SCBlock> AllBlocks { get; }
|
|
public override bool ChecksumsValid => true;
|
|
public override string ChecksumInfo => string.Empty;
|
|
protected override void SetChecksums() { } // None!
|
|
protected override byte[] GetFinalData() => SwishCrypto.Encrypt(AllBlocks);
|
|
|
|
public override PersonalTable Personal => PersonalTable.SWSH;
|
|
public override IReadOnlyList<ushort> HeldItems => Legal.HeldItems_SWSH;
|
|
|
|
#region Blocks
|
|
public SaveBlockAccessor8SWSH Blocks { get; }
|
|
public override Box8 BoxInfo => Blocks.BoxInfo;
|
|
public override Party8 PartyInfo => Blocks.PartyInfo;
|
|
public override MyItem Items => Blocks.Items;
|
|
public override MyStatus8 MyStatus => Blocks.MyStatus;
|
|
public override Misc8 Misc => Blocks.Misc;
|
|
public override Zukan8 Zukan => Blocks.Zukan;
|
|
public override BoxLayout8 BoxLayout => Blocks.BoxLayout;
|
|
public override PlayTime8 Played => Blocks.Played;
|
|
public override Fused8 Fused => Blocks.Fused;
|
|
public override Daycare8 Daycare => Blocks.Daycare;
|
|
public override Record8 Records => Blocks.Records;
|
|
public override TrainerCard8 TrainerCard => Blocks.TrainerCard;
|
|
public override RaidSpawnList8 Raid => Blocks.Raid;
|
|
public override RaidSpawnList8 RaidArmor => Blocks.RaidArmor;
|
|
public override RaidSpawnList8 RaidCrown => Blocks.RaidCrown;
|
|
public override TitleScreen8 TitleScreen => Blocks.TitleScreen;
|
|
public override TeamIndexes8 TeamIndexes => Blocks.TeamIndexes;
|
|
|
|
public T GetValue<T>(uint key) where T : struct
|
|
{
|
|
if (!State.Exportable)
|
|
return default;
|
|
var value = Blocks.GetBlockValue(key);
|
|
if (value is T v)
|
|
return v;
|
|
throw new ArgumentException($"Incorrect type request! Expected {typeof(T).Name}, received {value.GetType().Name}", nameof(T));
|
|
}
|
|
|
|
public void SetValue<T>(uint key, T value) where T : struct
|
|
{
|
|
if (!State.Exportable)
|
|
return;
|
|
Blocks.SetBlockValue(key, value);
|
|
}
|
|
|
|
#endregion
|
|
protected override SaveFile CloneInternal()
|
|
{
|
|
var blockCopy = new SCBlock[AllBlocks.Count];
|
|
for (int i = 0; i < AllBlocks.Count; i++)
|
|
blockCopy[i] = AllBlocks[i].Clone();
|
|
return new SAV8SWSH(State.BAK, blockCopy);
|
|
}
|
|
|
|
private int m_spec, m_item, m_move, m_abil;
|
|
public override int MaxMoveID => m_move;
|
|
public override int MaxSpeciesID => m_spec;
|
|
public override int MaxItemID => m_item;
|
|
public override int MaxBallID => Legal.MaxBallID_8;
|
|
public override int MaxGameID => Legal.MaxGameID_8;
|
|
public override int MaxAbilityID => m_abil;
|
|
|
|
private void Initialize()
|
|
{
|
|
Box = 0;
|
|
Party = 0;
|
|
PokeDex = 0;
|
|
TeamIndexes.LoadBattleTeams();
|
|
|
|
int rev = SaveRevision;
|
|
if (rev == 0)
|
|
{
|
|
m_move = Legal.MaxMoveID_8_O0;
|
|
m_spec = Legal.MaxSpeciesID_8_O0;
|
|
m_item = Legal.MaxItemID_8_O0;
|
|
m_abil = Legal.MaxAbilityID_8_O0;
|
|
}
|
|
else if (rev == 1)
|
|
{
|
|
m_move = Legal.MaxMoveID_8_R1;
|
|
m_spec = Legal.MaxSpeciesID_8_R1;
|
|
m_item = Legal.MaxItemID_8_R1;
|
|
m_abil = Legal.MaxAbilityID_8_R1;
|
|
}
|
|
else
|
|
{
|
|
m_move = Legal.MaxMoveID_8_R2;
|
|
m_spec = Legal.MaxSpeciesID_8_R2;
|
|
m_item = Legal.MaxItemID_8_R2;
|
|
m_abil = Legal.MaxAbilityID_8_R2;
|
|
}
|
|
}
|
|
|
|
public int GetRecord(int recordID) => Records.GetRecord(recordID);
|
|
public void SetRecord(int recordID, int value) => Records.SetRecord(recordID, value);
|
|
public int GetRecordMax(int recordID) => Records.GetRecordMax(recordID);
|
|
public int GetRecordOffset(int recordID) => Records.GetRecordOffset(recordID);
|
|
public int RecordCount => Record8.RecordCount;
|
|
|
|
public override StorageSlotFlag GetSlotFlags(int index)
|
|
{
|
|
int team = Array.IndexOf(TeamIndexes.TeamSlots, index);
|
|
if (team < 0)
|
|
return StorageSlotFlag.None;
|
|
|
|
team /= 6;
|
|
var result = (StorageSlotFlag)((int)StorageSlotFlag.BattleTeam1 << team);
|
|
if (TeamIndexes.GetIsTeamLocked(team))
|
|
result |= StorageSlotFlag.Locked;
|
|
return result;
|
|
}
|
|
|
|
public override int CurrentBox { get => BoxLayout.CurrentBox; set => BoxLayout.CurrentBox = value; }
|
|
public override int BoxesUnlocked { get => (byte)Blocks.GetBlockValue(SaveBlockAccessor8SWSH.KBoxesUnlocked); set => Blocks.SetBlockValue(SaveBlockAccessor8SWSH.KBoxesUnlocked, (byte)value); }
|
|
|
|
public override byte[] BoxFlags
|
|
{
|
|
get => new [] {Convert.ToByte(Blocks.GetBlock(SaveBlockAccessor8SWSH.KSecretBoxUnlocked).Type - 1)};
|
|
set
|
|
{
|
|
if (value.Length != 1)
|
|
return;
|
|
var block = Blocks.GetBlock(SaveBlockAccessor8SWSH.KSecretBoxUnlocked);
|
|
block.ChangeBooleanType((SCTypeCode)(value[0] & 1) + 1);
|
|
}
|
|
}
|
|
|
|
public override bool HasBoxWallpapers => true;
|
|
public override bool HasNamableBoxes => true;
|
|
|
|
public override int GetBoxWallpaper(int box)
|
|
{
|
|
if ((uint)box >= BoxCount)
|
|
return box;
|
|
var b = Blocks.GetBlock(SaveBlockAccessor8SWSH.KBoxWallpapers);
|
|
return b.Data[box];
|
|
}
|
|
|
|
public override void SetBoxWallpaper(int box, int value)
|
|
{
|
|
if ((uint)box >= BoxCount)
|
|
return;
|
|
var b = Blocks.GetBlock(SaveBlockAccessor8SWSH.KBoxWallpapers);
|
|
b.Data[box] = (byte)value;
|
|
}
|
|
}
|
|
}
|