/// <summary>
/// Main function that auto legalizes based on the legality
/// </summary>
/// <remarks>Leverages <see cref="Core"/>'s <see cref="EncounterMovesetGenerator"/> to create a <see cref="PKM"/> from a <see cref="IBattleTemplate"/>.</remarks>
/// <param name="dest">Destination for the generated pkm</param>
/// <param name="template">rough pkm that has all the <see cref="set"/> values entered</param>
/// <param name="set">Showdown set object</param>
/// <param name="satisfied">If the final result is legal or not</param>
public static PKM GetLegalFromTemplate(this ITrainerInfo dest, PKM template, IBattleTemplate set, out bool satisfied)
{
RegenSet regen;
if (set is RegenTemplate t)
{
t.FixGender(template.PersonalInfo);
regen = t.Regen;
}
else
{
regen = RegenSet.Default;
}
template.ApplySetDetails(set);
template.SetRecordFlags(); // Validate TR moves for the encounter
var isHidden = template.AbilityNumber == 4;
var destType = template.GetType();
var destVer = (GameVersion)dest.Game;
if (destVer <= 0 && dest is SaveFile s)
{
destVer = s.Version;
}
var gamelist = GameUtil.GetVersionsWithinRange(template, template.Format).OrderByDescending(c => c.GetGeneration()).ToArray();
if (PrioritizeGame)
{
gamelist = PrioritizeGameVersion == GameVersion.Any ? PrioritizeVersion(gamelist, destVer) : PrioritizeVersion(gamelist, PrioritizeGameVersion);
}
var encounters = EncounterMovesetGenerator.GenerateEncounters(pk: template, moves: set.Moves, gamelist);
foreach (var enc in encounters)
{
// Look before we leap -- don't waste time generating invalid / incompatible junk.
if (!IsEncounterValid(set, enc, isHidden, destVer, out var ver))
{
continue;
}
// Create the PKM from the template.
var tr = GetTrainer(regen, ver, enc.Generation);
var raw = SanityCheckEncounters(enc).ConvertToPKM(tr);
if (raw.IsEgg) // PGF events are sometimes eggs. Force hatch them before proceeding
{
raw.HandleEggEncounters(enc, tr);
}
// Bring to the target generation, then apply final details.
var pk = PKMConverter.ConvertToType(raw, destType, out _);
if (pk == null)
{
continue;
}
ApplySetDetails(pk, set, raw, dest, enc, regen);
// Apply final tweaks to the data.
if (pk is IGigantamax gmax && gmax.CanGigantamax != set.CanGigantamax)
{
if (!gmax.CanToggleGigantamax(pk.Species, enc.Species))
{
continue;
}
gmax.CanGigantamax = set.CanGigantamax; // soup hax
}
// Try applying batch editor values.
if (AllowBatchCommands && regen.HasBatchSettings)
{
pk.RefreshChecksum();
var b = regen.Batch;
if (!BatchEditing.TryModify(pk, b.Filters, b.Instructions))
{
continue;
}
}
if (pk is PK1 pk1 && ParseSettings.AllowGen1Tradeback)
{
pk1.Catch_Rate = pk1.Gen2Item; // Simulate a gen 2 trade/tradeback to allow tradeback moves
}
// Verify the Legality of what we generated, and exit if it is valid.
var la = new LegalityAnalysis(pk);
if (la.Valid)
{
satisfied = true;
return(pk);
}
Debug.WriteLine($"{la.Report()}\n");
}
satisfied = false;
return(template);
}
/// <summary>
/// Main function that auto legalizes based on the legality
/// </summary>
/// <remarks>Leverages <see cref="Core"/>'s <see cref="EncounterMovesetGenerator"/> to create a <see cref="PKM"/> from a <see cref="IBattleTemplate"/>.</remarks>
/// <param name="dest">Destination for the generated pkm</param>
/// <param name="template">rough pkm that has all the <see cref="set"/> values entered</param>
/// <param name="set">Showdown set object</param>
/// <param name="satisfied">If the final result is legal or not</param>
public static PKM GetLegalFromTemplate(this ITrainerInfo dest, PKM template, IBattleTemplate set, out LegalizationResult satisfied)
{
RegenSet regen;
if (set is RegenTemplate t)
{
t.FixGender(template.PersonalInfo);
regen = t.Regen;
}
else
{
regen = RegenSet.Default;
}
template.ApplySetDetails(set);
template.SetRecordFlags(); // Validate TR moves for the encounter
var isHidden = template.AbilityNumber == 4;
if (template.PersonalInfo.Abilities.Count > 2) // Hidden ability exists for the template
{
isHidden = isHidden || template.PersonalInfo.Abilities[2] == template.Ability;
}
var destType = template.GetType();
var destVer = (GameVersion)dest.Game;
if (destVer <= 0 && dest is SaveFile s)
{
destVer = s.Version;
}
var timer = Stopwatch.StartNew();
var gamelist = FilteredGameList(template, destVer);
var encounters = EncounterMovesetGenerator.GenerateEncounters(pk: template, moves: set.Moves, gamelist);
var criteria = EncounterCriteria.GetCriteria(set);
foreach (var enc in encounters)
{
// Return out if set times out
if (timer.Elapsed.TotalSeconds >= Timeout)
{
timer.Stop();
satisfied = LegalizationResult.Timeout;
return(template);
}
// Look before we leap -- don't waste time generating invalid / incompatible junk.
if (!IsEncounterValid(set, enc, isHidden, destVer))
{
continue;
}
// Create the PKM from the template.
var tr = GetTrainer(regen, enc.Version, enc.Generation);
var raw = enc.ConvertToPKM(tr, criteria);
raw = raw.SanityCheckLocation(enc);
if (raw.IsEgg) // PGF events are sometimes eggs. Force hatch them before proceeding
{
raw.HandleEggEncounters(enc, tr);
}
raw.PreSetPIDIV(enc, set);
// Transfer any VC1 via VC2, as there may be GSC exclusive moves requested.
if (dest.Generation >= 7 && raw is PK1 basepk1)
{
raw = basepk1.ConvertToPK2();
}
// Bring to the target generation, then apply final details.
var pk = PKMConverter.ConvertToType(raw, destType, out _);
if (pk == null)
{
continue;
}
ApplySetDetails(pk, set, raw, dest, enc, regen);
// Apply final tweaks to the data.
if (pk is IGigantamax gmax && gmax.CanGigantamax != set.CanGigantamax)
{
if (!gmax.CanToggleGigantamax(pk.Species, pk.Form, enc.Species, enc.Form))
{
continue;
}
gmax.CanGigantamax = set.CanGigantamax; // soup hax
}
// Try applying batch editor values.
if (AllowBatchCommands && regen.HasBatchSettings)
{
pk.RefreshChecksum();
var b = regen.Batch;
if (!BatchEditing.TryModify(pk, b.Filters, b.Instructions))
{
continue;
}
}
if (pk is PK1 pk1 && ParseSettings.AllowGen1Tradeback)
{
pk1.Catch_Rate = pk1.Gen2Item; // Simulate a gen 2 trade/tradeback to allow tradeback moves
}
// Verify the Legality of what we generated, and exit if it is valid.
var la = new LegalityAnalysis(pk);
if (la.Valid)
{
satisfied = LegalizationResult.Regenerated;
return(pk);
}
Debug.WriteLine($"{la.Report()}\n");
}
satisfied = LegalizationResult.Failed;
return(template);
}
