mirror of
https://github.com/kwsch/PKHeX.git
synced 2026-05-20 12:48:30 -05: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.
249 lines
7.6 KiB
C#
249 lines
7.6 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using static System.Buffers.Binary.BinaryPrimitives;
|
|
|
|
namespace PKHeX.Core
|
|
{
|
|
public sealed class Record3
|
|
{
|
|
private readonly SAV3 SAV;
|
|
|
|
public uint GetRecord(int record) => ReadUInt32LittleEndian(SAV.Large.AsSpan(GetRecordOffset(record))) ^ SAV.SecurityKey;
|
|
public void SetRecord(int record, uint value) => WriteUInt32LittleEndian(SAV.Large.AsSpan(GetRecordOffset(record)), value ^ SAV.SecurityKey);
|
|
|
|
private int GetRecordOffset(int record)
|
|
{
|
|
var baseOffset = GetOffset(SAV.Version);
|
|
var offset = baseOffset + (4 * record);
|
|
return offset;
|
|
}
|
|
|
|
public Record3(SAV3 sav) => SAV = sav;
|
|
|
|
public static int GetOffset(GameVersion ver) => ver switch
|
|
{
|
|
GameVersion.RS or GameVersion.R or GameVersion.S => 0x1540,
|
|
GameVersion.E => 0x159C,
|
|
GameVersion.FRLG or GameVersion.FR or GameVersion.LG => 0x1200,
|
|
_ => throw new ArgumentException(nameof(ver)),
|
|
};
|
|
|
|
private static Type GetEnumType(GameVersion ver) => ver switch
|
|
{
|
|
GameVersion.RS or GameVersion.R or GameVersion.S => typeof(RecID3RuSa),
|
|
GameVersion.FRLG or GameVersion.FR or GameVersion.LG => typeof(RecID3FRLG),
|
|
GameVersion.E => typeof(RecID3Emerald),
|
|
_ => throw new ArgumentException(nameof(ver)),
|
|
};
|
|
|
|
public static int[] GetEnumValues(GameVersion ver) => (int[])Enum.GetValues(GetEnumType(ver));
|
|
public static string[] GetEnumNames(GameVersion ver) => Enum.GetNames(GetEnumType(ver));
|
|
|
|
public static IList<ComboItem> GetItems(SAV3 sav)
|
|
{
|
|
var ver = sav.Version;
|
|
var names = GetEnumNames(ver);
|
|
var values = GetEnumValues(ver);
|
|
|
|
var result = new ComboItem[values.Length];
|
|
for (int i = 0; i < result.Length; i++)
|
|
{
|
|
var replaced = names[i].Replace('_', ' ');
|
|
var titled = Util.ToTitleCase(replaced);
|
|
result[i] = new ComboItem(titled, values[i]);
|
|
}
|
|
return result;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Record IDs for <see cref="GameVersion.R"/> and <see cref="GameVersion.S"/>
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// https://github.com/pret/pokeruby/blob/f839afb24aa2c7b70e9c28a5c069aacc46993099/include/constants/game_stat.h
|
|
/// </remarks>
|
|
public enum RecID3RuSa
|
|
{
|
|
SAVED_GAME = 0,
|
|
FIRST_HOF_PLAY_TIME = 1,
|
|
STARTED_TRENDS = 2,
|
|
PLANTED_BERRIES = 3,
|
|
TRADED_BIKES = 4,
|
|
STEPS = 5,
|
|
GOT_INTERVIEWED = 6,
|
|
TOTAL_BATTLES = 7,
|
|
WILD_BATTLES = 8,
|
|
TRAINER_BATTLES = 9,
|
|
ENTERED_HOF = 10,
|
|
POKEMON_CAPTURES = 11,
|
|
FISHING_CAPTURES = 12,
|
|
HATCHED_EGGS = 13,
|
|
EVOLVED_POKEMON = 14,
|
|
USED_POKECENTER = 15,
|
|
RESTED_AT_HOME = 16,
|
|
ENTERED_SAFARI_ZONE = 17,
|
|
USED_CUT = 18,
|
|
USED_ROCK_SMASH = 19,
|
|
MOVED_SECRET_BASE = 20,
|
|
POKEMON_TRADES = 21,
|
|
UNKNOWN_22 = 22,
|
|
LINK_BATTLE_WINS = 23,
|
|
LINK_BATTLE_LOSSES = 24,
|
|
LINK_BATTLE_DRAWS = 25,
|
|
USED_SPLASH = 26,
|
|
USED_STRUGGLE = 27,
|
|
SLOT_JACKPOTS = 28,
|
|
CONSECUTIVE_ROULETTE_WINS = 29,
|
|
ENTERED_BATTLE_TOWER = 30,
|
|
UNKNOWN_31 = 31,
|
|
BATTLE_TOWER_BEST_STREAK = 32,
|
|
POKEBLOCKS = 33,
|
|
POKEBLOCKS_WITH_FRIENDS = 34,
|
|
WON_LINK_CONTEST = 35,
|
|
ENTERED_CONTEST = 36,
|
|
WON_CONTEST = 37,
|
|
SHOPPED = 38,
|
|
USED_ITEMFINDER = 39,
|
|
GOT_RAINED_ON = 40,
|
|
CHECKED_POKEDEX = 41,
|
|
RECEIVED_RIBBONS = 42,
|
|
JUMPED_DOWN_LEDGES = 43,
|
|
WATCHED_TV = 44,
|
|
CHECKED_CLOCK = 45,
|
|
WON_POKEMON_LOTTERY = 46,
|
|
USED_DAYCARE = 47,
|
|
RODE_CABLE_CAR = 48,
|
|
ENTERED_HOT_SPRINGS = 49,
|
|
// NUM_GAME_STATS = 50
|
|
}
|
|
|
|
/// <summary>
|
|
/// Record IDs for <see cref="GameVersion.E"/>
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// https://github.com/pret/pokeemerald/blob/3a40f5203baafb29f94dda8abdce6489d81635ae/include/constants/game_stat.h
|
|
/// </remarks>
|
|
public enum RecID3Emerald
|
|
{
|
|
SAVED_GAME = 0,
|
|
FIRST_HOF_PLAY_TIME = 1,
|
|
STARTED_TRENDS = 2,
|
|
PLANTED_BERRIES = 3,
|
|
TRADED_BIKES = 4,
|
|
STEPS = 5,
|
|
GOT_INTERVIEWED = 6,
|
|
TOTAL_BATTLES = 7,
|
|
WILD_BATTLES = 8,
|
|
TRAINER_BATTLES = 9,
|
|
ENTERED_HOF = 10,
|
|
POKEMON_CAPTURES = 11,
|
|
FISHING_CAPTURES = 12,
|
|
HATCHED_EGGS = 13,
|
|
EVOLVED_POKEMON = 14,
|
|
USED_POKECENTER = 15,
|
|
RESTED_AT_HOME = 16,
|
|
ENTERED_SAFARI_ZONE = 17,
|
|
USED_CUT = 18,
|
|
USED_ROCK_SMASH = 19,
|
|
MOVED_SECRET_BASE = 20,
|
|
POKEMON_TRADES = 21,
|
|
UNKNOWN_22 = 22,
|
|
LINK_BATTLE_WINS = 23,
|
|
LINK_BATTLE_LOSSES = 24,
|
|
LINK_BATTLE_DRAWS = 25,
|
|
USED_SPLASH = 26,
|
|
USED_STRUGGLE = 27,
|
|
SLOT_JACKPOTS = 28,
|
|
CONSECUTIVE_ROULETTE_WINS = 29,
|
|
ENTERED_BATTLE_TOWER = 30,
|
|
UNKNOWN_31 = 31,
|
|
BATTLE_TOWER_BEST_STREAK = 32,
|
|
POKEBLOCKS = 33,
|
|
POKEBLOCKS_WITH_FRIENDS = 34,
|
|
WON_LINK_CONTEST = 35,
|
|
ENTERED_CONTEST = 36,
|
|
WON_CONTEST = 37,
|
|
SHOPPED = 38,
|
|
USED_ITEMFINDER = 39,
|
|
GOT_RAINED_ON = 40,
|
|
CHECKED_POKEDEX = 41,
|
|
RECEIVED_RIBBONS = 42,
|
|
JUMPED_DOWN_LEDGES = 43,
|
|
WATCHED_TV = 44,
|
|
CHECKED_CLOCK = 45,
|
|
WON_POKEMON_LOTTERY = 46,
|
|
USED_DAYCARE = 47,
|
|
RODE_CABLE_CAR = 48,
|
|
ENTERED_HOT_SPRINGS = 49,
|
|
UNION_WITH_FRIENDS = 50,
|
|
BERRY_CRUSH_WITH_FRIENDS = 51,
|
|
|
|
// NUM_USED_GAME_STATS = 52,
|
|
// NUM_GAME_STATS = 64
|
|
}
|
|
|
|
/// <summary>
|
|
/// Record IDs for <see cref="GameVersion.FR"/> and <see cref="GameVersion.LG"/>
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// https://github.com/pret/pokefirered/blob/8367b0015fbf99070cc5a5244d8213420419d2c8/include/constants/game_stat.h
|
|
/// </remarks>
|
|
public enum RecID3FRLG
|
|
{
|
|
SAVED_GAME = 0,
|
|
FIRST_HOF_PLAY_TIME = 1,
|
|
STARTED_TRENDS = 2,
|
|
PLANTED_BERRIES = 3,
|
|
TRADED_BIKES = 4,
|
|
STEPS = 5,
|
|
GOT_INTERVIEWED = 6,
|
|
TOTAL_BATTLES = 7,
|
|
WILD_BATTLES = 8,
|
|
TRAINER_BATTLES = 9,
|
|
ENTERED_HOF = 10,
|
|
POKEMON_CAPTURES = 11,
|
|
FISHING_CAPTURES = 12,
|
|
HATCHED_EGGS = 13,
|
|
EVOLVED_POKEMON = 14,
|
|
USED_POKECENTER = 15,
|
|
RESTED_AT_HOME = 16,
|
|
ENTERED_SAFARI_ZONE = 17,
|
|
USED_CUT = 18,
|
|
USED_ROCK_SMASH = 19,
|
|
MOVED_SECRET_BASE = 20,
|
|
POKEMON_TRADES = 21,
|
|
UNKNOWN_22 = 22,
|
|
LINK_BATTLE_WINS = 23,
|
|
LINK_BATTLE_LOSSES = 24,
|
|
LINK_BATTLE_DRAWS = 25,
|
|
USED_SPLASH = 26,
|
|
USED_STRUGGLE = 27,
|
|
SLOT_JACKPOTS = 28,
|
|
CONSECUTIVE_ROULETTE_WINS = 29,
|
|
ENTERED_BATTLE_TOWER = 30,
|
|
UNKNOWN_31 = 31,
|
|
BATTLE_TOWER_BEST_STREAK = 32,
|
|
POKEBLOCKS = 33,
|
|
POKEBLOCKS_WITH_FRIENDS = 34,
|
|
WON_LINK_CONTEST = 35,
|
|
ENTERED_CONTEST = 36,
|
|
WON_CONTEST = 37,
|
|
SHOPPED = 38,
|
|
USED_ITEMFINDER = 39,
|
|
GOT_RAINED_ON = 40,
|
|
CHECKED_POKEDEX = 41,
|
|
RECEIVED_RIBBONS = 42,
|
|
JUMPED_DOWN_LEDGES = 43,
|
|
WATCHED_TV = 44,
|
|
CHECKED_CLOCK = 45,
|
|
WON_POKEMON_LOTTERY = 46,
|
|
USED_DAYCARE = 47,
|
|
RODE_CABLE_CAR = 48,
|
|
ENTERED_HOT_SPRINGS = 49,
|
|
UNION_WITH_FRIENDS = 50,
|
|
BERRY_CRUSH_WITH_FRIENDS = 51,
|
|
|
|
// NUM_GAME_STATS = 64,
|
|
}
|
|
}
|