mirror of
https://github.com/kwsch/PKHeX
synced 2024-12-23 10:53:10 +00:00
5bcccc6d92
* Revises legality checks to account for traveling between the three game islands (PLA/BDSP/SWSH) * Adds conversion mechanisms between the three formats, as well as flexible conversion options to backfill missing data (thanks GameFreak/ILCA for opting for lossy conversion instead of updating the games). * Adds API abstractions for HOME data storage format (EKH/PKH format 1, aka EH1/PH1). * Revises some APIs for better usage: - `PKM` now exposes a `Context` to indicate the isolation context for legality purposes. - Some method signatures have changed to accept `Context` or `GameVersion` instead of a vague `int` for Generation. - Evolution History is now tracked in the Legality parse for specific contexts, rather than only per generation.
128 lines
4.2 KiB
C#
128 lines
4.2 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
|
|
namespace PKHeX.Core
|
|
{
|
|
/// <summary>
|
|
/// Logic object that assembles parameters used for starting up an editing environment.
|
|
/// </summary>
|
|
public sealed class StartupArguments
|
|
{
|
|
public PKM? Entity { get; private set; }
|
|
public SaveFile? SAV { get; private set; }
|
|
|
|
// ReSharper disable once UnassignedGetOnlyAutoProperty
|
|
public Exception? Error { get; }
|
|
// ReSharper disable once CollectionNeverQueried.Global
|
|
public readonly List<object> Extra = new();
|
|
|
|
/// <summary>
|
|
/// Step 1: Reads in command line arguments.
|
|
/// </summary>
|
|
public void ReadArguments(IEnumerable<string> args)
|
|
{
|
|
foreach (string path in args)
|
|
{
|
|
var other = FileUtil.GetSupportedFile(path, SAV);
|
|
if (other is SaveFile s)
|
|
{
|
|
s.Metadata.SetExtraInfo(path);
|
|
SAV = s;
|
|
}
|
|
else if (other is PKM pkm)
|
|
{
|
|
Entity = pkm;
|
|
}
|
|
else if (other is not null)
|
|
{
|
|
Extra.Add(other);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Step 2: Reads settings config.
|
|
/// </summary>
|
|
public void ReadSettings(IStartupSettings startup)
|
|
{
|
|
if (SAV is not null)
|
|
return;
|
|
|
|
if (Entity is { } x)
|
|
SAV = ReadSettingsDefinedPKM(startup, x) ?? GetBlank(x);
|
|
else
|
|
SAV = ReadSettingsAnyPKM(startup) ?? GetBlankSaveFile(startup.DefaultSaveVersion, SAV);
|
|
}
|
|
|
|
// step 3
|
|
public void ReadTemplateIfNoEntity(string path)
|
|
{
|
|
if (Entity is not null)
|
|
return;
|
|
|
|
var sav = SAV;
|
|
if (sav is null)
|
|
throw new NullReferenceException(nameof(sav));
|
|
|
|
var pk = sav.LoadTemplate(path);
|
|
var isBlank = pk.Data.SequenceEqual(sav.BlankPKM.Data);
|
|
if (isBlank)
|
|
EntityTemplates.TemplateFields(pk, sav);
|
|
|
|
Entity = pk;
|
|
}
|
|
|
|
private static SaveFile? ReadSettingsDefinedPKM(IStartupSettings startup, PKM pkm) => startup.AutoLoadSaveOnStartup switch
|
|
{
|
|
AutoLoadSetting.RecentBackup => SaveFinder.DetectSaveFiles().FirstOrDefault(z => z.IsCompatiblePKM(pkm)),
|
|
AutoLoadSetting.LastLoaded => GetMostRecentlyLoaded(startup.RecentlyLoaded).FirstOrDefault(z => z.IsCompatiblePKM(pkm)),
|
|
_ => null,
|
|
};
|
|
|
|
private static SaveFile? ReadSettingsAnyPKM(IStartupSettings startup) => startup.AutoLoadSaveOnStartup switch
|
|
{
|
|
AutoLoadSetting.RecentBackup => SaveFinder.DetectSaveFiles().FirstOrDefault(),
|
|
AutoLoadSetting.LastLoaded => GetMostRecentlyLoaded(startup.RecentlyLoaded).FirstOrDefault(),
|
|
_ => null,
|
|
};
|
|
|
|
#region Utility
|
|
private static SaveFile GetBlank(PKM pk)
|
|
{
|
|
var ctx = pk.Context;
|
|
var ver = ctx.GetSingleGameVersion();
|
|
if (pk is { Format: 1, Japanese: true })
|
|
ver = GameVersion.BU;
|
|
|
|
return SaveUtil.GetBlankSAV(ver, pk.OT_Name, (LanguageID)pk.Language);
|
|
}
|
|
|
|
private static SaveFile GetBlankSaveFile(GameVersion version, SaveFile? current)
|
|
{
|
|
var lang = SaveUtil.GetSafeLanguage(current);
|
|
var tr = SaveUtil.GetSafeTrainerName(current, lang);
|
|
var sav = SaveUtil.GetBlankSAV(version, tr, lang);
|
|
if (sav.Version == GameVersion.Invalid) // will fail to load
|
|
sav = SaveUtil.GetBlankSAV((GameVersion)GameInfo.VersionDataSource.Max(z => z.Value), tr, lang);
|
|
return sav;
|
|
}
|
|
|
|
private static IEnumerable<SaveFile> GetMostRecentlyLoaded(IEnumerable<string> paths)
|
|
{
|
|
foreach (var path in paths)
|
|
{
|
|
if (!File.Exists(path))
|
|
continue;
|
|
|
|
var sav = SaveUtil.GetVariantSAV(path);
|
|
if (sav is null)
|
|
continue;
|
|
|
|
yield return sav;
|
|
}
|
|
}
|
|
#endregion
|
|
}
|
|
}
|