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.Collections.Generic;
|
2016-06-20 04:22:43 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
public static partial class Legal
|
2014-12-14 07:18:27 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
internal const int MaxSpeciesID_6 = 721;
|
|
|
|
internal const int MaxMoveID_6_XY = 617;
|
|
|
|
internal const int MaxMoveID_6_AO = 621;
|
|
|
|
internal const int MaxItemID_6_XY = 717;
|
|
|
|
internal const int MaxItemID_6_AO = 775;
|
|
|
|
internal const int MaxAbilityID_6_XY = 188;
|
|
|
|
internal const int MaxAbilityID_6_AO = 191;
|
|
|
|
internal const int MaxBallID_6 = 0x19;
|
|
|
|
internal const int MaxGameID_6 = 27; // OR
|
|
|
|
|
|
|
|
#region Inventory Pouch
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_Items_XY =
|
|
|
|
{
|
|
|
|
001, 002, 003, 004, 005, 006, 007, 008, 009, 010, 011, 012, 013, 014, 015, 016, 055, 056,
|
|
|
|
057, 058, 059, 060, 061, 062, 063, 064, 065, 066, 067, 068, 069, 070, 071, 072, 073, 074, 075,
|
|
|
|
076, 077, 078, 079, 080, 081, 082, 083, 084, 085, 086, 087, 088, 089, 090, 091, 092, 093, 094,
|
|
|
|
099, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 112, 116, 117, 118, 119, 135, 136,
|
|
|
|
213, 214, 215, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232,
|
|
|
|
233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251,
|
|
|
|
252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270,
|
|
|
|
271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289,
|
|
|
|
290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308,
|
|
|
|
309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327,
|
|
|
|
492, 493, 494, 495, 496, 497, 498, 499, 500, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546,
|
|
|
|
547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 560, 561, 562, 563, 564, 571,
|
|
|
|
572, 573, 576, 577, 580, 581, 582, 583, 584, 585, 586, 587, 588, 589, 590, 639, 640, 644, 646,
|
|
|
|
647, 648, 649, 650, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662, 663, 664, 665, 666,
|
|
|
|
667, 668, 669, 670, 671, 672, 673, 674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685,
|
|
|
|
699, 704, 710, 711, 715,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_Items_AO =
|
|
|
|
{
|
|
|
|
001, 002, 003, 004, 005, 006, 007, 008, 009, 010, 011, 012, 013, 014, 015, 016, 055, 056,
|
|
|
|
057, 058, 059, 060, 061, 062, 063, 064, 068, 069, 070, 071, 072, 073, 074, 075,
|
|
|
|
076, 077, 078, 079, 080, 081, 082, 083, 084, 085, 086, 087, 088, 089, 090, 091, 092, 093, 094,
|
|
|
|
099, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 112, 116, 117, 118, 119, 135, 136,
|
|
|
|
213, 214, 215, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232,
|
|
|
|
233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251,
|
|
|
|
252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270,
|
|
|
|
271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289,
|
|
|
|
290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308,
|
|
|
|
309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327,
|
|
|
|
492, 493, 494, 495, 496, 497, 498, 499, 500, 537, 538, 539, 540, 541, 542, 543, 544, 545, 546,
|
|
|
|
547, 548, 549, 550, 551, 552, 553, 554, 555, 556, 557, 558, 559, 560, 561, 562, 563, 564, 571,
|
|
|
|
572, 573, 576, 577, 580, 581, 582, 583, 584, 585, 586, 587, 588, 589, 590, 639, 640, 644, 646,
|
|
|
|
647, 648, 649, 650, 652, 653, 654, 655, 656, 657, 658, 659, 660, 661, 662, 663, 664, 665, 666,
|
|
|
|
667, 668, 669, 670, 671, 672, 673, 674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685,
|
|
|
|
699, 704, 710, 711, 715,
|
|
|
|
|
|
|
|
// ORAS
|
|
|
|
534, 535,
|
|
|
|
752, 753, 754, 755, 756, 757, 758, 759, 760, 761, 762, 763, 764, 767, 768, 769, 770,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_Key_XY =
|
|
|
|
{
|
|
|
|
216, 431, 442, 445, 446, 447, 450, 465, 466, 471, 628,
|
|
|
|
629, 631, 632, 638, 641, 642, 643, 689, 695, 696, 697, 698,
|
|
|
|
700, 701, 702, 703, 705, 712, 713, 714,
|
|
|
|
|
|
|
|
// Illegal
|
|
|
|
// 716, 717, 706, 707,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_Key_AO =
|
|
|
|
{
|
|
|
|
216, 445, 446, 447, 465, 466, 471, 628,
|
|
|
|
629, 631, 632, 638, 697,
|
|
|
|
|
|
|
|
// Illegal
|
|
|
|
// 716, 717, 723, 745, 746, 747, 748, 749, 750, 766,
|
|
|
|
|
|
|
|
// ORAS
|
|
|
|
457, 474, 503,
|
|
|
|
|
|
|
|
718, 719,
|
|
|
|
720, 721, 722, 724, 725, 726, 727, 728, 729,
|
|
|
|
730, 731, 732, 733, 734, 735, 736, 738, 739,
|
|
|
|
740, 741, 742, 743, 744,
|
|
|
|
751,
|
|
|
|
765, 771, 772, 774, 775,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_TMHM_XY =
|
|
|
|
{
|
|
|
|
328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345,
|
|
|
|
346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363,
|
|
|
|
364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381,
|
|
|
|
382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399,
|
|
|
|
400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417,
|
|
|
|
418, 419, 618, 619, 620, 690, 691, 692, 693, 694,
|
|
|
|
|
|
|
|
420, 421, 422, 423, 424,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_TMHM_AO =
|
|
|
|
{
|
|
|
|
328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345,
|
|
|
|
346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363,
|
|
|
|
364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381,
|
|
|
|
382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399,
|
|
|
|
400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417,
|
|
|
|
418, 419, 618, 619, 620, 690, 691, 692, 693, 694,
|
|
|
|
|
|
|
|
420, 421, 422, 423, 424,
|
|
|
|
|
|
|
|
// ORAS
|
|
|
|
425, 737,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_Medicine_XY =
|
|
|
|
{
|
|
|
|
017, 018, 019, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 030, 031, 032, 033,
|
|
|
|
034, 035, 036, 037, 038, 039, 040, 041, 042, 043, 044, 045, 046, 047, 048, 049, 050, 051,
|
|
|
|
052, 053, 054, 134, 504, 565, 566, 567, 568, 569, 570, 571, 591, 645, 708, 709,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] Pouch_Medicine_AO =
|
|
|
|
{
|
|
|
|
017, 018, 019, 020, 021, 022, 023, 024, 025, 026, 027, 028, 029, 030, 031, 032, 033,
|
|
|
|
034, 035, 036, 037, 038, 039, 040, 041, 042, 043, 044, 045, 046, 047, 048, 049, 050, 051,
|
|
|
|
052, 053, 054, 134, 504, 565, 566, 567, 568, 569, 570, 571, 591, 645, 708, 709,
|
|
|
|
|
|
|
|
//ORAS
|
|
|
|
065, 066, 067,
|
|
|
|
};
|
|
|
|
|
|
|
|
public static readonly ushort[] Pouch_Berry_XY =
|
|
|
|
{
|
|
|
|
149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162,
|
|
|
|
163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177,
|
|
|
|
178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192,
|
|
|
|
193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207,
|
|
|
|
208, 209, 210, 211, 212, 686, 687, 688,
|
|
|
|
};
|
|
|
|
|
|
|
|
internal static readonly ushort[] HeldItem_XY = ArrayUtil.ConcatAll(Pouch_Items_XY, Pouch_Medicine_XY, Pouch_Berry_XY);
|
|
|
|
internal static readonly ushort[] HeldItem_AO = ArrayUtil.ConcatAll(Pouch_Items_AO, Pouch_Medicine_AO, Pouch_Berry_XY);
|
|
|
|
#endregion
|
|
|
|
|
|
|
|
#region TMHM
|
|
|
|
|
|
|
|
#endregion
|
|
|
|
|
2022-08-26 17:03:46 +00:00
|
|
|
internal static readonly HashSet<ushort> ValidMet_XY = new()
|
2022-06-18 18:04:24 +00:00
|
|
|
{
|
2022-09-27 16:57:28 +00:00
|
|
|
006, 008,
|
|
|
|
010, 012, 014, 016, 018,
|
|
|
|
020, 022, 024, 026, 028,
|
|
|
|
030, 032, 034, 036, 038,
|
|
|
|
040, 042, 044, 046, 048,
|
|
|
|
050, 052, 054, 056, 058,
|
|
|
|
060, 062, 064, 066, 068,
|
|
|
|
070, 072, 074, 076, 078,
|
|
|
|
082, 084, 086, 088,
|
|
|
|
090, 092, 094, 096, 098,
|
|
|
|
100, 102, 104, 106, 108,
|
|
|
|
110, 112, 114, 116, 118,
|
|
|
|
120, 122, 124, 126, 128,
|
|
|
|
130, 132, 134, 136, 138,
|
|
|
|
140, 142, 144, 146, 148,
|
|
|
|
150, 152, 154, 156, 158,
|
|
|
|
160, 162, 164, 166, 168,
|
2022-06-18 18:04:24 +00:00
|
|
|
};
|
|
|
|
|
2022-08-26 17:03:46 +00:00
|
|
|
internal static readonly HashSet<ushort> ValidMet_AO = new()
|
2022-06-18 18:04:24 +00:00
|
|
|
{
|
2022-09-27 16:57:28 +00:00
|
|
|
170, 172, 174, 176, 178,
|
|
|
|
180, 182, 184, 186, 188,
|
|
|
|
190, 192, 194, 196, 198,
|
|
|
|
200, 202, 204, 206, 208,
|
|
|
|
210, 212, 214, 216, 218,
|
|
|
|
220, 222, 224, 226, 228,
|
|
|
|
230, 232, 234, 236, 238,
|
|
|
|
240, 242, 244, 246, 248,
|
|
|
|
250, 252, 254, 256, 258,
|
|
|
|
260, 262, 264, 266, 268,
|
|
|
|
270, 272, 274, 276, 278,
|
|
|
|
280, 282, 284, 286, 288,
|
|
|
|
290, 292, 294, 296, 298,
|
|
|
|
300, 302, 304, 306, 308,
|
|
|
|
310, 312, 314, 316, 318,
|
|
|
|
320, 322, 324, 326, 328,
|
|
|
|
330, 332, 334, 336, 338,
|
|
|
|
340, 342, 344, 346,
|
|
|
|
350, 352, 354,
|
2022-06-18 18:04:24 +00:00
|
|
|
};
|
|
|
|
|
2022-08-29 23:08:30 +00:00
|
|
|
internal static readonly bool[] ReleasedHeldItems_6 = GetPermitList(MaxItemID_6_AO, HeldItem_AO, stackalloc ushort[]
|
2014-12-14 07:18:27 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
005, // Safari Ball
|
|
|
|
016, // Cherish Ball
|
|
|
|
492, // Fast Ball
|
|
|
|
493, // Level Ball
|
|
|
|
494, // Lure Ball
|
|
|
|
495, // Heavy Ball
|
|
|
|
496, // Love Ball
|
|
|
|
497, // Friend Ball
|
|
|
|
498, // Moon Ball
|
|
|
|
499, // Sport Ball
|
|
|
|
500, // Park Ball
|
|
|
|
548, // Fire Gem
|
|
|
|
549, // Water Gem
|
|
|
|
550, // Electric Gem
|
|
|
|
551, // Grass Gem
|
|
|
|
552, // Ice Gem
|
|
|
|
553, // Fighting Gem
|
|
|
|
554, // Poison Gem
|
|
|
|
555, // Ground Gem
|
|
|
|
556, // Flying Gem
|
|
|
|
557, // Psychic Gem
|
|
|
|
558, // Bug Gem
|
|
|
|
559, // Rock Gem
|
|
|
|
560, // Ghost Gem
|
|
|
|
561, // Dragon Gem
|
|
|
|
562, // Dark Gem
|
|
|
|
563, // Steel Gem
|
|
|
|
576, // Dream Ball
|
|
|
|
584, // Relic Copper
|
|
|
|
585, // Relic Silver
|
|
|
|
587, // Relic Vase
|
|
|
|
588, // Relic Band
|
|
|
|
589, // Relic Statue
|
|
|
|
590, // Relic Crown
|
|
|
|
715, // Fairy Gem
|
|
|
|
});
|
2014-12-14 07:18:27 +00:00
|
|
|
}
|