Mirrors/PKHeX
2
0
Fork 0
mirror of https://github.com/kwsch/PKHeX synced 2024-11-15 08:47:14 +00:00
Code Issues Projects Releases Packages Wiki Activity
PKHeX/PKHeX.Core/Legality/Analysis.cs

482 lines
17 KiB
C#
Raw Normal View History

re-enable error suppression oops
2017-11-09 06:59:18 +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;
Refactor, Check WC6 evos, Check WC6 egg Moved the wc6 fetch logic, added event egg; added a little linq finesse and things are clean! Added features and cleaned with 0 net lines :+1:
2016-03-05 04:43:00 +00:00
using System.Linq;
Refactored implementation of #959
2017-03-24 17:59:45 +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>
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
public partial class LegalityAnalysis
Reorganization for future changes Moving legality stuff into separate class
2016-02-23 06:52:48 +00:00
{
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 xmldoc
2018-07-21 03:22:46 +00:00
internal readonly PersonalInfo PersonalInfo;
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
private readonly List<CheckResult> Parse = new List<CheckResult>();
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();
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 IEncounterable? EncounterOriginalGB;
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>
Add nickname reset modify nickname reset clears except for encountertrades (some have fixed nicknames). remove untraded check for HT memory verification, has to be traded if it has a HT memory.
2018-06-01 02:49:47 +00:00
public IEncounterable EncounterOriginal => EncounterOriginalGB ?? EncounterMatch;
Export correct species name for verbose output #1564
2017-11-07 02:06:23 +00:00
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
/// <summary>
/// Creates a report message with optional verbosity for in-depth analysis.
/// </summary>
/// <param name="verbose">Include all details in the parse, including valid check messages.</param>
/// <returns>Single line string</returns>
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
public string Report(bool verbose = false) => verbose ? GetVerboseLegalityReport() : GetLegalityReport();
Add xmldoc
2018-07-21 03:22:46 +00:00
Refactoring r2 Don't calculate suggested moves until prompted Don't check EncounterType for gen7 pkm (no field to check)
2017-04-23 04:00:06 +00:00
private IEnumerable<int> AllSuggestedMoves
{
get
{
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
if (!Parsed)
Refactoring r2 Don't calculate suggested moves until prompted Don't check EncounterType for gen7 pkm (no field to check)
2017-04-23 04:00:06 +00:00
return new int[4];
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
return _allSuggestedMoves ??= GetSuggestedMoves(true, true, true);
Refactoring r2 Don't calculate suggested moves until prompted Don't check EncounterType for gen7 pkm (no field to check)
2017-04-23 04:00:06 +00:00
}
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Refactoring r2 Don't calculate suggested moves until prompted Don't check EncounterType for gen7 pkm (no field to check)
2017-04-23 04:00:06 +00:00
private IEnumerable<int> AllSuggestedRelearnMoves
{
get
{
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
if (!Parsed)
Refactoring r2 Don't calculate suggested moves until prompted Don't check EncounterType for gen7 pkm (no field to check)
2017-04-23 04:00:06 +00:00
return new int[4];
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
return _allSuggestedRelearnMoves ??= Legal.GetValidRelearn(pkm, Info.EncounterMatch.Species, Info.EncounterMatch.Form, (GameVersion)pkm.Version).ToArray();
Refactoring r2 Don't calculate suggested moves until prompted Don't check EncounterType for gen7 pkm (no field to check)
2017-04-23 04:00:06 +00:00
}
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +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
private int[]? _allSuggestedMoves, _allSuggestedRelearnMoves;
Cleanup handle messages for dirty cleaning :)
2019-10-26 19:33:58 +00:00
public int[] AllSuggestedMovesAndRelearn() => AllSuggestedMoves.Concat(AllSuggestedRelearnMoves).ToArray();
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
Export correct species name for verbose output #1564
2017-11-07 02:06:23 +00:00
private string EncounterName
{
get
{
Add nickname reset modify nickname reset clears except for encountertrades (some have fixed nicknames). remove untraded check for HT memory verification, has to be traded if it has a HT memory.
2018-06-01 02:49:47 +00:00
var enc = EncounterOriginal;
Export correct species name for verbose output #1564
2017-11-07 02:06:23 +00:00
return $"{enc.GetEncounterTypeName()} ({SpeciesStrings[enc.Species]})";
}
}
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +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
private string? EncounterLocation
add location interface for verbose analysis output indicates met location for transferred mons most gen1/2 encounters won't show values due to the location not being stored respective to the string tables (anyone wanna do a location remap after initial load?)
2018-01-02 20:00:41 +00:00
{
get
{
Add nickname reset modify nickname reset clears except for encountertrades (some have fixed nicknames). remove untraded check for HT memory verification, has to be traded if it has a HT memory.
2018-06-01 02:49:47 +00:00
var enc = EncounterOriginal as ILocation;
Use CXD met location string on verbose output was previously using RSEFRLG locations for CXD encounters
2018-01-31 04:24:45 +00:00
return enc?.GetEncounterLocation(Info.Generation, pkm.Version);
add location interface for verbose analysis output indicates met location for transferred mons most gen1/2 encounters won't show values due to the location not being stored respective to the string tables (anyone wanna do a location remap after initial load?)
2018-01-02 20:00:41 +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 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>
/// Checks the input <see cref="PKM"/> data for legality.
/// </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>
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 LegalityAnalysis(PKM pk, PersonalTable? table = null)
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;
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
PersonalInfo = table?.GetFormeEntry(pkm.Species, pkm.AltForm) ?? pkm.PersonalInfo;
if (pkm.Format <= 2) // prior to storing GameVersion
pkm.TradebackStatus = GBRestrictions.GetTradebackStatusInitial(pkm);
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
{
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
Info = EncounterFinder.FindVerifiedEncounter(pkm);
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
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
if (Parse.Count == 0) // shouldn't ever happen as at least one is yielded above.
{
AddLine(Severity.Invalid, L_AError, CheckIdentifier.Misc);
Refactoring de-linq some areas where direct accessing is possible (list/array)
2017-12-05 04:16:54 +00:00
return;
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
}
Tweak gen1+transfer checking Add stadium exclusives (surfchu / amnesiaduck) which are flagged on gen7
2017-02-14 02:06:01 +00:00
Remove trailing whitespace
2018-05-12 15:13:39 +00:00
Valid = Parse.All(chk => chk.Valid)
&& Info.Moves.All(m => m.Valid)
Refactoring de-linq some areas where direct accessing is possible (list/array)
2017-12-05 04:16:54 +00:00
&& Info.Relearn.All(m => m.Valid);
Clean up LegalityAnalysis init Add checks for out-of-range species IDs. #377
2016-11-15 00:27:15 +00:00
Minor updates increase readability, simplifly some expressions relocate hot path for legality report string creation
2019-05-11 17:12:14 +00:00
if (!Valid && pkm.FatefulEncounter && Info.Relearn.Any(chk => !chk.Valid) && EncounterMatch is EncounterInvalid)
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
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);
Merge Error flag into Parsed Simplify some logic with ??=
2019-11-26 02:32:50 +00:00
Info = new LegalInfo(pkm);
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;
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
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;
int gen = pkm.GenNumber;
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
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
8 => (Action)ParsePK8,
_ => throw new Exception()
};
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
{
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
UpdateInfo();
Update catch rate related logic #2071
2018-07-25 02:33:42 +00:00
if (pkm.TradebackStatus == TradebackType.Any && Info.Generation != pkm.Format)
pkm.TradebackStatus = TradebackType.WasTradeback; // Example: GSC Pokemon with only possible encounters in RBY, like the legendary birds
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);
Misc.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
UpdateInfo();
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
Misc updates fields->properties, capitalize fix pkm fields toggle referencing old pkm file, simplify that process instead of constantly referencing Format
2017-06-21 00:57:23 +00:00
if (Info.EncounterMatch is WC3 z && z.NotDistributed)
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
UpdateInfo();
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
UpdateInfo();
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
UpdateInfo();
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
{
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
UpdateInfo();
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()
{
UpdateInfo();
UpdateChecks();
}
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()
{
EncounterOriginalGB = EncounterMatch;
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
if (EncounterOriginalGB is EncounterInvalid)
return;
Split up IEncounterable generators Can break the filtering out into smaller methods such that the generator can return results with less strict filtering
2018-03-11 03:51:09 +00:00
Info.EncounterMatch = EncounterStaticGenerator.GetVCStaticTransferEncounter(pkm);
if (!(Info.EncounterMatch is EncounterStatic s) || !EncounterStaticGenerator.IsVCStaticTransferEncounterValid(pkm, s))
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, LEncInvalid, CheckIdentifier.Encounter); return; }
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 Simplify some verifier logic
2018-06-30 22:01:16 +00:00
foreach (var z in Transfer.VerifyVCEncounter(pkm, EncounterOriginalGB, s, 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 UpdateInfo()
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
{
Misc updates fields->properties, capitalize fix pkm fields toggle referencing old pkm file, simplify that process instead of constantly referencing Format
2017-06-21 00:57:23 +00:00
Parse.AddRange(Info.Parse);
Refactoring Move fossils check to static encounter apply small amount of inheritance to all encounter types (including mystery gifts) get actual evolution chain to ignore pre-evolution movepools (example Surf Pikachu event gift cannot devolve to Pichu to get Nasty Plot). #694 A little bit of logic has been moved around, but my 5k pkmdb had no change in legal/illegal counts. Hopefully no false positives from this change :thumbsup:
2017-01-04 04:51:33 +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);
Language.Verify(this);
Trainer.Verify(this);
IndividualValues.Verify(this);
EffortValues.Verify(this);
Level.Verify(this);
Ribbon.Verify(this);
Ability.Verify(this);
Ball.Verify(this);
Form.Verify(this);
Misc.Verify(this);
Gender.Verify(this);
Item.Verify(this);
Refactoring no functional change
2017-12-12 00:01:24 +00:00
if (pkm.Format <= 6 && pkm.Format >= 4)
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
EncounterType.Verify(this); // Gen 6->7 transfer deletes encounter type data
if (pkm.Format < 6)
return;
Add pkm variant for beluga
2018-11-14 03:10:31 +00:00
if (pkm.Format < 8 && !(pkm is PB7))
{
Memory.Verify(this);
Medal.Verify(this);
ConsoleRegion.Verify(this);
}
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
if (pkm.Format >= 7)
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
{
Misc simplifications absorb verifier calls into the parsing methods
2018-07-02 00:07:29 +00:00
HyperTraining.Verify(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
Misc.VerifyVersionEvolution(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
}
Reorganization for future changes Moving legality stuff into separate class
2016-02-23 06:52:48 +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 string GetLegalityReport()
Add legality text exporting WIP -- no text is returned from the called method. Fixes the Control Click preview box not exporting ek6 (was right click previously).
2016-03-09 03:20:26 +00:00
{
Minor updates increase readability, simplifly some expressions relocate hot path for legality report string creation
2019-05-11 17:12:14 +00:00
if (Valid)
return L_ALegal;
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
if (!Parsed || Info == null)
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
return L_AnalysisUnavailable;
Remove trailing whitespace
2018-05-12 15:13:39 +00:00
Slight refactoring use a list to collect legality report instead of building a string remove unnecessary null check (already checked prior)
2017-04-29 22:45:21 +00:00
var lines = new List<string>();
Misc updates fields->properties, capitalize fix pkm fields toggle referencing old pkm file, simplify that process instead of constantly referencing Format
2017-06-21 00:57:23 +00:00
var vMoves = Info.Moves;
var vRelearn = Info.Relearn;
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
for (int i = 0; i < 4; i++)
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
{
Move Legality check rewrite Moved to checks Returns why it's invalid Added base egg move checks -- all eggs need level1 moves, can only be pushed out. The move table acts as a sliding window; grab a list of level1 moves, tack on relearn moves, then observe window view (last 4). Added egg met level check
2016-03-12 17:16:41 +00:00
if (!vMoves[i].Valid)
Minor updates increase readability, simplifly some expressions relocate hot path for legality report string creation
2019-05-11 17:12:14 +00:00
lines.Add(vMoves[i].Format(L_F0_M_1_2, i + 1));
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
}
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
if (pkm.Format >= 6)
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
{
for (int i = 0; i < 4; i++)
{
if (!vRelearn[i].Valid)
Minor updates increase readability, simplifly some expressions relocate hot path for legality report string creation
2019-05-11 17:12:14 +00:00
lines.Add(vRelearn[i].Format(L_F0_RM_1_2, i + 1));
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
}
}
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
Legality ContextMenu now returns analysis Hooked up all the methods and can spit out if invalid. I plan to put a legality indication where QR! was, but the legality analysis needs more checks (moves, ability, nickname, ball, fateful... you get it) and stability. Have fun playing with the initial legality checks :smile:
2016-03-12 03:43:40 +00:00
// Build result string...
Minor updates increase readability, simplifly some expressions relocate hot path for legality report string creation
2019-05-11 17:12:14 +00:00
var outputLines = Parse.Where(chk => !chk.Valid);
lines.AddRange(outputLines.Select(chk => chk.Format(L_F0_1)));
Preliminary Sun/Moon support Still a few things like missing forms and unobtainable moves. Will work more on this later.
2016-11-08 16:43:57 +00:00
Slight refactoring use a list to collect legality report instead of building a string remove unnecessary null check (already checked prior)
2017-04-29 22:45:21 +00:00
return string.Join(Environment.NewLine, lines);
Add verbose export Partial commit error fixed
2016-04-04 00:11:58 +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 string GetVerboseLegalityReport()
Add verbose export Partial commit error fixed
2016-04-04 00:11:58 +00:00
{
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
if (!Parsed || Info == null)
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
return L_AnalysisUnavailable;
Slight refactoring use a list to collect legality report instead of building a string remove unnecessary null check (already checked prior)
2017-04-29 22:45:21 +00:00
const string separator = "===";
"" -> string.Empty be explicit that the string is empty rather than possibly missing disallow encrypted export for BK4 (they're not encrypted), removes type check simplify replaceall in showdownset (don't call ReplaceAll 4x, just get valid chars and rebuild) simplify get ribbon sprite name (precompute ToLower and appended values
2019-02-08 05:40:20 +00:00
string[] br = {separator, string.Empty};
Slight refactoring use a list to collect legality report instead of building a string remove unnecessary null check (already checked prior)
2017-04-29 22:45:21 +00:00
var lines = new List<string> {br[1]};
lines.AddRange(br);
int rl = lines.Count;
Add move source indication to verbose output Indicates the Valid legality of moves (level up, relearn pool, etc).
2016-04-16 18:36:01 +00:00
Misc updates fields->properties, capitalize fix pkm fields toggle referencing old pkm file, simplify that process instead of constantly referencing Format
2017-06-21 00:57:23 +00:00
var vMoves = Info.Moves;
var vRelearn = Info.Relearn;
Add move source indication to verbose output Indicates the Valid legality of moves (level up, relearn pool, etc).
2016-04-16 18:36:01 +00:00
for (int i = 0; i < 4; i++)
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
{
Spit out move learn generation on verbose helps indicate any restrictions on learn source outside of the current format
2018-09-30 18:50:08 +00:00
var move = vMoves[i];
if (!move.Valid)
continue;
Minor updates increase readability, simplifly some expressions relocate hot path for legality report string creation
2019-05-11 17:12:14 +00:00
var msg = move.Format(L_F0_M_1_2, i + 1);
Spit out move learn generation on verbose helps indicate any restrictions on learn source outside of the current format
2018-09-30 18:50:08 +00:00
if (pkm.Format != move.Generation)
msg += $" [Gen{move.Generation}]";
lines.Add(msg);
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
}
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
if (pkm.Format >= 6)
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
{
for (int i = 0; i < 4; i++)
{
if (vRelearn[i].Valid)
Minor clean Magic number -> const usage default(T) -> default (c#7.x feature) remove some unused stuff fix indentation in some spots
2019-09-11 05:07:50 +00:00
lines.Add(vRelearn[i].Format(L_F0_RM_1_2, i + 1));
Respacening Style guidelines, handle a bunch of files no functional change
2018-07-27 02:34:27 +00:00
}
}
Add move source indication to verbose output Indicates the Valid legality of moves (level up, relearn pool, etc).
2016-04-16 18:36:01 +00:00
Slight refactoring use a list to collect legality report instead of building a string remove unnecessary null check (already checked prior)
2017-04-29 22:45:21 +00:00
if (rl != lines.Count) // move info added, break for next section
lines.Add(br[1]);
Remove trailing whitespace
2018-05-12 15:13:39 +00:00
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
var outputLines = Parse.Where(chk => chk?.Valid == true && chk.Comment != L_AValid).OrderBy(chk => chk.Judgement); // Fishy sorted to top
Minor updates increase readability, simplifly some expressions relocate hot path for legality report string creation
2019-05-11 17:12:14 +00:00
lines.AddRange(outputLines.Select(chk => chk.Format(L_F0_1)));
Update verbose legality text output Now indicates the encounter type, misc text tweaks
2016-12-31 01:13:22 +00:00
Slight refactoring use a list to collect legality report instead of building a string remove unnecessary null check (already checked prior)
2017-04-29 22:45:21 +00:00
lines.AddRange(br);
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
lines.Add(string.Format(L_FEncounterType_0, EncounterName));
add location interface for verbose analysis output indicates met location for transferred mons most gen1/2 encounters won't show values due to the location not being stored respective to the string tables (anyone wanna do a location remap after initial load?)
2018-01-02 20:00:41 +00:00
var loc = EncounterLocation;
if (!string.IsNullOrEmpty(loc))
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
lines.Add(string.Format(L_F0_1, "Location", loc));
Add preliminary VC2 legality checking Surprisingly easy to toggle on If VC, provide possible version the encounter was matched to (to indicate GS vs RBY).
2017-09-08 06:53:12 +00:00
if (pkm.VC)
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
lines.Add(string.Format(L_F0_1, nameof(GameVersion), Info.Game));
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 (!Info.PIDParsed)
Info.PIDIV = MethodFinder.Analyze(pkm);
var pidiv = Info.PIDIV;
Add chain shiny and shinyPGF pidiv detection delete incorrect legality message entry (used a few lines up for super training flags), is unused. fix for transferred 8<=xor<16 PIDs in which case the encryption constant is used (as it is the unmodified PID)
2017-04-30 03:04:54 +00:00
if (pidiv != null)
{
if (!pidiv.NoSeed)
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
lines.Add(string.Format(L_FOriginSeed_0, pidiv.OriginSeed.ToString("X8")));
lines.Add(string.Format(L_FPIDType_0, pidiv.Type));
Add chain shiny and shinyPGF pidiv detection delete incorrect legality message entry (used a few lines up for super training flags), is unused. fix for transferred 8<=xor<16 PIDs in which case the encryption constant is used (as it is the unmodified PID)
2017-04-30 03:04:54 +00:00
}
Add invalid match alternatives to verbose output Indicates why another type of encounter to match to was rejected, mostly useful for diagnosing past gen specimens to figure out what changes need to be made for that encounter to persist.
2017-07-12 16:02:03 +00:00
if (!Valid && Info.InvalidMatches != null)
{
lines.Add("Other match(es):");
Add short/long name property differentiation
2019-03-18 05:19:37 +00:00
lines.AddRange(Info.InvalidMatches.Select(z => $"{z.LongName}: {z.Reason}"));
Add invalid match alternatives to verbose output Indicates why another type of encounter to match to was rejected, mostly useful for diagnosing past gen specimens to figure out what changes need to be made for that encounter to persist.
2017-07-12 16:02:03 +00:00
}
Remove trailing whitespace
2018-05-12 15:13:39 +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
return GetLegalityReport() + string.Join(Environment.NewLine, lines);
Add legality text exporting WIP -- no text is returned from the called method. Fixes the Control Click preview box not exporting ek6 (was right click previously).
2016-03-09 03:20:26 +00:00
}
RelearnMove suggestion instead of copyMoves
2016-03-25 07:10:11 +00:00
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Gets the current <see cref="PKM.RelearnMoves"/> array of four moves that might be legal.
/// </summary>
Misc clean split some methods with optional parameters=null add more xmldoc replace some magic numbers -> enum/const references consolidate common array operations (span soon maybe?)
2019-09-10 07:21:51 +00:00
public IReadOnlyList<int> GetSuggestedRelearn()
RelearnMove suggestion instead of copyMoves
2016-03-25 07:10:11 +00:00
{
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
if (Info?.RelearnBase == null || Info.Generation < 6)
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
return new int[4];
RelearnMove suggestion instead of copyMoves
2016-03-25 07:10:11 +00:00
Misc simplifications fixes suggestion requests for invalid gameversion pkms
2018-05-28 00:57:45 +00:00
if (!EncounterMatch.EggEncounter)
Misc updates fields->properties, capitalize fix pkm fields toggle referencing old pkm file, simplify that process instead of constantly referencing Format
2017-06-21 00:57:23 +00:00
return Info.RelearnBase;
RelearnMove suggestion instead of copyMoves
2016-03-25 07:10:11 +00:00
Gen2 egg gift bypass fix Gen4+ static encounter eggs could slide through the VC case prevent empty moves from appearing before suggested moves (relearnbase being empty)
2017-09-27 03:09:18 +00:00
List<int> window = new List<int>(Info.RelearnBase.Where(z => z != 0));
Refactoring more discards & simplifications
2018-05-12 19:28:48 +00:00
window.AddRange(pkm.Moves.Where((_, i) => !Info.Moves[i].Valid || Info.Moves[i].Flag));
Misc fixes (#1027) * Fix Chinese Characters mixup Some chinese characters are shared by tranditional CH and simplified CH, should be remapped as a whole. There is no chinese OT/HT. The remapping only happens at gen7 species nickname * Fix about HGSS Togepi gift egg Should upcase eggname when compare egg nickname at generation < 5 Remove unnecessary `wasegg`, it's checked before entering the function Get egg move from encounter table EncounterMatch should be as EncounterStatic type not a List. Remain only special move for in-game gift egg for order checking. Change default Static moves length to 0 Remove duplicate dratini * Avoid duplicate relearn move suggestion The move already in the move list above would be suggested again (was flagged) * Fix up some duplicate location strings Duplicate location string will affact location ID * Revert conflict parts to merge
2017-04-05 06:11:47 +00:00
window = window.Distinct().ToList();
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
int[] moves = new int[4];
int start = Math.Max(0, window.Count - 4);
int count = Math.Min(4, window.Count);
window.CopyTo(start, moves, 0, count);
return moves;
RelearnMove suggestion instead of copyMoves
2016-03-25 07:10:11 +00:00
}
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Gets four moves which can be learned depending on the input arguments.
/// </summary>
/// <param name="tm">Allow TM moves</param>
/// <param name="tutor">Allow Tutor moves</param>
/// <param name="reminder">Allow Move Reminder</param>
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
public int[] GetSuggestedMoves(bool tm, bool tutor, bool reminder)
Add current move suggestions Default levelup only, hold ctrl to add TM/Tutors to a randomized pool which takes 4 from.
2016-11-15 06:13:15 +00:00
{
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
if (!Parsed)
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
return new int[4];
Add egg base move branch Closes #1991 Thanks @iiippppk ! Improve pk2 version detect to better provide gs vs c egg base moves
2018-06-11 14:23:48 +00:00
if (pkm.IsEgg && pkm.Format <= 5) // pre relearn
Add Form (AltForm) to IEncounterable interface All of the encounterable templates have Form anyway; funny that I was consistent naming them all differently than pkm.AltForm :) Closes #2452
2019-11-19 06:20:55 +00:00
return Legal.GetBaseEggMoves(pkm, pkm.Species, 0, (GameVersion)pkm.Version, pkm.CurrentLevel);
Rewrite encounter move suggestion logic more straightforward logic flow, don't repeat same <= 2 comparison
2019-08-14 23:35:25 +00:00
if (!tm && !tutor && !reminder)
Update moveset suggestion for vc origin Closes #2014
2018-06-17 16:39:01 +00:00
{
Rewrite encounter move suggestion logic more straightforward logic flow, don't repeat same <= 2 comparison
2019-08-14 23:35:25 +00:00
// try to give current moves
if (Info.Generation <= 2)
{
var lvl = pkm.Format >= 7 ? pkm.Met_Level : pkm.CurrentLevel;
var ver = EncounterOriginal is IVersion v ? v.Version : (GameVersion)pkm.Version;
return MoveLevelUp.GetEncounterMoves(EncounterOriginal.Species, 0, lvl, ver);
}
if (pkm.Species == EncounterOriginal.Species)
{
return MoveLevelUp.GetEncounterMoves(pkm.Species, pkm.AltForm, pkm.CurrentLevel, (GameVersion)pkm.Version);
}
Update moveset suggestion for vc origin Closes #2014
2018-06-17 16:39:01 +00:00
}
Handle pre-VC2 era tradeback status for suggestions #2015 Can't get a shiny female 1:7 f:m gender ratio transfer after the VC2 bank update; need to respect that when generating random moves for the pkm by removing any gen2 evo chain data.
2018-06-17 16:55:07 +00:00
var evos = Info.EvoChainsAllGens;
return Legal.GetValidMoves(pkm, evos, Tutor: tutor, Machine: tm, MoveReminder: reminder).Skip(1).ToArray(); // skip move 0
Update verbose legality text output Now indicates the encounter type, misc text tweaks
2016-12-31 01:13:22 +00:00
}
Add xmldoc
2018-07-21 03:22:46 +00:00
/// <summary>
/// Gets an object containing met data properties that might be legal.
/// </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 EncounterStatic? GetSuggestedMetInfo() => EncounterSuggestion.GetSuggestedMetInfo(pkm);
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