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

593 lines
25 KiB
C#
Raw Normal View History

Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
using System;
Make Move[] readonly list contract: don't modify the template movesets mystery gift now exposes IRelearn, remove unnecessary type checks
2020-01-19 00:46:38 +00:00
using System.Collections.Generic;
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
using static System.Buffers.Binary. BinaryPrimitives;
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
namespace PKHeX.Core
{
/// <summary>
/// Generation 7 Mystery Gift Template File
/// </summary>
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
public sealed class WB7 : DataMysteryGift, ILangNick, IAwakened, INature, ILangNicknamedTemplate
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
public const int Size = 0x108;
public const int SizeFull = 0x310;
private const int CardStart = SizeFull - Size;
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
public override int Generation => 7;
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +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
public WB7() : this(new byte[SizeFull]) { }
public WB7(byte[] data) : base(data) { }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Indicate version metadata for lgpe gifts Just metadata, no functional change
2021-08-26 22:47:44 +00:00
public override GameVersion Version { get => GameVersion.GG; set { } }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
public byte RestrictVersion { get => Data[0]; set => Data[0] = value; }
public bool CanBeReceivedByVersion(int v)
{
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
if (v is not ((int)GameVersion.GP or (int)GameVersion.GE))
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
return false;
if (RestrictVersion == 0)
return true; // no data
Fix version check Encounter browser entered infinite loop waiting for valid version
2018-11-22 18:10:25 +00:00
var bitIndex = v - (int)GameVersion.GP;
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
var bit = 1 << bitIndex;
return (RestrictVersion & bit) != 0;
}
// General Card Properties
public override int CardID
{
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0));
set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0), (ushort)value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
public override string CardTitle
{
// Max len 36 char, followed by null terminator
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => StringConverter8.GetString(Data.AsSpan(CardStart + 2, 0x4A));
set => StringConverter8.SetString(Data.AsSpan(CardStart + 2, 0x4A), value.AsSpan(), 36, StringConverterOption.ClearZero);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
private uint RawDate
{
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadUInt32LittleEndian(Data.AsSpan(CardStart + 0x4C));
set => WriteUInt32LittleEndian(Data.AsSpan(CardStart + 0x4C), value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
private uint Year
{
get => (RawDate / 10000) + 2000;
Misc cleanup removes clickonce logic/reference
2018-12-11 04:32:08 +00:00
set => RawDate = SetDate(value, Month, Day);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
private uint Month
{
get => RawDate % 10000 / 100;
Misc cleanup removes clickonce logic/reference
2018-12-11 04:32:08 +00:00
set => RawDate = SetDate(Year, value, Day);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
private uint Day
{
get => RawDate % 100;
Misc cleanup removes clickonce logic/reference
2018-12-11 04:32:08 +00:00
set => RawDate = SetDate(Year, Month, value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
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
private static uint SetDate(uint year, uint month, uint day) => (Math.Max(0, year - 2000) * 10000) + (month * 100) + day;
Misc cleanup removes clickonce logic/reference
2018-12-11 04:32:08 +00:00
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
/// <summary>
/// Gets or sets the date of the card.
/// </summary>
public DateTime? Date
{
get
{
// Check to see if date is valid
Split DateUtil from Util class
2021-05-14 23:46:48 +00:00
if (!DateUtil.IsDateValid(Year, Month, Day))
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
return null;
return new DateTime((int)Year, (int)Month, (int)Day);
}
set
{
if (value.HasValue)
{
// Only update the properties if a value is provided.
Year = (ushort)value.Value.Year;
Month = (byte)value.Value.Month;
Day = (byte)value.Value.Day;
}
else
{
// Clear the Met Date.
// If code tries to access MetDate again, null will be returned.
Year = 0;
Month = 0;
Day = 0;
}
}
}
public int CardLocation { get => Data[CardStart + 0x50]; set => Data[CardStart + 0x50] = (byte)value; }
public int CardType { get => Data[CardStart + 0x51]; set => Data[CardStart + 0x51] = (byte)value; }
public byte CardFlags { get => Data[CardStart + 0x52]; set => Data[CardStart + 0x52] = value; }
public bool GiftRepeatable { get => (CardFlags & 1) == 0; set => CardFlags = (byte)((CardFlags & ~1) | (value ? 0 : 1)); }
public override bool GiftUsed { get => (CardFlags & 2) == 2; set => CardFlags = (byte)((CardFlags & ~2) | (value ? 2 : 0)); }
public bool GiftOncePerDay { get => (CardFlags & 4) == 4; set => CardFlags = (byte)((CardFlags & ~4) | (value ? 4 : 0)); }
Revert implicit casting Looks like netstandard2.0 wasn't meant to receive that new c#9 goodie
2021-03-29 07:14:44 +00:00
public bool MultiObtain { get => Data[CardStart + 0x53] == 1; set => Data[CardStart + 0x53] = value ? (byte)1 : (byte)0; }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
// Item Properties
public override bool IsItem { get => CardType == 1; set { if (value) CardType = 1; } }
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
public override int ItemID { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x68)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x68), (ushort)value); }
public int GetItem(int index) => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x68 + (0x4 * index)));
public void SetItem(int index, ushort item) => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x68 + (4 * index)), item);
public int GetQuantity(int index) => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x6A + (0x4 * index)));
public void SetQuantity(int index, ushort quantity) => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x6A + (4 * index)), quantity);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
public override int Quantity
{
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x6A));
set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x6A), (ushort)value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
// Pokémon Properties
Replace é->e for code symbols Closes #3519 Usages weren't consistent; since `é` isn't accessible on usual english keyboards, just use regular `e` instead of alt-223 entry. Not sure why VS preferred to save the text files without an encoding prefix; oh well.
2022-06-11 22:32:12 +00:00
public override bool IsEntity { get => CardType == 0; set { if (value) CardType = 0; } }
Disassociate Shiny enum from WC6 PIDType (#3461) Have `Shiny.Random` be `0`, so we can skip init on this field for EncounterStatic. Plus makes it a little less brittle for future expansion if shiny qualities change.
2022-03-13 01:04:20 +00:00
public override bool IsShiny => PIDType == ShinyType6.Always;
public override Shiny Shiny => PIDType switch
{
ShinyType6.FixedValue => Shiny.FixedValue,
ShinyType6.Random => Shiny.Random,
ShinyType6.Always => Shiny.Always,
ShinyType6.Never => Shiny.Never,
_ => throw new ArgumentOutOfRangeException(),
};
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
public override int TID
{
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x68));
set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x68), (ushort)value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
public override int SID {
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x6A));
set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x6A), (ushort)value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
public int OriginGame
{
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadInt32LittleEndian(Data.AsSpan(CardStart + 0x6C));
set => WriteInt32LittleEndian(Data.AsSpan(CardStart + 0x6C), value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
public uint EncryptionConstant {
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadUInt32LittleEndian(Data.AsSpan(CardStart + 0x70));
set => WriteUInt32LittleEndian(Data.AsSpan(CardStart + 0x70), value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
public override int Ball
{
get => Data[CardStart + 0x76];
set => Data[CardStart + 0x76] = (byte)value; }
Update wb7 def AV offsets were incorrect sub_71001C79E0
2018-11-25 23:52:30 +00:00
public override int HeldItem // no references
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x78));
set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x78), (ushort)value);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
public int Move1 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x7A)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x7A), (ushort)value); }
public int Move2 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x7C)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x7C), (ushort)value); }
public int Move3 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x7E)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x7E), (ushort)value); }
public int Move4 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x80)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x80), (ushort)value); }
public override int Species { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0x82)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0x82), (ushort)value); }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
public override int Form { get => Data[CardStart + 0x84]; set => Data[CardStart + 0x84] = (byte)value; }
// public int Language { get => Data[CardStart + 0x85]; set => Data[CardStart + 0x85] = (byte)value; }
// public string Nickname
// {
// get => Util.TrimFromZero(Encoding.Unicode.GetString(Data, CardStart + 0x86, 0x1A));
// set => Encoding.Unicode.GetBytes(value.PadRight(12 + 1, '\0')).CopyTo(Data, CardStart + 0x86);
// }
public int Nature { get => (sbyte)Data[CardStart + 0xA0]; set => Data[CardStart + 0xA0] = (byte)value; }
public override int Gender { get => Data[CardStart + 0xA1]; set => Data[CardStart + 0xA1] = (byte)value; }
Allow ability 1/2 for wb7 origin
2020-03-19 05:31:27 +00:00
public override int AbilityType { get => 3; set => Data[CardStart + 0xA2] = (byte)value; } // no references, always ability 0/1
Disassociate Shiny enum from WC6 PIDType (#3461) Have `Shiny.Random` be `0`, so we can skip init on this field for EncounterStatic. Plus makes it a little less brittle for future expansion if shiny qualities change.
2022-03-13 01:04:20 +00:00
public ShinyType6 PIDType { get => (ShinyType6)Data[CardStart + 0xA3]; set => Data[CardStart + 0xA3] = (byte)value; }
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
public override int EggLocation { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0xA4)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0xA4), (ushort)value); }
public int MetLocation { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0xA6)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0xA6), (ushort)value); }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
public int MetLevel { get => Data[CardStart + 0xA8]; set => Data[CardStart + 0xA8] = (byte)value; }
public int IV_HP { get => Data[CardStart + 0xAF]; set => Data[CardStart + 0xAF] = (byte)value; }
public int IV_ATK { get => Data[CardStart + 0xB0]; set => Data[CardStart + 0xB0] = (byte)value; }
public int IV_DEF { get => Data[CardStart + 0xB1]; set => Data[CardStart + 0xB1] = (byte)value; }
public int IV_SPE { get => Data[CardStart + 0xB2]; set => Data[CardStart + 0xB2] = (byte)value; }
public int IV_SPA { get => Data[CardStart + 0xB3]; set => Data[CardStart + 0xB3] = (byte)value; }
public int IV_SPD { get => Data[CardStart + 0xB4]; set => Data[CardStart + 0xB4] = (byte)value; }
public int OTGender { get => Data[CardStart + 0xB5]; set => Data[CardStart + 0xB5] = (byte)value; }
// public override string OT_Name
// {
// get => Util.TrimFromZero(Encoding.Unicode.GetString(Data, CardStart + 0xB6, 0x1A));
// set => Encoding.Unicode.GetBytes(value.PadRight(value.Length + 1, '\0')).CopyTo(Data, CardStart + 0xB6);
// }
-8 bytes from each encounter template saves about ~1MB RAM savings (>=179,142 objects)
2022-03-07 07:25:47 +00:00
public override byte Level { get => Data[CardStart + 0xD0]; set => Data[CardStart + 0xD0] = value; }
Revert implicit casting Looks like netstandard2.0 wasn't meant to receive that new c#9 goodie
2021-03-29 07:14:44 +00:00
public override bool IsEgg { get => Data[CardStart + 0xD1] == 1; set => Data[CardStart + 0xD1] = value ? (byte)1 : (byte)0; }
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
public ushort AdditionalItem { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0xD2)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0xD2), value); }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
public uint PID { get => ReadUInt32LittleEndian(Data.AsSpan(0xD4)); set => WriteUInt32LittleEndian(Data.AsSpan(0xD4), value); }
public int RelearnMove1 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0xD8)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0xD8), (ushort)value); }
public int RelearnMove2 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0xDA)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0xDA), (ushort)value); }
public int RelearnMove3 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0xDC)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0xDC), (ushort)value); }
public int RelearnMove4 { get => ReadUInt16LittleEndian(Data.AsSpan(CardStart + 0xDE)); set => WriteUInt16LittleEndian(Data.AsSpan(CardStart + 0xDE), (ushort)value); }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Reduce IAwakened from int->byte
2022-03-06 02:46:03 +00:00
public byte AV_HP { get => Data[CardStart + 0xE5]; set => Data[CardStart + 0xE5] = value; }
public byte AV_ATK { get => Data[CardStart + 0xE6]; set => Data[CardStart + 0xE6] = value; }
public byte AV_DEF { get => Data[CardStart + 0xE7]; set => Data[CardStart + 0xE7] = value; }
public byte AV_SPE { get => Data[CardStart + 0xE8]; set => Data[CardStart + 0xE8] = value; }
public byte AV_SPA { get => Data[CardStart + 0xE9]; set => Data[CardStart + 0xE9] = value; }
public byte AV_SPD { get => Data[CardStart + 0xEA]; set => Data[CardStart + 0xEA] = value; }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
// Meta Accessible Properties
public override int[] IVs
{
get => new[] { IV_HP, IV_ATK, IV_DEF, IV_SPE, IV_SPA, IV_SPD };
set
{
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 (value.Length != 6) return;
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
IV_HP = value[0]; IV_ATK = value[1]; IV_DEF = value[2];
IV_SPE = value[3]; IV_SPA = value[4]; IV_SPD = value[5];
}
}
Stackalloc IVs for template->pkm fill
2022-03-14 02:24:08 +00:00
public override void GetIVs(Span<int> value)
{
if (value.Length != 6)
return;
value[0] = IV_HP;
value[1] = IV_ATK;
value[2] = IV_DEF;
value[3] = IV_SPE;
value[4] = IV_SPA;
value[5] = IV_SPD;
}
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
public bool GetIsNicknamed(int language) => Data[GetNicknameOffset(language)] != 0;
Minor clean
2019-11-19 06:48:03 +00:00
private static int GetLanguageIndex(int language)
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
var lang = (LanguageID) language;
moar is or
2020-12-25 20:30:26 +00:00
if (lang is < LanguageID.Japanese or LanguageID.UNUSED_6 or > LanguageID.ChineseT)
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
return (int) LanguageID.English; // fallback
return lang < LanguageID.UNUSED_6 ? language - 1 : language - 2;
}
public override int Location { get => MetLocation; set => MetLocation = (ushort)value; }
Make Move[] readonly list contract: don't modify the template movesets mystery gift now exposes IRelearn, remove unnecessary type checks
2020-01-19 00:46:38 +00:00
public override IReadOnlyList<int> Moves
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
get => new[] { Move1, Move2, Move3, Move4 };
set
{
Make Move[] readonly list contract: don't modify the template movesets mystery gift now exposes IRelearn, remove unnecessary type checks
2020-01-19 00:46:38 +00:00
if (value.Count > 0) Move1 = value[0];
if (value.Count > 1) Move2 = value[1];
if (value.Count > 2) Move3 = value[2];
if (value.Count > 3) Move4 = value[3];
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
}
Make Move[] readonly list contract: don't modify the template movesets mystery gift now exposes IRelearn, remove unnecessary type checks
2020-01-19 00:46:38 +00:00
public override IReadOnlyList<int> Relearn
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
get => new[] { RelearnMove1, RelearnMove2, RelearnMove3, RelearnMove4 };
set
{
Make Move[] readonly list contract: don't modify the template movesets mystery gift now exposes IRelearn, remove unnecessary type checks
2020-01-19 00:46:38 +00:00
if (value.Count > 0) RelearnMove1 = value[0];
if (value.Count > 1) RelearnMove2 = value[1];
if (value.Count > 2) RelearnMove3 = value[2];
if (value.Count > 3) RelearnMove4 = value[3];
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
}
public override string OT_Name { get; set; } = string.Empty;
public string Nickname => string.Empty;
public bool IsNicknamed => false;
public int Language => 2;
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
public int GetLanguage(int redeemLanguage)
{
var languageOffset = GetLanguageIndex(redeemLanguage);
Update WB7.cs
2021-08-24 20:12:14 +00:00
var value = Data[0x1D8 + languageOffset];
if (value != 0) // Fixed receiving language
return value;
// Use redeeming language (clamped to legal values for our sake)
if (redeemLanguage is < (int)LanguageID.Japanese or (int)LanguageID.UNUSED_6 or > (int)LanguageID.ChineseT)
return (int)LanguageID.English; // fallback
return redeemLanguage;
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
}
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
public string GetNickname(int language) => StringConverter8.GetString(Data.AsSpan(GetNicknameOffset(language), 0x1A));
public void SetNickname(int language, string value) => StringConverter8.SetString(Data.AsSpan(GetNicknameOffset(language), 0x1A), value.AsSpan(), 12, StringConverterOption.ClearZero);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
public string GetOT(int language) => StringConverter8.GetString(Data.AsSpan(GetOTOffset(language), 0x1A));
public void SetOT(int language, string value) => StringConverter8.SetString(Data.AsSpan(GetOTOffset(language), 0x1A), value.AsSpan(), 12, StringConverterOption.ClearZero);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Minor tweaks Extract some interfaces Suppress some warning messages with commented reasons if appropriate
2020-09-09 19:47:24 +00:00
private static int GetNicknameOffset(int language)
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
int index = GetLanguageIndex(language);
return 0x04 + (index * 0x1A);
}
Minor tweaks Extract some interfaces Suppress some warning messages with commented reasons if appropriate
2020-09-09 19:47:24 +00:00
private static int GetOTOffset(int language)
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
int index = GetLanguageIndex(language);
return 0xEE + (index * 0x1A);
}
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
public override PKM ConvertToPKM(ITrainerInfo sav, EncounterCriteria criteria)
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
Replace é->e for code symbols Closes #3519 Usages weren't consistent; since `é` isn't accessible on usual english keyboards, just use regular `e` instead of alt-223 entry. Not sure why VS preferred to save the text files without an encoding prefix; oh well.
2022-06-11 22:32:12 +00:00
if (!IsEntity)
throw new ArgumentException(nameof(IsEntity));
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Update Random to be a bit more thread safe Random isn't thread safe; users of PKHeX.Core.dll might run multithreaded operations (see PKSM + ALM), so we need to have a thread-specific RNG available. Thread Local get; to improve performance, save the random object locally whenever it is used more than once in the method. https://docs.microsoft.com/en-us/dotnet/api/system.threading.threadlocal-1?redirectedfrom=MSDN&view=netframework-4.8 https://stackoverflow.com/questions/18333885/threadstatic-v-s-threadlocalt-is-generic-better-than-attribute/18337158#18337158
2020-01-26 05:49:52 +00:00
var rnd = Util.Rand;
int currentLevel = Level > 0 ? Level : rnd.Next(1, 101);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
int metLevel = MetLevel > 0 ? MetLevel : currentLevel;
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
var pi = PersonalTable.GG.GetFormEntry(Species, Form);
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
var redeemLanguage = sav.Language;
var language = GetLanguage(redeemLanguage);
var OT = GetOT(redeemLanguage);
bool isRedeemHT = OT.Length != 0;
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
var pk = new PB7
{
Species = Species,
HeldItem = HeldItem,
TID = TID,
SID = SID,
Met_Level = metLevel,
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
Form = Form,
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
EncryptionConstant = EncryptionConstant != 0 ? EncryptionConstant : Util.Rand32(),
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
Version = OriginGame != 0 ? OriginGame : sav.Game,
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
Language = language,
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Ball = Ball,
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
Move1 = Move1,
Move2 = Move2,
Move3 = Move3,
Move4 = Move4,
RelearnMove1 = RelearnMove1,
RelearnMove2 = RelearnMove2,
RelearnMove3 = RelearnMove3,
RelearnMove4 = RelearnMove4,
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Met_Location = MetLocation,
Egg_Location = EggLocation,
AV_HP = AV_HP,
AV_ATK = AV_ATK,
AV_DEF = AV_DEF,
AV_SPE = AV_SPE,
AV_SPA = AV_SPA,
AV_SPD = AV_SPD,
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
OT_Name = isRedeemHT ? OT : sav.OT,
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
OT_Gender = OTGender != 3 ? OTGender % 2 : sav.Gender,
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
CurrentHandler = isRedeemHT ? 1 : 0,
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Sword/Shield Update
2019-11-16 01:34:18 +00:00
EXP = Experience.GetEXP(currentLevel, pi.EXPGrowth),
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
OT_Friendship = pi.BaseFriendship,
FatefulEncounter = true,
};
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
if (isRedeemHT)
{
pk.HT_Name = sav.OT;
pk.HT_Gender = sav.Gender;
}
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
pk.SetMaximumPPCurrent();
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
if ((sav.Generation > Generation && OriginGame == 0) || !CanBeReceivedByVersion(pk.Version))
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
// give random valid game
Update Random to be a bit more thread safe Random isn't thread safe; users of PKHeX.Core.dll might run multithreaded operations (see PKSM + ALM), so we need to have a thread-specific RNG available. Thread Local get; to improve performance, save the random object locally whenever it is used more than once in the method. https://docs.microsoft.com/en-us/dotnet/api/system.threading.threadlocal-1?redirectedfrom=MSDN&view=netframework-4.8 https://stackoverflow.com/questions/18333885/threadstatic-v-s-threadlocalt-is-generic-better-than-attribute/18337158#18337158
2020-01-26 05:49:52 +00:00
do { pk.Version = (int)GameVersion.GP + rnd.Next(2); }
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
while (!CanBeReceivedByVersion(pk.Version));
}
if (OTGender == 3)
{
Clean up some method signatures rename things to be a little more consistent in naming conventions
2020-06-17 02:46:22 +00:00
pk.TID = sav.TID;
pk.SID = sav.SID;
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
pk.MetDate = Date ?? DateTime.Now;
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
pk.IsNicknamed = GetIsNicknamed(redeemLanguage);
pk.Nickname = pk.IsNicknamed ? GetNickname(redeemLanguage) : SpeciesName.GetSpeciesNameGeneration(Species, pk.Language, Generation);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
SetPINGA(pk, criteria);
if (IsEgg)
SetEggMetData(pk);
pk.CurrentFriendship = pk.IsEgg ? pi.HatchCycles : pi.BaseFriendship;
Use actual primitive instead of int Some interfaces aren't needed to be exposed as int
2022-03-06 02:30:35 +00:00
pk.HeightScalar = (byte)rnd.Next(0x100);
pk.WeightScalar = (byte)rnd.Next(0x100);
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
pk.ResetCalculatedValues(); // cp & dimensions
pk.RefreshChecksum();
return pk;
}
private void SetEggMetData(PKM pk)
{
pk.IsEgg = true;
pk.EggMetDate = Date;
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
pk.Nickname = SpeciesName.GetSpeciesNameGeneration(0, pk.Language, Generation);
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
pk.IsNicknamed = true;
}
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
private void SetPINGA(PKM pk, EncounterCriteria criteria)
{
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
var pi = PersonalTable.GG.GetFormEntry(Species, Form);
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
pk.Nature = (int)criteria.GetNature((Nature)Nature);
pk.Gender = criteria.GetGender(Gender, pi);
Minor clean
2021-04-09 21:52:49 +00:00
var av = GetAbilityIndex(criteria);
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
pk.RefreshAbility(av);
SetPID(pk);
SetIVs(pk);
}
Minor clean
2021-04-09 21:52:49 +00:00
private int GetAbilityIndex(EncounterCriteria criteria) => AbilityType switch
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
{
Use more expression return style Reduces indentation & bracketing, a bit more concise
2021-01-02 01:08:49 +00:00
00 or 01 or 02 => AbilityType, // Fixed 0/1/2
Enumerate ability permissions in encounter templates, misc updates (#3368)
2022-01-09 06:34:04 +00:00
03 or 04 => criteria.GetAbilityFromNumber(Ability), // 0/1 or 0/1/H
ArgumentException -> ArgumentOutOfRangeException
2021-08-21 23:51:50 +00:00
_ => throw new ArgumentOutOfRangeException(nameof(AbilityType)),
Use more expression return style Reduces indentation & bracketing, a bit more concise
2021-01-02 01:08:49 +00:00
};
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Enumerate ability permissions in encounter templates, misc updates (#3368)
2022-01-09 06:34:04 +00:00
public override AbilityPermission Ability => AbilityType switch
Explicitly implement IFixedAbilityNumber on all templates
2021-12-09 08:46:59 +00:00
{
Enumerate ability permissions in encounter templates, misc updates (#3368)
2022-01-09 06:34:04 +00:00
0 => AbilityPermission.OnlyFirst,
1 => AbilityPermission.OnlySecond,
2 => AbilityPermission.OnlyHidden,
3 => AbilityPermission.Any12,
_ => AbilityPermission.Any12H,
Explicitly implement IFixedAbilityNumber on all templates
2021-12-09 08:46:59 +00:00
};
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
private void SetPID(PKM pk)
{
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
switch (PIDType)
{
Disassociate Shiny enum from WC6 PIDType (#3461) Have `Shiny.Random` be `0`, so we can skip init on this field for EncounterStatic. Plus makes it a little less brittle for future expansion if shiny qualities change.
2022-03-13 01:04:20 +00:00
case ShinyType6.FixedValue: // Specified
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
pk.PID = PID;
break;
Disassociate Shiny enum from WC6 PIDType (#3461) Have `Shiny.Random` be `0`, so we can skip init on this field for EncounterStatic. Plus makes it a little less brittle for future expansion if shiny qualities change.
2022-03-13 01:04:20 +00:00
case ShinyType6.Random: // Random
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
pk.PID = Util.Rand32();
break;
Disassociate Shiny enum from WC6 PIDType (#3461) Have `Shiny.Random` be `0`, so we can skip init on this field for EncounterStatic. Plus makes it a little less brittle for future expansion if shiny qualities change.
2022-03-13 01:04:20 +00:00
case ShinyType6.Always: // Random Shiny
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
pk.PID = Util.Rand32();
pk.PID = (uint)(((pk.TID ^ pk.SID ^ (pk.PID & 0xFFFF)) << 16) | (pk.PID & 0xFFFF));
break;
Disassociate Shiny enum from WC6 PIDType (#3461) Have `Shiny.Random` be `0`, so we can skip init on this field for EncounterStatic. Plus makes it a little less brittle for future expansion if shiny qualities change.
2022-03-13 01:04:20 +00:00
case ShinyType6.Never: // Random Nonshiny
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
pk.PID = Util.Rand32();
if (pk.IsShiny) pk.PID ^= 0x10000000;
break;
}
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
}
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
private void SetIVs(PKM pk)
{
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
Span<int> finalIVs = stackalloc int[6];
Stackalloc IVs for template->pkm fill
2022-03-14 02:24:08 +00:00
GetIVs(finalIVs);
var ivflag = finalIVs.Find(iv => (byte)(iv - 0xFC) < 3);
Update Random to be a bit more thread safe Random isn't thread safe; users of PKHeX.Core.dll might run multithreaded operations (see PKSM + ALM), so we need to have a thread-specific RNG available. Thread Local get; to improve performance, save the random object locally whenever it is used more than once in the method. https://docs.microsoft.com/en-us/dotnet/api/system.threading.threadlocal-1?redirectedfrom=MSDN&view=netframework-4.8 https://stackoverflow.com/questions/18333885/threadstatic-v-s-threadlocalt-is-generic-better-than-attribute/18337158#18337158
2020-01-26 05:49:52 +00:00
var rng = Util.Rand;
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
if (ivflag == 0) // Random IVs
{
Stackalloc IVs for template->pkm fill
2022-03-14 02:24:08 +00:00
for (int i = 0; i < finalIVs.Length; i++)
{
if (finalIVs[i] > 31)
finalIVs[i] = rng.Next(32);
}
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
}
else // 1/2/3 perfect IVs
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
{
Refactoring iencounterable->pkm SetPINGA{S}(pk, criteria) -> pid,iv, nature, gender, ability (stats future?) memes aside, this is where criteria data is forced Split N encounterstatic (has fixed PID and special flag) from EncounterStaticPID
2019-02-09 19:37:20 +00:00
int IVCount = ivflag - 0xFB;
Update Random to be a bit more thread safe Random isn't thread safe; users of PKHeX.Core.dll might run multithreaded operations (see PKSM + ALM), so we need to have a thread-specific RNG available. Thread Local get; to improve performance, save the random object locally whenever it is used more than once in the method. https://docs.microsoft.com/en-us/dotnet/api/system.threading.threadlocal-1?redirectedfrom=MSDN&view=netframework-4.8 https://stackoverflow.com/questions/18333885/threadstatic-v-s-threadlocalt-is-generic-better-than-attribute/18337158#18337158
2020-01-26 05:49:52 +00:00
do { finalIVs[rng.Next(6)] = 31; }
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
while (finalIVs.Count(31) < IVCount);
Stackalloc IVs for template->pkm fill
2022-03-14 02:24:08 +00:00
for (int i = 0; i < finalIVs.Length; i++)
{
if (finalIVs[i] != 31)
finalIVs[i] = rng.Next(32);
}
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
Refactoring: Span-based value writes and method signatures (#3361) Existing `get`/`set` logic is flawed in that it doesn't work on Big Endian operating systems, and it allocates heap objects when it doesn't need to. `System.Buffers.Binary.BinaryPrimitives` in the `System.Memory` NuGet package provides both Little Endian and Big Endian methods to read and write data; all the `get`/`set` operations have been reworked to use this new API. This removes the need for PKHeX's manual `BigEndian` class, as all functions are already covered by the BinaryPrimitives API. The `StringConverter` has now been rewritten to accept a Span to read from & write to, no longer requiring a temporary StringBuilder. Other Fixes included: - The Super Training UI for Gen6 has been reworked according to the latest block structure additions. - Cloning a Stadium2 Save File now works correctly (opening from the Folder browser list). - Checksum & Sanity properties removed from parent PKM class, and is now implemented via interface.
2022-01-03 05:35:59 +00:00
pk.SetIVs(finalIVs);
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
public bool CanHaveLanguage(int language)
{
if (language is < (int) LanguageID.Japanese or > (int) LanguageID.ChineseT)
return false;
if (CanBeAnyLanguage())
return true;
Update WB7.cs
2021-02-02 02:39:34 +00:00
return Array.IndexOf(Data, (byte)language, 0x1D8, 9) >= 0;
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
}
public bool CanBeAnyLanguage()
{
for (int i = 0; i < 9; i++)
{
if (Data[0x1D8 + i] != 0)
return false;
}
return true;
}
Add more nickname logic checks Variant nicklang OT can nickname if it's the handler
2021-02-03 06:12:36 +00:00
public bool CanHandleOT(int language) => string.IsNullOrEmpty(GetOT(language));
Eliminate boxing on encounter search (criteria) struct implementing interface is boxed when passed to method that accepts interface (not generic method). Removes IDexLevel (no other inheritors but EvoCriteria) and uses the primitive the data is stored (array, not IReadOnlyList) for slightly better perf.
2022-05-08 01:29:36 +00:00
public override bool IsMatchExact(PKM pkm, EvoCriteria evo)
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
{
HOME 2.0.0: Handle conversion behavior & restrictions (#3506) * Revises legality checks to account for traveling between the three game islands (PLA/BDSP/SWSH) * Adds conversion mechanisms between the three formats, as well as flexible conversion options to backfill missing data (thanks GameFreak/ILCA for opting for lossy conversion instead of updating the games). * Adds API abstractions for HOME data storage format (EKH/PKH format 1, aka EH1/PH1). * Revises some APIs for better usage: - `PKM` now exposes a `Context` to indicate the isolation context for legality purposes. - Some method signatures have changed to accept `Context` or `GameVersion` instead of a vague `int` for Generation. - Evolution History is now tracked in the Legality parse for specific contexts, rather than only per generation.
2022-05-31 04:43:52 +00:00
if (!IsEgg)
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
{
if (OTGender != 3)
{
if (SID != pkm.SID) return false;
if (TID != pkm.TID) return false;
if (OTGender != pkm.OT_Gender) return false;
}
var OT = GetOT(pkm.Language);
if (!string.IsNullOrEmpty(OT) && OT != pkm.OT_Name) return false;
if (OriginGame != 0 && OriginGame != pkm.Version) return false;
if (EncryptionConstant != 0 && EncryptionConstant != pkm.EncryptionConstant) return false;
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
HOME 2.0.0: Handle conversion behavior & restrictions (#3506) * Revises legality checks to account for traveling between the three game islands (PLA/BDSP/SWSH) * Adds conversion mechanisms between the three formats, as well as flexible conversion options to backfill missing data (thanks GameFreak/ILCA for opting for lossy conversion instead of updating the games). * Adds API abstractions for HOME data storage format (EKH/PKH format 1, aka EH1/PH1). * Revises some APIs for better usage: - `PKM` now exposes a `Context` to indicate the isolation context for legality purposes. - Some method signatures have changed to accept `Context` or `GameVersion` instead of a vague `int` for Generation. - Evolution History is now tracked in the Legality parse for specific contexts, rather than only per generation.
2022-05-31 04:43:52 +00:00
if (!IsMatchEggLocation(pkm)) return false;
Improve handling of multi-nicknamed mystery gifts
2021-02-02 02:35:37 +00:00
if (!CanBeAnyLanguage() && !CanHaveLanguage(pkm.Language))
return false;
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
}
Unify concepts with different names AltForm & Form & Forme => Form GenNumber & Generation => Generation Extract out SpeciesForm interface, and re-add IGeneration For those using PKHeX as a dependency, this should be a pretty straightforward manual replacement... GenNumber and AltForm should be quick find-replace`s.
2020-12-11 04:42:30 +00:00
if (Form != evo.Form && !FormInfo.IsFormChangeable(Species, Form, pkm.Form, pkm.Format))
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
return false;
if (IsEgg)
{
if (EggLocation != pkm.Egg_Location) // traded
{
Extract most common location numbers to class
2019-05-11 03:46:49 +00:00
if (pkm.Egg_Location != Locations.LinkTrade6)
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
return false;
}
else if (PIDType == 0 && pkm.IsShiny)
{
return false; // can't be traded away for unshiny
}
if (pkm.IsEgg && !pkm.IsNative)
return false;
}
else
{
Disassociate Shiny enum from WC6 PIDType (#3461) Have `Shiny.Random` be `0`, so we can skip init on this field for EncounterStatic. Plus makes it a little less brittle for future expansion if shiny qualities change.
2022-03-13 01:04:20 +00:00
if (!Shiny.IsValid(pkm)) return false;
HOME 2.0.0: Handle conversion behavior & restrictions (#3506) * Revises legality checks to account for traveling between the three game islands (PLA/BDSP/SWSH) * Adds conversion mechanisms between the three formats, as well as flexible conversion options to backfill missing data (thanks GameFreak/ILCA for opting for lossy conversion instead of updating the games). * Adds API abstractions for HOME data storage format (EKH/PKH format 1, aka EH1/PH1). * Revises some APIs for better usage: - `PKM` now exposes a `Context` to indicate the isolation context for legality purposes. - Some method signatures have changed to accept `Context` or `GameVersion` instead of a vague `int` for Generation. - Evolution History is now tracked in the Legality parse for specific contexts, rather than only per generation.
2022-05-31 04:43:52 +00:00
if (!IsMatchEggLocation(pkm)) return false;
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
if (MetLocation != pkm.Met_Location) return false;
}
if (MetLevel != pkm.Met_Level) return false;
if (Ball != pkm.Ball) return false;
if (OTGender < 3 && OTGender != pkm.OT_Gender) return false;
Sword/Shield Update
2019-11-16 01:34:18 +00:00
if (Nature != -1 && pkm.Nature != Nature) return false;
Move encounter matching logic to iencounterable generator logic is now clean
2018-12-27 09:00:08 +00:00
if (Gender != 3 && Gender != pkm.Gender) return false;
if (pkm is IAwakened s && s.IsAwakeningBelow(this))
return false;
return true;
}
Fix deferral compare neq -> defer not like it matters for these
2021-03-21 00:47:31 +00:00
protected override bool IsMatchDeferred(PKM pkm) => Species != pkm.Species;
Fracture the encounter matching checks to allow progressive validation (#3137) ## Issue We want to discard-but-remember any slots that aren't a perfect fit, on the off chance that a better one exists later in the search space. If there's no better match, then we gotta go with what we got. ## Example: Wurmple exists in area `X`, and also has a more rare slot for Silcoon, with the same level for both slots. * We have a Silcoon that we've leveled up a few times. Was our Silcoon originally a Wurmple, or was it caught as a Silcoon? * To be sure, we have to check the EC/PID if the Wurmple wouldn't evolve into Cascoon instead. * We don't want to wholly reject that Wurmple slot, as maybe the Met Level isn't within Silcoon's slot range. --- Existing implementation would store "deferred" matches in a list; we only need to keep 1 of these matches around (less allocation!). We also want to differentiate between a "good" deferral and a "bad" deferral; I don't think this is necessary but it's currently used by Mystery Gift matching (implemented for the Eeveelution mystery gifts which matter for evolution moves). The existing logic didn't use inheritance, and instead had static methods being reused across generations. Quite kludgy. Also, the existing logic was a pain to modify the master encounter yield methods, as one generation's quirks had to not impact all other generations that used the method. --- The new implementation splits out the encounter yielding methods to be separate for each generation / subset. Now, things don't have to check `WasLink` for Gen7 origin, because Pokémon Link wasn't a thing in Gen7. --- ## Future Maybe refactoring yielders into "GameCores" that expose yielding behaviors / properties, rather than the static logic. As more generations and side-gamegroups get added (thanks LGPE/GO/GameCube), all this switch stuff gets annoying to maintain instead of just overriding/inheritance. ## Conclusion This shouldn't impact any legality results negatively; if you notice any regressions, report them! This should reduce false flags where we didn't defer-discard an encounter when we should have (wild area mons being confused with raids).
2021-01-30 01:55:27 +00:00
protected override bool IsMatchPartial(PKM pkm) => false;
Add WB7 and legality detection logic Derived from WC7 with minor alterations (dynamic OT/Nickname which is stored in the Full data). Since the 0x108 is not stored in the save file, just keep the full data around.
2018-11-21 20:24:41 +00:00
}
}
Reference in a new issue Copy permalink