Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves
In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.
The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.
The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.
* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 23:15:27 +00:00
|
|
|
|
using System;
|
2020-01-19 03:11:29 +00:00
|
|
|
|
using System.Collections.Generic;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
using static PKHeX.Core.LegalityCheckStrings;
|
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
|
|
|
|
using static PKHeX.Core.LanguageID;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Verifies the <see cref="PKM.Nickname"/>.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public sealed class NicknameVerifier : Verifier
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
protected override CheckIdentifier Identifier => CheckIdentifier.Nickname;
|
|
|
|
|
|
|
|
|
|
public override void Verify(LegalityAnalysis data)
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
var pk = data.Entity;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// If the Pokémon is not nicknamed, it should match one of the language strings.
|
|
|
|
|
var nickname = pk.Nickname;
|
|
|
|
|
if (nickname.Length == 0)
|
|
|
|
|
{
|
|
|
|
|
data.AddLine(GetInvalid(LNickLengthShort));
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
if (pk.Species > SpeciesName.SpeciesLang[0].Count)
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves
In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.
The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.
The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.
* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 23:15:27 +00:00
|
|
|
|
data.AddLine(Get(LNickLengthShort, Severity.Invalid));
|
2022-06-18 18:04:24 +00:00
|
|
|
|
return;
|
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
var enc = data.EncounterOriginal;
|
|
|
|
|
if (enc is ILangNicknamedTemplate n)
|
|
|
|
|
{
|
|
|
|
|
VerifyFixedNicknameEncounter(data, n, enc, pk, nickname);
|
|
|
|
|
if (pk.IsEgg)
|
|
|
|
|
VerifyNicknameEgg(data);
|
|
|
|
|
return;
|
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (pk.Format <= 7 && pk.IsNicknamed) // can nickname afterwards
|
|
|
|
|
{
|
|
|
|
|
if (pk.VC)
|
|
|
|
|
VerifyG1NicknameWithinBounds(data, nickname.AsSpan());
|
|
|
|
|
else if (enc is MysteryGift {IsEgg: false})
|
|
|
|
|
data.AddLine(Get(LEncGiftNicknamed, ParseSettings.NicknamedMysteryGift));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (enc is EncounterTrade t)
|
|
|
|
|
{
|
|
|
|
|
VerifyNicknameTrade(data, t);
|
|
|
|
|
if (t.HasNickname)
|
2021-02-02 02:35:37 +00:00
|
|
|
|
return;
|
2022-06-18 18:04:24 +00:00
|
|
|
|
}
|
2021-02-02 02:35:37 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (pk.IsEgg)
|
|
|
|
|
{
|
|
|
|
|
VerifyNicknameEgg(data);
|
|
|
|
|
return;
|
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (VerifyUnNicknamedEncounter(data, pk, nickname))
|
|
|
|
|
return;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Non-nicknamed strings have already been checked.
|
|
|
|
|
if (ParseSettings.CheckWordFilter && pk.IsNicknamed)
|
|
|
|
|
{
|
|
|
|
|
if (WordFilter.IsFiltered(nickname, out string bad))
|
|
|
|
|
data.AddLine(GetInvalid($"Word Filter: {bad}"));
|
|
|
|
|
if (TrainerNameVerifier.ContainsTooManyNumbers(nickname, data.Info.Generation))
|
|
|
|
|
data.AddLine(GetInvalid("Word Filter: Too many numbers."));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private void VerifyFixedNicknameEncounter(LegalityAnalysis data, ILangNicknamedTemplate n, IEncounterTemplate enc, PKM pk, string nickname)
|
|
|
|
|
{
|
|
|
|
|
var nick = n.GetNickname(pk.Language);
|
|
|
|
|
|
|
|
|
|
if (string.IsNullOrWhiteSpace(nick))
|
|
|
|
|
{
|
|
|
|
|
if (n is WC8 {IsHOMEGift: true})
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
VerifyHomeGiftNickname(data, enc, pk, nickname);
|
2018-06-24 05:00:01 +00:00
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (n.CanHandleOT(pk.Language))
|
2018-06-24 05:00:01 +00:00
|
|
|
|
return;
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (n is WC3 && pk.Format != 3)
|
2018-10-09 00:57:34 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Gen3 gifts transferred to Generation 4 from another language can set the nickname flag.
|
|
|
|
|
var evos = data.Info.EvoChainsAllGens.Gen3;
|
2022-08-18 06:48:37 +00:00
|
|
|
|
foreach (var evo in evos)
|
|
|
|
|
{
|
|
|
|
|
if (!SpeciesName.IsNicknamedAnyLanguage(evo.Species, nickname, 3))
|
|
|
|
|
return;
|
|
|
|
|
}
|
2018-10-09 00:57:34 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
|
|
|
|
|
if (pk.IsNicknamed)
|
|
|
|
|
data.AddLine(Get(LEncGiftNicknamed, Severity.Invalid));
|
|
|
|
|
return;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (!pk.IsNicknamed)
|
2021-02-02 02:35:37 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Check if it had a nickname at all
|
|
|
|
|
var orig = SpeciesName.GetSpeciesNameGeneration(enc.Species, pk.Language, enc.Generation);
|
|
|
|
|
if (orig == nick)
|
2021-02-02 02:35:37 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Didn't have a nickname. Ensure that the language matches the current nickname string.
|
|
|
|
|
if (!SpeciesName.IsNicknamed(pk.Species, nickname, pk.Language, pk.Format))
|
2021-02-03 03:14:38 +00:00
|
|
|
|
return;
|
2021-02-02 02:35:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Should have a nickname present.
|
|
|
|
|
data.AddLine(GetInvalid(LNickMatchLanguageFail));
|
|
|
|
|
return;
|
2021-02-02 02:35:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Encounter has a nickname, and PKM should have it.
|
|
|
|
|
var severity = nick != nickname || !pk.IsNicknamed ? Severity.Invalid : Severity.Valid;
|
|
|
|
|
data.AddLine(Get(LEncGiftNicknamed, severity));
|
|
|
|
|
}
|
2021-02-03 03:21:17 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private void VerifyHomeGiftNickname(LegalityAnalysis data, IEncounterTemplate enc, ILangNick pk, string nickname)
|
|
|
|
|
{
|
|
|
|
|
// can nickname on redemption
|
|
|
|
|
if (!pk.IsNicknamed)
|
|
|
|
|
return;
|
2021-02-03 03:21:17 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Can't nickname everything.
|
|
|
|
|
if (enc.Species == (int) Species.Melmetal)
|
|
|
|
|
{
|
|
|
|
|
data.AddLine(GetInvalid(LEncGiftNicknamed));
|
|
|
|
|
return;
|
2021-02-03 03:14:38 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Ensure the nickname does not match species name
|
|
|
|
|
var orig = SpeciesName.GetSpeciesNameGeneration(enc.Species, pk.Language, enc.Generation);
|
|
|
|
|
if (nickname == orig)
|
|
|
|
|
data.AddLine(GetInvalid(LNickMatchLanguageFlag));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private bool VerifyUnNicknamedEncounter(LegalityAnalysis data, PKM pk, string nickname)
|
|
|
|
|
{
|
|
|
|
|
if (pk.IsNicknamed)
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (data.Info.Generation >= 8)
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Can only nickname if it matches your language.
|
|
|
|
|
// Setting the nickname to the same as the species name does not set the Nickname flag (equals unmodified, no flag)
|
|
|
|
|
if (!SpeciesName.IsNicknamed(pk.Species, nickname, pk.Language, pk.Format))
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
data.AddLine(Get(LNickMatchLanguageFlag, Severity.Invalid));
|
2018-06-24 05:00:01 +00:00
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
for (int i = 0; i < SpeciesName.SpeciesDict.Count; i++)
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-08-27 06:43:36 +00:00
|
|
|
|
if (!SpeciesName.SpeciesDict[i].TryGetValue(nickname, out var species))
|
2022-06-18 18:04:24 +00:00
|
|
|
|
continue;
|
|
|
|
|
var msg = species == pk.Species && i != pk.Language ? LNickMatchNoOthersFail : LNickMatchLanguageFlag;
|
|
|
|
|
data.AddLine(Get(msg, ParseSettings.NicknamedAnotherSpecies));
|
|
|
|
|
return true;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (pk.Format <= 7 && StringConverter.HasEastAsianScriptCharacters(nickname.AsSpan()) && pk is not PB7) // East Asian Scripts
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
data.AddLine(GetInvalid(LNickInvalidChar));
|
|
|
|
|
return true;
|
2018-08-31 01:09:52 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (nickname.Length > Legal.GetMaxLengthNickname(data.Info.Generation, (LanguageID)pk.Language))
|
|
|
|
|
{
|
|
|
|
|
int length = GetForeignNicknameLength(pk, data.Info.EncounterOriginal, data.Info.Generation);
|
|
|
|
|
var severe = (length != 0 && nickname.Length <= length) ? Severity.Fishy : Severity.Invalid;
|
|
|
|
|
data.AddLine(Get(LNickLengthLong, severe));
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
data.AddLine(GetValid(LNickMatchNoOthers));
|
2018-08-31 01:09:52 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
else if (pk.Format < 3)
|
2022-01-08 18:33:02 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// pk1/pk2 IsNicknamed getter checks for match, logic should only reach here if matches.
|
|
|
|
|
data.AddLine(GetValid(LNickMatchLanguage));
|
|
|
|
|
}
|
|
|
|
|
else
|
|
|
|
|
{
|
|
|
|
|
var enc = data.EncounterOriginal;
|
|
|
|
|
bool valid = IsNicknameValid(pk, enc, nickname);
|
|
|
|
|
var result = valid ? GetValid(LNickMatchLanguage) : GetInvalid(LNickMatchLanguageFail);
|
|
|
|
|
data.AddLine(result);
|
|
|
|
|
}
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static int GetForeignNicknameLength(PKM pk, IEncounterTemplate match, int origin)
|
|
|
|
|
{
|
|
|
|
|
// HOME gifts already verified prior to reaching here.
|
|
|
|
|
System.Diagnostics.Debug.Assert(match is not WC8 {IsHOMEGift:true});
|
2022-01-08 18:33:02 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
int length = 0;
|
|
|
|
|
if (origin is (4 or 5 or 6 or 7) && match.EggEncounter && pk.WasTradedEgg)
|
|
|
|
|
length = Legal.GetMaxLengthNickname(origin, English);
|
2022-01-08 18:33:02 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (pk.FatefulEncounter)
|
|
|
|
|
return length;
|
2022-01-08 18:33:02 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (pk.Format < 8 || pk.BDSP)
|
|
|
|
|
return length;
|
2022-01-08 18:33:02 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Can only nickname if the language matches.
|
|
|
|
|
var future = Legal.GetMaxLengthNickname(pk.Format, (LanguageID)pk.Language);
|
|
|
|
|
return Math.Max(length, future);
|
|
|
|
|
}
|
2022-01-08 18:33:02 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static bool IsNicknameValid(PKM pk, IEncounterTemplate enc, string nickname)
|
|
|
|
|
{
|
2022-08-27 06:43:36 +00:00
|
|
|
|
ushort species = pk.Species;
|
2022-06-18 18:04:24 +00:00
|
|
|
|
int format = pk.Format;
|
|
|
|
|
int language = pk.Language;
|
|
|
|
|
if (SpeciesName.GetSpeciesNameGeneration(species, language, format) == nickname)
|
|
|
|
|
return true;
|
|
|
|
|
|
|
|
|
|
// Can't have another language name if it hasn't evolved or wasn't a language-traded egg.
|
|
|
|
|
// Starting in Generation 8, hatched language-traded eggs will take the Language from the trainer that hatched it.
|
|
|
|
|
// Also in Generation 8, evolving in a foreign language game will retain the original language as the source for the newly evolved species name.
|
|
|
|
|
// Transferring from Gen7->Gen8 realigns the Nickname string to the Language, if not nicknamed.
|
|
|
|
|
bool canHaveAnyLanguage = format <= 7 && (enc.Species != species || pk.WasTradedEgg) && !pk.GG;
|
|
|
|
|
if (canHaveAnyLanguage && !SpeciesName.IsNicknamedAnyLanguage(species, nickname, format))
|
|
|
|
|
return true;
|
|
|
|
|
|
|
|
|
|
switch (enc)
|
2018-08-31 01:09:52 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
case WC7 wc7 when wc7.IsAshGreninjaWC7(pk):
|
2018-08-31 01:09:52 +00:00
|
|
|
|
return true;
|
2022-06-18 18:04:24 +00:00
|
|
|
|
case ILangNick loc:
|
|
|
|
|
if (loc.Language != 0 && !loc.IsNicknamed && !SpeciesName.IsNicknamedAnyLanguage(species, nickname, format))
|
|
|
|
|
return true; // fixed language without nickname, nice job event maker!
|
|
|
|
|
break;
|
|
|
|
|
}
|
2018-08-31 01:09:52 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (format == 5 && !pk.IsNative) // transfer
|
|
|
|
|
{
|
|
|
|
|
if (canHaveAnyLanguage)
|
|
|
|
|
return !SpeciesName.IsNicknamedAnyLanguage(species, nickname, 4);
|
|
|
|
|
return SpeciesName.GetSpeciesNameGeneration(species, language, 4) == nickname;
|
|
|
|
|
}
|
2018-08-31 01:09:52 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
return false;
|
|
|
|
|
}
|
2018-08-31 01:09:52 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyNicknameEgg(LegalityAnalysis data)
|
|
|
|
|
{
|
|
|
|
|
var Info = data.Info;
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
|
|
|
|
|
bool flagState = EggStateLegality.IsNicknameFlagSet(Info.EncounterMatch, pk);
|
|
|
|
|
if (pk.IsNicknamed != flagState)
|
|
|
|
|
data.AddLine(GetInvalid(flagState ? LNickFlagEggYes : LNickFlagEggNo, CheckIdentifier.Egg));
|
|
|
|
|
|
|
|
|
|
var nick = pk.Nickname;
|
|
|
|
|
if (pk.Format == 2 && !SpeciesName.IsNicknamedAnyLanguage(0, nick, 2))
|
|
|
|
|
data.AddLine(GetValid(LNickMatchLanguageEgg, CheckIdentifier.Egg));
|
Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves
In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.
The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.
The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.
* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 23:15:27 +00:00
|
|
|
|
else if (nick != SpeciesName.GetEggName(pk.Language, Info.Generation))
|
2022-06-18 18:04:24 +00:00
|
|
|
|
data.AddLine(GetInvalid(LNickMatchLanguageEggFail, CheckIdentifier.Egg));
|
|
|
|
|
else
|
|
|
|
|
data.AddLine(GetValid(LNickMatchLanguageEgg, CheckIdentifier.Egg));
|
|
|
|
|
}
|
2018-08-31 01:09:52 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyNicknameTrade(LegalityAnalysis data, EncounterTrade t)
|
|
|
|
|
{
|
|
|
|
|
switch (data.Info.Generation)
|
|
|
|
|
{
|
|
|
|
|
case 8 when t is EncounterTrade8b b: VerifyTrade8b(data, b); return;
|
|
|
|
|
|
|
|
|
|
case 1: VerifyTrade12(data, t); return;
|
|
|
|
|
case 2: return; // already checked all relevant properties when fetching with getValidEncounterTradeVC2
|
|
|
|
|
case 3: VerifyTrade3(data, t); return;
|
|
|
|
|
case 4: VerifyTrade4(data, t); return;
|
|
|
|
|
case 5: VerifyTrade5(data, t); return;
|
|
|
|
|
case 6:
|
|
|
|
|
case 7:
|
|
|
|
|
case 8:
|
|
|
|
|
VerifyTrade(data, t, data.Entity.Language); return;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private void VerifyG1NicknameWithinBounds(LegalityAnalysis data, ReadOnlySpan<char> str)
|
|
|
|
|
{
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
if (StringConverter12.GetIsG1English(str))
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (str.Length > 10)
|
|
|
|
|
data.AddLine(GetInvalid(LNickLengthLong));
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
else if (StringConverter12.GetIsG1Japanese(str))
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (str.Length > 5)
|
|
|
|
|
data.AddLine(GetInvalid(LNickLengthLong));
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
else if (pk.Korean && StringConverter2KOR.GetIsG2Korean(str))
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (str.Length > 5)
|
|
|
|
|
data.AddLine(GetInvalid(LNickLengthLong));
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
else
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
data.AddLine(GetInvalid(LG1CharNick));
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void VerifyTrade12(LegalityAnalysis data, EncounterTrade t)
|
|
|
|
|
{
|
|
|
|
|
var t1 = (EncounterTrade1)t;
|
|
|
|
|
if (!t1.IsNicknameValid(data.Entity))
|
|
|
|
|
data.AddLine(GetInvalid(LEncTradeChangedNickname, CheckIdentifier.Nickname));
|
|
|
|
|
if (!t1.IsTrainerNameValid(data.Entity))
|
|
|
|
|
data.AddLine(GetInvalid(LEncTradeChangedOT, CheckIdentifier.Trainer));
|
|
|
|
|
}
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyTrade3(LegalityAnalysis data, EncounterTrade t)
|
|
|
|
|
{
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
int lang = pk.Language;
|
|
|
|
|
if (t.Species == (int)Species.Jynx) // FRLG Jynx
|
|
|
|
|
lang = DetectTradeLanguageG3DANTAEJynx(pk, lang);
|
|
|
|
|
VerifyTrade(data, t, lang);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void VerifyTrade4(LegalityAnalysis data, EncounterTrade t)
|
|
|
|
|
{
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
if (pk.TID == 1000)
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
VerifyTradeOTOnly(data, t);
|
|
|
|
|
return;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
int lang = pk.Language;
|
|
|
|
|
switch (t.Species)
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
case (int)Species.Pikachu: // HGSS Pikachu
|
|
|
|
|
lang = DetectTradeLanguageG4SurgePikachu(pk, t, lang);
|
|
|
|
|
// flag korean on gen4 saves since the pk.Language is German
|
|
|
|
|
FlagKoreanIncompatibleSameGenTrade(data, pk, lang);
|
|
|
|
|
break;
|
|
|
|
|
case (int)Species.Magikarp: // DPPt Magikarp
|
|
|
|
|
lang = DetectTradeLanguageG4MeisterMagikarp(pk, t, lang);
|
|
|
|
|
// flag korean on gen4 saves since the pk.Language is German
|
|
|
|
|
FlagKoreanIncompatibleSameGenTrade(data, pk, lang);
|
|
|
|
|
break;
|
|
|
|
|
|
|
|
|
|
default:
|
|
|
|
|
if (t is EncounterTrade4PID && pk.Version is ((int)GameVersion.D or (int)GameVersion.P)) // mainline DP
|
|
|
|
|
{
|
|
|
|
|
// DP English origin are Japanese lang. Can't have LanguageID 2
|
|
|
|
|
if (lang == 2)
|
2018-10-27 20:37:03 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
data.AddLine(GetInvalid(string.Format(LOTLanguage, Japanese, English), CheckIdentifier.Language));
|
|
|
|
|
break;
|
2018-10-27 20:37:03 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Since two locales (JPN/ENG) can have the same LanguageID, check which we should be validating with.
|
|
|
|
|
if (lang == 1 && pk.OT_Name != t.GetOT(1)) // not Japanese
|
|
|
|
|
lang = 2; // verify strings with English locale instead.
|
2022-01-08 17:59:35 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
break;
|
2021-11-20 02:23:49 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
VerifyTrade(data, t, lang);
|
|
|
|
|
}
|
2021-11-20 02:23:49 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyTrade8b(LegalityAnalysis data, EncounterTrade8b t)
|
|
|
|
|
{
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
int lang = pk.Language;
|
|
|
|
|
if (t.Species == (int)Species.Magikarp)
|
2021-12-12 06:23:05 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Japanese
|
|
|
|
|
if (pk.Language == (int)Japanese && pk.OT_Name is "Diamond." or "Pearl.")
|
2021-12-25 20:57:05 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// Traded between players, the original OT is replaced with the above OT (version dependent) as the original OT is >6 chars in length.
|
|
|
|
|
VerifyTradeNickname(data, t, t.Nicknames[(int)German], pk);
|
|
|
|
|
return;
|
2021-12-25 20:57:05 +00:00
|
|
|
|
}
|
2021-12-12 06:23:05 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
lang = DetectTradeLanguageG8MeisterMagikarp(pk, t, lang);
|
|
|
|
|
if (lang == 0) // err
|
|
|
|
|
data.AddLine(GetInvalid(string.Format(LOTLanguage, $"{Japanese}/{German}", $"{(LanguageID)pk.Language}"), CheckIdentifier.Language));
|
2018-10-27 20:37:03 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
VerifyTrade(data, t, lang);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static int DetectTradeLanguageG8MeisterMagikarp(PKM pk, EncounterTrade8b t, int currentLanguageID)
|
|
|
|
|
{
|
|
|
|
|
// Receiving the trade on a German game -> Japanese LanguageID.
|
|
|
|
|
// Receiving the trade on any other language -> German LanguageID.
|
|
|
|
|
if (currentLanguageID is not ((int)Japanese or (int)German))
|
|
|
|
|
return 0;
|
2018-10-27 20:37:03 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
var nick = pk.Nickname;
|
|
|
|
|
var ot = pk.OT_Name;
|
|
|
|
|
for (int i = 1; i < (int)ChineseT; i++)
|
2018-10-27 20:37:03 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (t.Nicknames[i] != nick)
|
|
|
|
|
continue;
|
|
|
|
|
if (t.TrainerNames[i] != ot)
|
|
|
|
|
continue;
|
|
|
|
|
|
|
|
|
|
// Language gets flipped to another language ID; can't be equal.
|
|
|
|
|
var shouldNotBe = currentLanguageID == (int)German ? German : Japanese;
|
|
|
|
|
return i != (int)shouldNotBe ? i : 0;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
return 0;
|
|
|
|
|
}
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void FlagKoreanIncompatibleSameGenTrade(LegalityAnalysis data, PKM pk, int lang)
|
|
|
|
|
{
|
|
|
|
|
if (pk.Format != 4 || lang != (int)Korean)
|
|
|
|
|
return; // transferred or not appropriate
|
|
|
|
|
if (ParseSettings.ActiveTrainer.Language != (int)Korean && ParseSettings.ActiveTrainer.Language >= 0)
|
|
|
|
|
data.AddLine(GetInvalid(string.Format(LTransferOriginFInvalid0_1, L_XKorean, L_XKoreanNon), CheckIdentifier.Language));
|
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static int DetectTradeLanguage(string OT, EncounterTrade t, int currentLanguageID)
|
|
|
|
|
{
|
|
|
|
|
var names = t.TrainerNames;
|
|
|
|
|
for (int lang = 1; lang < names.Count; lang++)
|
|
|
|
|
{
|
|
|
|
|
if (names[lang] != OT)
|
|
|
|
|
continue;
|
|
|
|
|
return lang;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
return currentLanguageID;
|
|
|
|
|
}
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static int DetectTradeLanguageG3DANTAEJynx(PKM pk, int currentLanguageID)
|
|
|
|
|
{
|
|
|
|
|
if (currentLanguageID != (int)Italian)
|
|
|
|
|
return currentLanguageID;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (pk.Version == (int)GameVersion.LG)
|
|
|
|
|
currentLanguageID = (int)English; // translation error; OT was not localized => same as English
|
|
|
|
|
return currentLanguageID;
|
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static int DetectTradeLanguageG4MeisterMagikarp(PKM pk, EncounterTrade t, int currentLanguageID)
|
|
|
|
|
{
|
|
|
|
|
if (currentLanguageID == (int)English)
|
|
|
|
|
return (int)German;
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// All have German, regardless of origin version.
|
|
|
|
|
var lang = DetectTradeLanguage(pk.OT_Name, t, currentLanguageID);
|
|
|
|
|
if (lang == (int)English) // possible collision with FR/ES/DE. Check nickname
|
|
|
|
|
return pk.Nickname == t.Nicknames[(int)French] ? (int)French : (int)Spanish; // Spanish is same as English
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
return lang;
|
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static int DetectTradeLanguageG4SurgePikachu(PKM pk, EncounterTrade t, int currentLanguageID)
|
|
|
|
|
{
|
|
|
|
|
if (currentLanguageID == (int)French)
|
|
|
|
|
return (int)English;
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
// All have English, regardless of origin version.
|
|
|
|
|
var lang = DetectTradeLanguage(pk.OT_Name, t, currentLanguageID);
|
|
|
|
|
if (lang == 2) // possible collision with ES/IT. Check nickname
|
|
|
|
|
return pk.Nickname == t.Nicknames[(int)Italian] ? (int)Italian : (int)Spanish;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
return lang;
|
|
|
|
|
}
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyTrade5(LegalityAnalysis data, EncounterTrade t)
|
|
|
|
|
{
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
int lang = pk.Language;
|
|
|
|
|
// Trades for JPN games have language ID of 0, not 1.
|
|
|
|
|
if (pk.BW)
|
2018-07-27 02:34:27 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (pk.Format == 5 && lang == (int)Japanese)
|
|
|
|
|
data.AddLine(GetInvalid(string.Format(LOTLanguage, 0, Japanese), CheckIdentifier.Language));
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
lang = Math.Max(lang, 1);
|
|
|
|
|
VerifyTrade(data, t, lang);
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
else // B2W2
|
2018-06-24 05:00:01 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (t.TID is Encounters5.YancyTID or Encounters5.CurtisTID)
|
2020-10-31 03:31:12 +00:00
|
|
|
|
VerifyTradeOTOnly(data, t);
|
|
|
|
|
else
|
2022-06-18 18:04:24 +00:00
|
|
|
|
VerifyTrade(data, t, lang);
|
2018-10-27 20:37:03 +00:00
|
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyTradeOTOnly(LegalityAnalysis data, EncounterTrade t)
|
|
|
|
|
{
|
|
|
|
|
var result = CheckTradeOTOnly(data, t.TrainerNames);
|
|
|
|
|
data.AddLine(result);
|
|
|
|
|
}
|
2018-06-24 05:00:01 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static CheckResult CheckTradeOTOnly(LegalityAnalysis data, IReadOnlyList<string> validOT)
|
|
|
|
|
{
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
if (pk.IsNicknamed && (pk.Format < 8 || pk.FatefulEncounter))
|
|
|
|
|
return GetInvalid(LEncTradeChangedNickname, CheckIdentifier.Nickname);
|
|
|
|
|
int lang = pk.Language;
|
|
|
|
|
if (validOT.Count <= lang)
|
|
|
|
|
return GetInvalid(LEncTradeIndexBad, CheckIdentifier.Trainer);
|
|
|
|
|
if (validOT[lang] != pk.OT_Name)
|
|
|
|
|
return GetInvalid(LEncTradeChangedOT, CheckIdentifier.Trainer);
|
|
|
|
|
return GetValid(LEncTradeUnchanged, CheckIdentifier.Nickname);
|
|
|
|
|
}
|
2018-07-27 02:34:27 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyTrade(LegalityAnalysis data, EncounterTrade t, int language)
|
|
|
|
|
{
|
|
|
|
|
var ot = t.GetOT(language);
|
|
|
|
|
var nick = t.GetNickname(language);
|
|
|
|
|
if (string.IsNullOrEmpty(nick))
|
|
|
|
|
VerifyTradeOTOnly(data, t);
|
|
|
|
|
else
|
|
|
|
|
VerifyTradeOTNick(data, t, nick, ot);
|
|
|
|
|
}
|
2022-01-08 17:59:35 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private static void VerifyTradeOTNick(LegalityAnalysis data, EncounterTrade t, string nick, string OT)
|
|
|
|
|
{
|
|
|
|
|
var pk = data.Entity;
|
|
|
|
|
// trades that are not nicknamed (but are present in a table with others being named)
|
|
|
|
|
VerifyTradeNickname(data, t, nick, pk);
|
|
|
|
|
|
|
|
|
|
if (OT != pk.OT_Name)
|
|
|
|
|
data.AddLine(GetInvalid(LEncTradeChangedOT, CheckIdentifier.Trainer));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static void VerifyTradeNickname(LegalityAnalysis data, EncounterTrade t, string expectedNickname, PKM pk)
|
|
|
|
|
{
|
|
|
|
|
var result = IsNicknameMatch(expectedNickname, pk, t)
|
|
|
|
|
? GetValid(LEncTradeUnchanged, CheckIdentifier.Nickname)
|
|
|
|
|
: Get(LEncTradeChangedNickname, ParseSettings.NicknamedTrade, CheckIdentifier.Nickname);
|
|
|
|
|
data.AddLine(result);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
private static bool IsNicknameMatch(string nick, ILangNick pk, EncounterTrade enc)
|
|
|
|
|
{
|
|
|
|
|
if (nick == "Quacklin’" && pk.Nickname == "Quacklin'")
|
2018-08-27 01:32:39 +00:00
|
|
|
|
return true;
|
2022-06-18 18:04:24 +00:00
|
|
|
|
if (enc.IsNicknamed != pk.IsNicknamed)
|
|
|
|
|
return false;
|
|
|
|
|
if (nick != pk.Nickname) // if not match, must not be a nicknamed trade && not currently named
|
|
|
|
|
return !enc.IsNicknamed && !pk.IsNicknamed;
|
|
|
|
|
return true;
|
2018-06-24 05:00:01 +00:00
|
|
|
|
}
|
|
|
|
|
}
|