Mirrors/PKHeX
2
0
Fork 0
mirror of https://github.com/kwsch/PKHeX synced 2024-11-23 12:33:06 +00:00
Code Issues Projects Releases Packages Wiki Activity
PKHeX/PKHeX.Core/Legality/LegalityAnalysis.cs

317 lines
11 KiB
C#
Raw Normal View History

Re-enable legality checking error suppression Forgot to disable it from testing, oops.
2022-02-05 17:31:36 +00:00
#define SUPPRESS
Fix gen1 VC legality checking error GetGenMovesCheckOrder doesn't respect generation restrictions, while EncounterMoves does; filter afterwards. Add compiler flags in the Analysis file to toggle try/catch off for easier debugging. Just uncomment the #define SUPPRESS line. Closes #1345
2017-07-18 23:21:31 +00:00
using System;
RelearnMove suggestion instead of copyMoves
2016-03-25 07:10:11 +00:00
using System.Collections.Generic;
Split Analysis into two separate classes Will rename in next commit
2020-11-27 20:00:49 +00:00
using static PKHeX.Core.LegalityAnalyzers;
Move species/move names to parsesettings
2020-11-28 02:45:06 +00:00
using static PKHeX.Core.LegalityCheckStrings;
Reorganization for future changes Moving legality stuff into separate class
2016-02-23 06:52:48 +00:00
Split winforms to separate project resources still are associated with winforms, eh program still runs fine and I've replicated the mono build options. lmk if this breaks stuff
2017-01-08 07:54:09 +00:00
namespace PKHeX.Core
Reorganization for future changes Moving legality stuff into separate class
2016-02-23 06:52:48 +00:00
{
add more pkhex.core xml documentation adds a bunch of documentation useful for those unfamiliar with the core library
2017-10-24 06:12:58 +00:00
/// <summary>
/// Legality Check object containing the <see cref="CheckResult"/> data and overview values from the parse.
/// </summary>
Split Analysis into two separate classes Will rename in next commit
2020-11-27 20:00:49 +00:00
public sealed class LegalityAnalysis
Reorganization for future changes Moving legality stuff into separate class
2016-02-23 06:52:48 +00:00
{
Add more xmldoc / enum clean
2021-03-14 18:28:46 +00:00
/// <summary> The entity we are checking. </summary>
Rework secondary check flow Checks.cs initially started out small, but over the years it has grown to handle multiple types of checks. With all these checks next to eachother, it's hard to see the overall groups. Splitting them up (potentially further?) allows for more focused maintenance & understanding. Not sure if I'm happy with the overall bandaids used (checks no longer done within LegalityAnalysis so variable repointing is excessively used), but I'm happier the way it is now compared to the huge Checks.cs
2018-06-24 05:00:01 +00:00
internal readonly PKM pkm;
Add more xmldoc / enum clean
2021-03-14 18:28:46 +00:00
/// <summary> The entity's <see cref="PersonalInfo"/>, which may have been sourced from the Save File it resides on. </summary>
/// <remarks>We store this rather than re-fetching, as some games that use the same <see cref="PKM"/> format have different values.</remarks>
Add xmldoc
2018-07-21 03:22:46 +00:00
internal readonly PersonalInfo PersonalInfo;
Add more xmldoc / enum clean
2021-03-14 18:28:46 +00:00
Pass parse result list to encounter info fetch ctor Old: when an encounter is found, we copied the contents of the list into our analysis list. Since we stop when we find a suitable encounter, the old list is useless. By sharing the same list, there's no consequence. Reduces allocation by ~56B each analysis object! Simplification reduces the amount of method calls by 1
2021-08-06 00:16:13 +00:00
private readonly List<CheckResult> Parse = new(8);
Refactor Legality engine Beginnings of multi-generational support; removed all references to PK6 (child) and changed to PKM (abstract parent). The core portion still needs revision to not be hard-coded for XY/ORAS info tables.
2016-10-23 19:48:49 +00:00
Expose parse results for external consumption
2019-02-15 04:14:46 +00:00
/// <summary>
/// Parse result list allowing view of the legality parse.
/// </summary>
public IReadOnlyList<CheckResult> Results => Parse;
Sword/Shield Update
2019-11-16 01:34:18 +00:00
/// <summary>
/// Only use this when trying to mutate the legality. Not for use when checking legality.
/// </summary>
public void ResetParse() => Parse.Clear();
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Matched encounter data for the <see cref="pkm"/>.
/// </summary>
Rework secondary check flow Checks.cs initially started out small, but over the years it has grown to handle multiple types of checks. With all these checks next to eachother, it's hard to see the overall groups. Splitting them up (potentially further?) allows for more focused maintenance & understanding. Not sure if I'm happy with the overall bandaids used (checks no longer done within LegalityAnalysis so variable repointing is excessively used), but I'm happier the way it is now compared to the huge Checks.cs
2018-06-24 05:00:01 +00:00
public IEncounterable EncounterMatch => Info.EncounterMatch;
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Original encounter data for the <see cref="pkm"/>.
/// </summary>
/// <remarks>
/// Generation 1/2 <see cref="pkm"/> that are transferred forward to Generation 7 are restricted to new encounter details.
/// By retaining their original match, more information can be provided by the parse.
/// </remarks>
Fix VC transfer evo chain population Move EncounterOriginal to Legal info; needed in order to pass the correct encounter to the EvoChain fetch. The EncounterOriginal 'hack' might be unnecessary with the current state of the legality checker... maybe can see if it can be removed later.
2019-12-09 23:48:54 +00:00
public IEncounterable EncounterOriginal => Info.EncounterOriginal;
Export correct species name for verbose output #1564
2017-11-07 02:06:23 +00:00
Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately (#3222) * Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately Don't store within the object, track the slot origin data separately. Batch editing now pre-filters if using Box/Slot/Identifier logic; split up mods/filters as they're starting to get pretty hefty. - Requesting a Box Data report now shows all slots in the save file (party, misc) - Can now exclude backup saves from database search via toggle (separate from settings preventing load entirely) - Replace some linq usages with direct code * Remove WasLink virtual in PKM Inline any logic, since we now have encounter objects to indicate matching, rather than the proto-legality logic checking properties of a PKM. * Use Fateful to directly check gen5 mysterygift origins No other encounter types in gen5 apply Fateful * Simplify double ball comparison Used to be separate for deferral cases, now no longer needed to be separate. * Grab move/relearn reference and update locally Fix relearn move identifier * Inline defog HM transfer preference check HasMove is faster than getting moves & checking contains. Skips allocation by setting values directly. * Extract more met location metadata checks: WasBredEgg * Replace Console.Write* with Debug.Write* There's no console output UI, so don't include them in release builds. * Inline WasGiftEgg, WasEvent, and WasEventEgg logic Adios legality tags that aren't entirely correct for the specific format. Just put the computations in EncounterFinder.
2021-06-23 03:23:48 +00:00
public readonly SlotOrigin SlotOrigin;
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Indicates if all checks ran to completion.
/// </summary>
/// <remarks>This value is false if any checks encountered an error.</remarks>
Misc updates Add global link mission stats (thanks Holla!) remove some ToArray() linq in favor of direct copies Relocate encounter suggestion logic to separate class Closes #1396, addresses other edge cases like entree-non HA & happiny egg.
2017-08-16 04:16:47 +00:00
public readonly bool Parsed;
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Indicates if all checks returned a <see cref="Severity.Valid"/> result.
/// </summary>
Misc updates Add global link mission stats (thanks Holla!) remove some ToArray() linq in favor of direct copies Relocate encounter suggestion logic to separate class Closes #1396, addresses other edge cases like entree-non HA & happiny egg.
2017-08-16 04:16:47 +00:00
public readonly bool Valid;
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Contains various data reused for multiple checks.
/// </summary>
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
public readonly LegalInfo Info;
Add xmldoc
2018-07-21 03:22:46 +00:00
add more pkhex.core xml documentation adds a bunch of documentation useful for those unfamiliar with the core library
2017-10-24 06:12:58 +00:00
/// <summary>
Misc tweaks Add more direct legality analysis constructors evo count is >= 1 fix invalid test message disallow gen2 moves if transferred from gen1 use ^1 instead of len-1 for netcore test project
2020-01-17 07:22:54 +00:00
/// Checks the input <see cref="PKM"/> data for legality. This is the best method for checking with context, as some games do not have all Alternate Form data available.
add more pkhex.core xml documentation adds a bunch of documentation useful for those unfamiliar with the core library
2017-10-24 06:12:58 +00:00
/// </summary>
/// <param name="pk">Input data to check</param>
Add savegame sensitive pkm legality checking uses the forme count of the savefile (rather than a futureproofed same-gen forme count) Closes #1559
2017-11-07 03:31:24 +00:00
/// <param name="table"><see cref="SaveFile"/> specific personal data</param>
Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately (#3222) * Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately Don't store within the object, track the slot origin data separately. Batch editing now pre-filters if using Box/Slot/Identifier logic; split up mods/filters as they're starting to get pretty hefty. - Requesting a Box Data report now shows all slots in the save file (party, misc) - Can now exclude backup saves from database search via toggle (separate from settings preventing load entirely) - Replace some linq usages with direct code * Remove WasLink virtual in PKM Inline any logic, since we now have encounter objects to indicate matching, rather than the proto-legality logic checking properties of a PKM. * Use Fateful to directly check gen5 mysterygift origins No other encounter types in gen5 apply Fateful * Simplify double ball comparison Used to be separate for deferral cases, now no longer needed to be separate. * Grab move/relearn reference and update locally Fix relearn move identifier * Inline defog HM transfer preference check HasMove is faster than getting moves & checking contains. Skips allocation by setting values directly. * Extract more met location metadata checks: WasBredEgg * Replace Console.Write* with Debug.Write* There's no console output UI, so don't include them in release builds. * Inline WasGiftEgg, WasEvent, and WasEventEgg logic Adios legality tags that aren't entirely correct for the specific format. Just put the computations in EncounterFinder.
2021-06-23 03:23:48 +00:00
/// <param name="source">Details about where the <see cref="pk"/> originated from.</param>
public LegalityAnalysis(PKM pk, PersonalTable table, SlotOrigin source = SlotOrigin.Party) : this(pk, table.GetFormEntry(pk.Species, pk.Form), source) { }
Misc tweaks Add more direct legality analysis constructors evo count is >= 1 fix invalid test message disallow gen2 moves if transferred from gen1 use ^1 instead of len-1 for netcore test project
2020-01-17 07:22:54 +00:00
/// <summary>
/// Checks the input <see cref="PKM"/> data for legality.
/// </summary>
/// <param name="pk">Input data to check</param>
Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately (#3222) * Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately Don't store within the object, track the slot origin data separately. Batch editing now pre-filters if using Box/Slot/Identifier logic; split up mods/filters as they're starting to get pretty hefty. - Requesting a Box Data report now shows all slots in the save file (party, misc) - Can now exclude backup saves from database search via toggle (separate from settings preventing load entirely) - Replace some linq usages with direct code * Remove WasLink virtual in PKM Inline any logic, since we now have encounter objects to indicate matching, rather than the proto-legality logic checking properties of a PKM. * Use Fateful to directly check gen5 mysterygift origins No other encounter types in gen5 apply Fateful * Simplify double ball comparison Used to be separate for deferral cases, now no longer needed to be separate. * Grab move/relearn reference and update locally Fix relearn move identifier * Inline defog HM transfer preference check HasMove is faster than getting moves & checking contains. Skips allocation by setting values directly. * Extract more met location metadata checks: WasBredEgg * Replace Console.Write* with Debug.Write* There's no console output UI, so don't include them in release builds. * Inline WasGiftEgg, WasEvent, and WasEventEgg logic Adios legality tags that aren't entirely correct for the specific format. Just put the computations in EncounterFinder.
2021-06-23 03:23:48 +00:00
/// <param name="source">Details about where the <see cref="pk"/> originated from.</param>
public LegalityAnalysis(PKM pk, SlotOrigin source = SlotOrigin.Party) : this(pk, pk.PersonalInfo, source) { }
Misc tweaks Add more direct legality analysis constructors evo count is >= 1 fix invalid test message disallow gen2 moves if transferred from gen1 use ^1 instead of len-1 for netcore test project
2020-01-17 07:22:54 +00:00
/// <summary>
/// Checks the input <see cref="PKM"/> data for legality.
/// </summary>
/// <param name="pk">Input data to check</param>
/// <param name="pi">Personal info to parse with</param>
Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately (#3222) * Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately Don't store within the object, track the slot origin data separately. Batch editing now pre-filters if using Box/Slot/Identifier logic; split up mods/filters as they're starting to get pretty hefty. - Requesting a Box Data report now shows all slots in the save file (party, misc) - Can now exclude backup saves from database search via toggle (separate from settings preventing load entirely) - Replace some linq usages with direct code * Remove WasLink virtual in PKM Inline any logic, since we now have encounter objects to indicate matching, rather than the proto-legality logic checking properties of a PKM. * Use Fateful to directly check gen5 mysterygift origins No other encounter types in gen5 apply Fateful * Simplify double ball comparison Used to be separate for deferral cases, now no longer needed to be separate. * Grab move/relearn reference and update locally Fix relearn move identifier * Inline defog HM transfer preference check HasMove is faster than getting moves & checking contains. Skips allocation by setting values directly. * Extract more met location metadata checks: WasBredEgg * Replace Console.Write* with Debug.Write* There's no console output UI, so don't include them in release builds. * Inline WasGiftEgg, WasEvent, and WasEventEgg logic Adios legality tags that aren't entirely correct for the specific format. Just put the computations in EncounterFinder.
2021-06-23 03:23:48 +00:00
/// <param name="source">Details about where the <see cref="pk"/> originated from.</param>
public LegalityAnalysis(PKM pk, PersonalInfo pi, SlotOrigin source = SlotOrigin.Party)
Reorganization for future changes Moving legality stuff into separate class
2016-02-23 06:52:48 +00:00
{
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
pkm = pk;
Misc tweaks Add more direct legality analysis constructors evo count is >= 1 fix invalid test message disallow gen2 moves if transferred from gen1 use ^1 instead of len-1 for netcore test project
2020-01-17 07:22:54 +00:00
PersonalInfo = pi;
Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately (#3222) * Track a PKM's Box,Slot,StorageFlags,Identifier metadata separately Don't store within the object, track the slot origin data separately. Batch editing now pre-filters if using Box/Slot/Identifier logic; split up mods/filters as they're starting to get pretty hefty. - Requesting a Box Data report now shows all slots in the save file (party, misc) - Can now exclude backup saves from database search via toggle (separate from settings preventing load entirely) - Replace some linq usages with direct code * Remove WasLink virtual in PKM Inline any logic, since we now have encounter objects to indicate matching, rather than the proto-legality logic checking properties of a PKM. * Use Fateful to directly check gen5 mysterygift origins No other encounter types in gen5 apply Fateful * Simplify double ball comparison Used to be separate for deferral cases, now no longer needed to be separate. * Grab move/relearn reference and update locally Fix relearn move identifier * Inline defog HM transfer preference check HasMove is faster than getting moves & checking contains. Skips allocation by setting values directly. * Extract more met location metadata checks: WasBredEgg * Replace Console.Write* with Debug.Write* There's no console output UI, so don't include them in release builds. * Inline WasGiftEgg, WasEvent, and WasEventEgg logic Adios legality tags that aren't entirely correct for the specific format. Just put the computations in EncounterFinder.
2021-06-23 03:23:48 +00:00
SlotOrigin = source;
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
Pass parse result list to encounter info fetch ctor Old: when an encounter is found, we copied the contents of the list into our analysis list. Since we stop when we find a suitable encounter, the old list is useless. By sharing the same list, there's no consequence. Reduces allocation by ~56B each analysis object! Simplification reduces the amount of method calls by 1
2021-08-06 00:16:13 +00:00
Info = new LegalInfo(pkm, Parse);
Fix gen1 VC legality checking error GetGenMovesCheckOrder doesn't respect generation restrictions, while EncounterMoves does; filter afterwards. Add compiler flags in the Analysis file to toggle try/catch off for easier debugging. Just uncomment the #define SUPPRESS line. Closes #1345
2017-07-18 23:21:31 +00:00
#if SUPPRESS
Error check on invalid legality Check fails -> flag instead of error.
2016-06-30 05:59:20 +00:00
try
Fix gen1 VC legality checking error GetGenMovesCheckOrder doesn't respect generation restrictions, while EncounterMoves does; filter afterwards. Add compiler flags in the Analysis file to toggle try/catch off for easier debugging. Just uncomment the #define SUPPRESS line. Closes #1345
2017-07-18 23:21:31 +00:00
#endif
Error check on invalid legality Check fails -> flag instead of error.
2016-06-30 05:59:20 +00:00
{
Minor clean
2021-02-14 18:23:53 +00:00
EncounterFinder.FindVerifiedEncounter(pkm, Info);
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
if (!pkm.IsOriginValid)
AddLine(Severity.Invalid, LEncConditionBadSpecies, CheckIdentifier.GameOrigin);
GetParseMethod()();
Misc fixes Fix volt tackle tutor for pikachu in gen6 (missing parenthesis) fix rb fishing table species list stop performing gen7 checks on pk1s add special move check (do future games have encounters with 2+ special moves)? properly handle amnesiaduck/surfchu still missing ingame trades lol
2017-02-14 06:49:32 +00:00
Performance: Slightly reduce allocations in moveset validation (#3460) * Reuses move parse result objects for each encounter parsed in a LegalityCheck attempt, instead of creating a new object. * Ensures the objects are never-null, and makes cleanup easier. Slightly adjusts some other parts of the moveset validation to reduce allocations.
2022-03-13 01:06:03 +00:00
Valid = Parse.TrueForAll(chk => chk.Valid)
&& Array.TrueForAll(Info.Moves, m => m.Valid)
&& Array.TrueForAll(Info.Relearn, m => m.Valid);
Clean up LegalityAnalysis init Add checks for out-of-range species IDs. #377
2016-11-15 00:27:15 +00:00
Pass parse result list to encounter info fetch ctor Old: when an encounter is found, we copied the contents of the list into our analysis list. Since we stop when we find a suitable encounter, the old list is useless. By sharing the same list, there's no consequence. Reduces allocation by ~56B each analysis object! Simplification reduces the amount of method calls by 1
2021-08-06 00:16:13 +00:00
if (!Valid && IsPotentiallyMysteryGift(Info, pkm))
Update legality check message string style V### names weren't enjoyable to work with; use similar verbose style as the program message strings. updating the translation files with the remapped variable names shortly remap list: https://pastebin.com/jybkVDAK
2018-09-01 21:11:12 +00:00
AddLine(Severity.Indeterminate, LFatefulGiftMissing, CheckIdentifier.Fateful);
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
Parsed = true;
Error check on invalid legality Check fails -> flag instead of error.
2016-06-30 05:59:20 +00:00
}
Fix gen1 VC legality checking error GetGenMovesCheckOrder doesn't respect generation restrictions, while EncounterMoves does; filter afterwards. Add compiler flags in the Analysis file to toggle try/catch off for easier debugging. Just uncomment the #define SUPPRESS line. Closes #1345
2017-07-18 23:21:31 +00:00
#if SUPPRESS
Refactoring Move logic closer to where it is used rather than in larger static classes EncounterStatic(7): move VC transfer template creation to class, simplify some sanity checks EvoChain: g==2 case is never hit as the generation check at the top of the loop already skips
2020-09-05 19:11:43 +00:00
// We want to swallow any error from malformed input data from the user. The Valid state is all that we really need.
Add gen4 event recognition fixes ribbon fetch, unown form comparison, and improves exception handling (no more swallowing exceptions and yielding a vague message) properly generate manaphy egg on gen4 saves will have to iron out the legality checks for nicknames at a later point in time
2017-03-24 06:15:49 +00:00
catch (Exception e)
{
Fix gen1 VC legality checking error GetGenMovesCheckOrder doesn't respect generation restrictions, while EncounterMoves does; filter afterwards. Add compiler flags in the Analysis file to toggle try/catch off for easier debugging. Just uncomment the #define SUPPRESS line. Closes #1345
2017-07-18 23:21:31 +00:00
System.Diagnostics.Debug.WriteLine(e.Message);
Add gen4 event recognition fixes ribbon fetch, unown form comparison, and improves exception handling (no more swallowing exceptions and yielding a vague message) properly generate manaphy egg on gen4 saves will have to iron out the legality checks for nicknames at a later point in time
2017-03-24 06:15:49 +00:00
Valid = false;
Add array sanitization if error was thrown
2021-06-08 02:59:08 +00:00
// Moves and Relearn arrays can potentially be empty on error.
Performance: Slightly reduce allocations in moveset validation (#3460) * Reuses move parse result objects for each encounter parsed in a LegalityCheck attempt, instead of creating a new object. * Ensures the objects are never-null, and makes cleanup easier. Slightly adjusts some other parts of the moveset validation to reduce allocations.
2022-03-13 01:06:03 +00:00
foreach (var p in Info.Moves)
{
if (!p.IsParsed)
p.Set(MoveSource.Unknown, pkm.Format, Severity.Indeterminate, L_AError, CheckIdentifier.CurrentMove);
}
foreach (var p in Info.Relearn)
{
if (!p.IsParsed)
p.Set(MoveSource.Unknown, 0, Severity.Indeterminate, L_AError, CheckIdentifier.RelearnMove);
}
Update legality check message string style V### names weren't enjoyable to work with; use similar verbose style as the program message strings. updating the translation files with the remapped variable names shortly remap list: https://pastebin.com/jybkVDAK
2018-09-01 21:11:12 +00:00
AddLine(Severity.Invalid, L_AError, CheckIdentifier.Misc);
Add gen4 event recognition fixes ribbon fetch, unown form comparison, and improves exception handling (no more swallowing exceptions and yielding a vague message) properly generate manaphy egg on gen4 saves will have to iron out the legality checks for nicknames at a later point in time
2017-03-24 06:15:49 +00:00
}
Fix gen1 VC legality checking error GetGenMovesCheckOrder doesn't respect generation restrictions, while EncounterMoves does; filter afterwards. Add compiler flags in the Analysis file to toggle try/catch off for easier debugging. Just uncomment the #define SUPPRESS line. Closes #1345
2017-07-18 23:21:31 +00:00
#endif
Refactor Legality engine Beginnings of multi-generational support; removed all references to PK6 (child) and changed to PKM (abstract parent). The core portion still needs revision to not be hard-coded for XY/ORAS info tables.
2016-10-23 19:48:49 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Pass parse result list to encounter info fetch ctor Old: when an encounter is found, we copied the contents of the list into our analysis list. Since we stop when we find a suitable encounter, the old list is useless. By sharing the same list, there's no consequence. Reduces allocation by ~56B each analysis object! Simplification reduces the amount of method calls by 1
2021-08-06 00:16:13 +00:00
private static bool IsPotentiallyMysteryGift(LegalInfo info, PKM pk)
{
if (info.EncounterOriginal is not EncounterInvalid enc)
return false;
if (enc.Generation <= 3)
return true;
if (!pk.FatefulEncounter)
return false;
if (enc.Generation < 6)
return true;
Performance: Slightly reduce allocations in moveset validation (#3460) * Reuses move parse result objects for each encounter parsed in a LegalityCheck attempt, instead of creating a new object. * Ensures the objects are never-null, and makes cleanup easier. Slightly adjusts some other parts of the moveset validation to reduce allocations.
2022-03-13 01:06:03 +00:00
if (Array.TrueForAll(info.Relearn, chk => !chk.Valid))
Pass parse result list to encounter info fetch ctor Old: when an encounter is found, we copied the contents of the list into our analysis list. Since we stop when we find a suitable encounter, the old list is useless. By sharing the same list, there's no consequence. Reduces allocation by ~56B each analysis object! Simplification reduces the amount of method calls by 1
2021-08-06 00:16:13 +00:00
return true;
return false;
}
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
private Action GetParseMethod()
Refactoring de-linq some areas where direct accessing is possible (list/array)
2017-12-05 04:16:54 +00:00
{
Misc qol updates Check max case for level first, then iterate upwards (eliminates inner if) change wc* nature to sbyte (update comparisons, 0xFF too magic-y) use Rand.Next(x) instead of (0, x)
2018-10-28 04:59:31 +00:00
if (pkm.Format <= 2) // prior to storing GameVersion
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
return ParsePK1;
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
int gen = pkm.Generation;
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
if (gen <= 0)
gen = pkm.Format;
return gen switch
Refactoring de-linq some areas where direct accessing is possible (list/array)
2017-12-05 04:16:54 +00:00
{
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
3 => ParsePK3,
4 => ParsePK4,
5 => ParsePK5,
6 => ParsePK6,
Refactoring de-linq some areas where direct accessing is possible (list/array)
2017-12-05 04:16:54 +00:00
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
1 => ParsePK7,
2 => ParsePK7,
7 => ParsePK7,
Add swsh content placeholders (#2392) placeholder content until real data is dumped
2019-09-23 23:56:47 +00:00
Remove unnecessary casts
2020-01-07 01:50:18 +00:00
8 => ParsePK8,
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
Trailing commas No functional change
2021-08-20 20:49:20 +00:00
_ => throw new Exception(),
PKHeX.Core Nullable cleanup (#2401) * Handle some nullable cases Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data) Make some classes have explicit constructors instead of { } initialization * Handle bits more obviously without null * Make SaveFile.BAK explicitly readonly again * merge constructor methods to have readonly fields * Inline some properties * More nullable handling * Rearrange box actions define straightforward classes to not have any null properties * Make extrabyte reference array immutable * Move tooltip creation to designer * Rearrange some logic to reduce nesting * Cache generated fonts * Split mystery gift album purpose * Handle more tooltips * Disallow null setters * Don't capture RNG object, only type enum * Unify learnset objects Now have readonly properties which are never null don't new() empty learnsets (>800 Learnset objects no longer created, total of 2400 objects since we also new() a move & level array) optimize g1/2 reader for early abort case * Access rewrite Initialize blocks in a separate object, and get via that object removes a couple hundred "might be null" warnings since blocks are now readonly getters some block references have been relocated, but interfaces should expose all that's needed put HoF6 controls in a groupbox, and disable * Readonly personal data * IVs non nullable for mystery gift * Explicitly initialize forced encounter moves * Make shadow objects readonly & non-null Put murkrow fix in binary data resource, instead of on startup * Assign dex form fetch on constructor Fixes legality parsing edge cases also handle cxd parse for valid; exit before exception is thrown in FrameGenerator * Remove unnecessary null checks * Keep empty value until init SetPouch sets the value to an actual one during load, but whatever * Readonly team lock data * Readonly locks Put locked encounters at bottom (favor unlocked) * Mail readonly data / offset Rearrange some call flow and pass defaults Add fake classes for SaveDataEditor mocking Always party size, no need to check twice in stat editor use a fake save file as initial data for savedata editor, and for gamedata (wow i found a usage) constrain eventwork editor to struct variable types (uint, int, etc), thus preventing null assignment errors
2019-10-17 01:47:31 +00:00
};
Refactoring de-linq some areas where direct accessing is possible (list/array)
2017-12-05 04:16:54 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
private void ParsePK1()
Initial Gen1 legality checks (WIP) Have only tested pk1 format so far; there's still a few cases that are unhandled (move discrepancies between games, trade gifts, event mew, tmhm). pls no report bugs unless you are very detailed (include WHY it is wrong).
2017-02-13 01:00:03 +00:00
{
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
Nickname.Verify(this);
Level.Verify(this);
Level.VerifyG1(this);
Rework secondary check flow Checks.cs initially started out small, but over the years it has grown to handle multiple types of checks. With all these checks next to eachother, it's hard to see the overall groups. Splitting them up (potentially further?) allows for more focused maintenance & understanding. Not sure if I'm happy with the overall bandaids used (checks no longer done within LegalityAnalysis so variable repointing is excessively used), but I'm happier the way it is now compared to the huge Checks.cs
2018-06-24 05:00:01 +00:00
Trainer.VerifyOTG1(this);
Split Analysis into two separate classes Will rename in next commit
2020-11-27 20:00:49 +00:00
MiscValues.VerifyMiscG1(this);
Check held items for pk2 eggs Closes #1993 Thanks @iiippppk !
2018-06-11 15:05:15 +00:00
if (pkm.Format == 2)
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
Item.Verify(this);
Initial Gen1 legality checks (WIP) Have only tested pk1 format so far; there's still a few cases that are unhandled (move discrepancies between games, trade gifts, event mew, tmhm). pls no report bugs unless you are very detailed (include WHY it is wrong).
2017-02-13 01:00:03 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
private void ParsePK3()
Alpha 3-5 legality checking Incorporates files from #190 Skeleton added for future implementations; currently missing gifts, encounter info, and the fine tuning that follows. Basically sets up areas for future implementation... feel free to submit pull requests filling in the EncounterStatic/EncounterTrade blocks with the basic info. I'll probably focus on gen5->4->3 in terms of priority. Encounter slots need to be marked up for encounter slot legality (yay 32bit RNG), and will be used for PIDIV detection too. XD/C is not in this round of implementation. Pretty much every pkm 3-5 will show up as invalid until this round of dev is finished.
2017-03-18 23:50:34 +00:00
{
Refactoring mostly renaming things, includes a little bit of added sugar and splitting methods to simplify the codebase. all methods are now PascalCase
2017-06-18 01:37:19 +00:00
UpdateChecks();
Refactor encounter matching exercise in deferred execution/state machine, only calculate possible matches until a sufficiently valid match is obtained. Previous setup would try to calculate the 'best match' and had band-aid workarounds in cases where a subsequent check may determine it to be a false match. There's still more ways to improve speed: - precalculate relationships for Encounter Slots rather than iterating over every area - yielding individual slots instead of an entire area - group non-egg wondercards by ID in a dict/hashtable for faster retrieval reworked some internals: - EncounterMatch is always an IEncounterable instead of an object, for easy pattern matching. - Splitbreed checking is done per encounter and is stored in the EncounterEgg result - Encounter validation uses Encounter/Move/RelearnMove/Evolution to whittle to the final encounter. As a part of the encounter matching, a lazy peek is used to check if an invalid encounter should be retained instead of discarded; if another encounter has not been checked, it'll stop the invalid checks and move on. If it is the last encounter, no other valid encounters exist so it will keep the parse for the invalid encounter. If no encounters are yielded, then there is no encountermatch. An EncounterInvalid is created to store basic details, and the parse is carried out. Breaks some legality checking features for flagging invalid moves in more detail, but those can be re-added in a separate check (if splitbreed & any move invalid -> check for other split moves). Should now be easier to follow the flow & maintain :smile:
2017-05-28 04:17:53 +00:00
if (pkm.Format > 3)
Rework secondary check flow Checks.cs initially started out small, but over the years it has grown to handle multiple types of checks. With all these checks next to eachother, it's hard to see the overall groups. Splitting them up (potentially further?) allows for more focused maintenance & understanding. Not sure if I'm happy with the overall bandaids used (checks no longer done within LegalityAnalysis so variable repointing is excessively used), but I'm happier the way it is now compared to the huge Checks.cs
2018-06-24 05:00:01 +00:00
Transfer.VerifyTransferLegalityG3(this);
Add preliminary CXD checking quite a few shadow pkm are obtainable in multiple locations, feeling like duplicating the entries with different location IDs is the way to go
2017-04-30 19:17:27 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
if (pkm.Version == (int)GameVersion.CXD)
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
CXD.Verify(this);
Fix misc problems flag undistributed gen3 events fix gen3 string writing (resized then expanded yields 00, missing terminator), closes #1204 fix stackoverflow, fix pkmeditor template loading save prompt, closes #1207
2017-06-09 03:57:30 +00:00
Merge type check with usage in if statements if x is y with z property true, then :D
2020-12-22 06:33:48 +00:00
if (Info.EncounterMatch is WC3 {NotDistributed: true})
Update legality check message string style V### names weren't enjoyable to work with; use similar verbose style as the program message strings. updating the translation files with the remapped variable names shortly remap list: https://pastebin.com/jybkVDAK
2018-09-01 21:11:12 +00:00
AddLine(Severity.Invalid, LEncUnreleased, CheckIdentifier.Encounter);
Correctly locate pk8 foreign transfer checks
2019-11-17 00:05:45 +00:00
if (pkm.Format >= 8)
Transfer.VerifyTransferLegalityG8(this);
Alpha 3-5 legality checking Incorporates files from #190 Skeleton added for future implementations; currently missing gifts, encounter info, and the fine tuning that follows. Basically sets up areas for future implementation... feel free to submit pull requests filling in the EncounterStatic/EncounterTrade blocks with the basic info. I'll probably focus on gen5->4->3 in terms of priority. Encounter slots need to be marked up for encounter slot legality (yay 32bit RNG), and will be used for PIDIV detection too. XD/C is not in this round of implementation. Pretty much every pkm 3-5 will show up as invalid until this round of dev is finished.
2017-03-18 23:50:34 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
private void ParsePK4()
Alpha 3-5 legality checking Incorporates files from #190 Skeleton added for future implementations; currently missing gifts, encounter info, and the fine tuning that follows. Basically sets up areas for future implementation... feel free to submit pull requests filling in the EncounterStatic/EncounterTrade blocks with the basic info. I'll probably focus on gen5->4->3 in terms of priority. Encounter slots need to be marked up for encounter slot legality (yay 32bit RNG), and will be used for PIDIV detection too. XD/C is not in this round of implementation. Pretty much every pkm 3-5 will show up as invalid until this round of dev is finished.
2017-03-18 23:50:34 +00:00
{
Refactoring mostly renaming things, includes a little bit of added sugar and splitting methods to simplify the codebase. all methods are now PascalCase
2017-06-18 01:37:19 +00:00
UpdateChecks();
Refactor encounter matching exercise in deferred execution/state machine, only calculate possible matches until a sufficiently valid match is obtained. Previous setup would try to calculate the 'best match' and had band-aid workarounds in cases where a subsequent check may determine it to be a false match. There's still more ways to improve speed: - precalculate relationships for Encounter Slots rather than iterating over every area - yielding individual slots instead of an entire area - group non-egg wondercards by ID in a dict/hashtable for faster retrieval reworked some internals: - EncounterMatch is always an IEncounterable instead of an object, for easy pattern matching. - Splitbreed checking is done per encounter and is stored in the EncounterEgg result - Encounter validation uses Encounter/Move/RelearnMove/Evolution to whittle to the final encounter. As a part of the encounter matching, a lazy peek is used to check if an invalid encounter should be retained instead of discarded; if another encounter has not been checked, it'll stop the invalid checks and move on. If it is the last encounter, no other valid encounters exist so it will keep the parse for the invalid encounter. If no encounters are yielded, then there is no encountermatch. An EncounterInvalid is created to store basic details, and the parse is carried out. Breaks some legality checking features for flagging invalid moves in more detail, but those can be re-added in a separate check (if splitbreed & any move invalid -> check for other split moves). Should now be easier to follow the flow & maintain :smile:
2017-05-28 04:17:53 +00:00
if (pkm.Format > 4)
Rework secondary check flow Checks.cs initially started out small, but over the years it has grown to handle multiple types of checks. With all these checks next to eachother, it's hard to see the overall groups. Splitting them up (potentially further?) allows for more focused maintenance & understanding. Not sure if I'm happy with the overall bandaids used (checks no longer done within LegalityAnalysis so variable repointing is excessively used), but I'm happier the way it is now compared to the huge Checks.cs
2018-06-24 05:00:01 +00:00
Transfer.VerifyTransferLegalityG4(this);
Correctly locate pk8 foreign transfer checks
2019-11-17 00:05:45 +00:00
if (pkm.Format >= 8)
Transfer.VerifyTransferLegalityG8(this);
Alpha 3-5 legality checking Incorporates files from #190 Skeleton added for future implementations; currently missing gifts, encounter info, and the fine tuning that follows. Basically sets up areas for future implementation... feel free to submit pull requests filling in the EncounterStatic/EncounterTrade blocks with the basic info. I'll probably focus on gen5->4->3 in terms of priority. Encounter slots need to be marked up for encounter slot legality (yay 32bit RNG), and will be used for PIDIV detection too. XD/C is not in this round of implementation. Pretty much every pkm 3-5 will show up as invalid until this round of dev is finished.
2017-03-18 23:50:34 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
private void ParsePK5()
Alpha 3-5 legality checking Incorporates files from #190 Skeleton added for future implementations; currently missing gifts, encounter info, and the fine tuning that follows. Basically sets up areas for future implementation... feel free to submit pull requests filling in the EncounterStatic/EncounterTrade blocks with the basic info. I'll probably focus on gen5->4->3 in terms of priority. Encounter slots need to be marked up for encounter slot legality (yay 32bit RNG), and will be used for PIDIV detection too. XD/C is not in this round of implementation. Pretty much every pkm 3-5 will show up as invalid until this round of dev is finished.
2017-03-18 23:50:34 +00:00
{
Refactoring mostly renaming things, includes a little bit of added sugar and splitting methods to simplify the codebase. all methods are now PascalCase
2017-06-18 01:37:19 +00:00
UpdateChecks();
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
NHarmonia.Verify(this);
Correctly locate pk8 foreign transfer checks
2019-11-17 00:05:45 +00:00
if (pkm.Format >= 8)
Transfer.VerifyTransferLegalityG8(this);
Alpha 3-5 legality checking Incorporates files from #190 Skeleton added for future implementations; currently missing gifts, encounter info, and the fine tuning that follows. Basically sets up areas for future implementation... feel free to submit pull requests filling in the EncounterStatic/EncounterTrade blocks with the basic info. I'll probably focus on gen5->4->3 in terms of priority. Encounter slots need to be marked up for encounter slot legality (yay 32bit RNG), and will be used for PIDIV detection too. XD/C is not in this round of implementation. Pretty much every pkm 3-5 will show up as invalid until this round of dev is finished.
2017-03-18 23:50:34 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
private void ParsePK6()
Refactor Legality engine Beginnings of multi-generational support; removed all references to PK6 (child) and changed to PKM (abstract parent). The core portion still needs revision to not be hard-coded for XY/ORAS info tables.
2016-10-23 19:48:49 +00:00
{
Refactoring mostly renaming things, includes a little bit of added sugar and splitting methods to simplify the codebase. all methods are now PascalCase
2017-06-18 01:37:19 +00:00
UpdateChecks();
Correctly locate pk8 foreign transfer checks
2019-11-17 00:05:45 +00:00
if (pkm.Format >= 8)
Transfer.VerifyTransferLegalityG8(this);
Refactor Legality engine Beginnings of multi-generational support; removed all references to PK6 (child) and changed to PKM (abstract parent). The core portion still needs revision to not be hard-coded for XY/ORAS info tables.
2016-10-23 19:48:49 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
private void ParsePK7()
Refactor Legality engine Beginnings of multi-generational support; removed all references to PK6 (child) and changed to PKM (abstract parent). The core portion still needs revision to not be hard-coded for XY/ORAS info tables.
2016-10-23 19:48:49 +00:00
{
Simplify vc transfer checks supply met level so the static encounter has a level to work with instead of 0 Closes #1316 in other areas: level 48 charizard VC1 transfer changed to mewtwo causes minlvl > maxlevel, handle instead of throwing exception.
2017-07-09 15:47:17 +00:00
if (pkm.VC)
UpdateVCTransferInfo();
Refactoring mostly renaming things, includes a little bit of added sugar and splitting methods to simplify the codebase. all methods are now PascalCase
2017-06-18 01:37:19 +00:00
UpdateChecks();
Correctly locate pk8 foreign transfer checks
2019-11-17 00:05:45 +00:00
if (pkm.Format >= 8)
Transfer.VerifyTransferLegalityG8(this);
Add Move checking Tweaked some inner logic to validate moves on creation of new legalityanalysis for use in display, with refresh methods.
2016-03-12 04:56:40 +00:00
}
Refactoring Tanabata Jirachi has an underleveled move (illegal), so we have to track some data. Move LegalityCheck back into LegalityAnalysis, but in a separate file still.
2016-03-14 03:19:04 +00:00
Add swsh content placeholders (#2392) placeholder content until real data is dumped
2019-09-23 23:56:47 +00:00
private void ParsePK8()
{
UpdateChecks();
Flag bred transfer mons #2416
2019-11-28 19:51:23 +00:00
Transfer.VerifyTransferLegalityG8(this);
Add swsh content placeholders (#2392) placeholder content until real data is dumped
2019-09-23 23:56:47 +00:00
}
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Adds a new Check parse value.
/// </summary>
/// <param name="s">Check severity</param>
/// <param name="c">Check comment</param>
/// <param name="i">Check type</param>
internal void AddLine(Severity s, string c, CheckIdentifier i) => AddLine(new CheckResult(s, c, i));
/// <summary>
/// Adds a new Check parse value.
/// </summary>
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
/// <param name="chk">Check result to add.</param>
Add xmldoc
2018-07-21 03:22:46 +00:00
internal void AddLine(CheckResult chk) => Parse.Add(chk);
Refactoring no functional change
2017-12-12 00:01:24 +00:00
Simplify vc transfer checks supply met level so the static encounter has a level to work with instead of 0 Closes #1316 in other areas: level 48 charizard VC1 transfer changed to mewtwo causes minlvl > maxlevel, handle instead of throwing exception.
2017-07-09 15:47:17 +00:00
private void UpdateVCTransferInfo()
{
Fix VC transfer evo chain population Move EncounterOriginal to Legal info; needed in order to pass the correct encounter to the EvoChain fetch. The EncounterOriginal 'hack' might be unnecessary with the current state of the legality checker... maybe can see if it can be removed later.
2019-12-09 23:48:54 +00:00
var enc = (Info.EncounterOriginalGB = EncounterMatch);
if (enc is EncounterInvalid)
Misc changes Revert linq chain Closes #1987 change encountermatch comparison (never null), add comparison for vc output remove unused strings (will get removed from translation files in later update)
2018-06-10 07:26:33 +00:00
return;
HOME 2.0.0: Handle conversion behavior & restrictions (#3506) * 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.
2022-05-31 04:43:52 +00:00
var vc = EncounterStaticGenerator.GetVCStaticTransferEncounter(pkm, enc, Info.EvoChainsAllGens.Gen7);
Refactoring Move logic closer to where it is used rather than in larger static classes EncounterStatic(7): move VC transfer template creation to class, simplify some sanity checks EvoChain: g==2 case is never hit as the generation check at the top of the loop already skips
2020-09-05 19:11:43 +00:00
Info.EncounterMatch = vc;
Add VC transfer checks checks were previously only performed when finding the encounter, once found, the GB encounter was validated. the transfer encounter is derived after all encounter checks, thus remaining unchecked (really, only for Locations). Move generating logic to the generator, and double check the locations are valid. #1535 Thanks @DJPanda065 !
2017-10-21 04:07:15 +00:00
Refactoring Move logic closer to where it is used rather than in larger static classes EncounterStatic(7): move VC transfer template creation to class, simplify some sanity checks EvoChain: g==2 case is never hit as the generation check at the top of the loop already skips
2020-09-05 19:11:43 +00:00
foreach (var z in Transfer.VerifyVCEncounter(pkm, enc, vc, Info.Moves))
Simplify vc transfer checks supply met level so the static encounter has a level to work with instead of 0 Closes #1316 in other areas: level 48 charizard VC1 transfer changed to mewtwo causes minlvl > maxlevel, handle instead of throwing exception.
2017-07-09 15:47:17 +00:00
AddLine(z);
Add vc transfer nature checks Closes #2279 thanks @SadisticMystic !
2019-04-04 03:13:30 +00:00
Transfer.VerifyTransferLegalityG12(this);
Simplify vc transfer checks supply met level so the static encounter has a level to work with instead of 0 Closes #1316 in other areas: level 48 charizard VC1 transfer changed to mewtwo causes minlvl > maxlevel, handle instead of throwing exception.
2017-07-09 15:47:17 +00:00
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Refactoring mostly renaming things, includes a little bit of added sugar and splitting methods to simplify the codebase. all methods are now PascalCase
2017-06-18 01:37:19 +00:00
private void UpdateChecks()
Tweak suggestion behavior Prefer lowest level wild encounter; expand suggestion for evolved pkm. Add click event to Current Level (for gen1+ pkm since Met Location not visible). Add Nickname CheckIdentifier to change incorrect identifiers in Nickname check.
2017-02-15 01:33:57 +00:00
{
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
PIDEC.Verify(this);
Nickname.Verify(this);
Split Analysis into two separate classes Will rename in next commit
2020-11-27 20:00:49 +00:00
LanguageIndex.Verify(this);
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
Trainer.Verify(this);
Split Trainer verifier into TrainerName and TrainerID verify BDSP legality restrictions Enforce nonzero TID/SID in Trainer Editor window (can use Block Data editor to set whatever without restriction, idc). #3305
2021-11-26 03:15:42 +00:00
TrainerID.Verify(this);
Extract EffortValues class, add $rand + $suggest Renames IV/EV verifier field objects for Legality Checks due to class name clashing.
2022-05-06 22:47:54 +00:00
IVs.Verify(this);
EVs.Verify(this);
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
Level.Verify(this);
Ribbon.Verify(this);
Split Analysis into two separate classes Will rename in next commit
2020-11-27 20:00:49 +00:00
AbilityValues.Verify(this);
BallIndex.Verify(this);
FormValues.Verify(this);
MiscValues.Verify(this);
GenderValues.Verify(this);
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
Item.Verify(this);
Verify Contest stats on gen5 origin extract to separate logic class; only gen3+ call this (was originally called by gen6+); only really needs to include gen5
2020-05-10 03:47:32 +00:00
Contest.Verify(this);
Minor clean
2021-01-11 02:15:33 +00:00
var format = pkm.Format;
Pass parse result list to encounter info fetch ctor Old: when an encounter is found, we copied the contents of the list into our analysis list. Since we stop when we find a suitable encounter, the old list is useless. By sharing the same list, there's no consequence. Reduces allocation by ~56B each analysis object! Simplification reduces the amount of method calls by 1
2021-08-06 00:16:13 +00:00
if (format is 4 or 5 or 6) // Gen 6->7 transfer removes this property.
Gen4GroundTile.Verify(this);
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
Minor clean
2021-01-11 02:15:33 +00:00
if (format < 6)
return;
Split Country/Region/ConsoleRegion to interface
2020-07-31 18:17:31 +00:00
Split history and memory verifiers Rewrite a bunch of the history verification stuff Fix a few test cases with incorrect OT Friendship (transferred), and missing GeoCountry Need to rewrite memory verification next (All test cases currently pass) #2545
2019-12-08 02:12:31 +00:00
History.Verify(this);
Pass parse result list to encounter info fetch ctor Old: when an encounter is found, we copied the contents of the list into our analysis list. Since we stop when we find a suitable encounter, the old list is useless. By sharing the same list, there's no consequence. Reduces allocation by ~56B each analysis object! Simplification reduces the amount of method calls by 1
2021-08-06 00:16:13 +00:00
if (format < 8) // Gen 7->8 transfer removes these properties.
ConsoleRegion.Verify(this);
Minor tweaks Check egg encounter for state rather than re-deriving some properties on the fly Only check memories if memories are exposed Remove debug assert (not always true?)
2020-08-05 05:56:55 +00:00
if (pkm is ITrainerMemories)
Memory.Verify(this);
Add memory / console region checks for pb7/pk8 yeah your initial hacks were hacks It appears there's a bug (in the game) for link trade memories -- applied to the OT memory instead of HT memory?? Fun!
2019-11-26 19:01:09 +00:00
if (pkm is ISuperTrain)
Add pkm variant for beluga
2018-11-14 03:10:31 +00:00
Medal.Verify(this);
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
Minor clean
2021-01-11 02:15:33 +00:00
if (format < 7)
Add memory / console region checks for pb7/pk8 yeah your initial hacks were hacks It appears there's a bug (in the game) for link trade memories -- applied to the OT memory instead of HT memory?? Fun!
2019-11-26 19:01:09 +00:00
return;
HyperTraining.Verify(this);
Split Analysis into two separate classes Will rename in next commit
2020-11-27 20:00:49 +00:00
MiscValues.VerifyVersionEvolution(this);
Add initial marking checks
2020-04-06 23:32:23 +00:00
Minor clean
2021-01-11 02:15:33 +00:00
if (format < 8)
Add initial marking checks
2020-04-06 23:32:23 +00:00
return;
Mark.Verify(this);
Update PKHeX.Core abstractions with latest logic Co-Authored-By: Matt <17801814+sora10pls@users.noreply.github.com> Co-Authored-By: SciresM <8676005+SciresM@users.noreply.github.com> Co-Authored-By: Lusamine <30205550+Lusamine@users.noreply.github.com>
2022-02-05 01:35:15 +00:00
Arceus.Verify(this);
Reorganization for future changes Moving legality stuff into separate class
2016-02-23 06:52:48 +00:00
}
}
}
Reference in a new issue Copy permalink