Mirrors/PKHeX
2
0
Fork 0
mirror of https://github.com/kwsch/PKHeX synced 2024-12-18 16:33:24 +00:00
Code Issues Projects Releases Packages Wiki Activity
PKHeX/PKHeX.Core/Saves/Substructures/Mail/Mail5.cs

61 lines
2.9 KiB
C#
Raw Normal View History

fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
using System;
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;
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
namespace PKHeX.Core
{
sealed sealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealedsealed
2019-10-04 02:09:02 +00:00
public sealed class Mail5 : Mail
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +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 const int SIZE = 0x38;
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +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 Mail5(byte[] data, int ofs = -1) : base(data, ofs) { }
Style updates split pcd/pgt add more xmldoc
2018-08-10 04:53:39 +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 Mail5(byte? lang, byte? ver) : base(new byte[SIZE])
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
{
Misc tweaks RNG frame mismatch -> fishy (for now) fix xmldoc copypaste clean up some resharper warnings
2017-12-05 00:26:26 +00:00
if (lang != null) AuthorLanguage = (byte)lang;
if (ver != null) AuthorVersion = (byte)ver;
ResetData();
}
Style updates split pcd/pgt add more xmldoc
2018-08-10 04:53:39 +00:00
Misc tweaks RNG frame mismatch -> fishy (for now) fix xmldoc copypaste clean up some resharper warnings
2017-12-05 00:26:26 +00:00
private void ResetData()
{
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
AuthorTID = 0;
AuthorSID = 0;
AuthorGender = 0;
MailType = 0xFF;
"" -> string.Empty be explicit that the string is empty rather than possibly missing disallow encrypted export for BK4 (they're not encrypted), removes type check simplify replaceall in showdownset (don't call ReplaceAll 4x, just get valid chars and rebuild) simplify get ribbon sprite name (precompute ToLower and appended values
2019-02-08 05:40:20 +00:00
AuthorName = string.Empty;
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
for (int i = 0; i < 3; i++)
SetMisc(i, 0);
MessageEnding = 0xFFFF;
for (int y = 0; y < 3; y++)
Style updates split pcd/pgt add more xmldoc
2018-08-10 04:53:39 +00:00
{
for (int x = 0; x < 4; x++)
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
SetMessage(y, x, x == 1 ? (ushort)0 : (ushort)0xFFFF);
Style updates split pcd/pgt add more xmldoc
2018-08-10 04:53:39 +00:00
}
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
}
Style updates split pcd/pgt add more xmldoc
2018-08-10 04:53:39 +00:00
Minor refactoring Change Ability array to IReadOnlyList, add method to check ability index in personal data Suppress some message warnings Change EvolutionChain short-circuit for VC to jump from gen6 directly down to gen2. There aren't any notradeback 1 situations, so a notradeback1 will always start with g=1, so no need for the other if-continue. Simplify pk5 conversion
2020-09-06 17:53:13 +00:00
public override void CopyTo(PK5 pk5) => pk5.SetHeldMailData(Data);
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 ushort AuthorTID { get => ReadUInt16LittleEndian(Data.AsSpan(0)); set => WriteUInt16LittleEndian(Data.AsSpan(0), value); }
public override ushort AuthorSID { get => ReadUInt16LittleEndian(Data.AsSpan(2)); set => WriteUInt16LittleEndian(Data.AsSpan(2), value); }
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
public override byte AuthorGender { get => Data[4]; set => Data[4] = value; }
update MailBoxEditor (#2344) fixed FRLG offset, etc.
2019-07-05 04:48:18 +00:00
public override byte AuthorLanguage { get => Data[5]; set => Data[5] = value; }
public override byte AuthorVersion { get => Data[6]; set => Data[6] = value; }
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
public override int MailType { get => Data[7]; set => Data[7] = (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 string AuthorName { get => StringConverter5.GetString(Data.AsSpan(8, 0x10)); set => StringConverter5.SetString(Data.AsSpan(8, 0x10), value.AsSpan(), 7, StringConverterOption.ClearZero); }
public int GetMisc(int index) => ReadUInt16LittleEndian(Data.AsSpan(0x1C - (index * 2)));
public void SetMisc(int index, int value) => WriteUInt16LittleEndian(Data.AsSpan(0x1C - (index * 2)), (ushort)value);
public ushort MessageEnding { get => ReadUInt16LittleEndian(Data.AsSpan(0x1E)); set => WriteUInt16LittleEndian(Data.AsSpan(0x1E), value); }
public override ushort GetMessage(int index1, int index2) => ReadUInt16LittleEndian(Data.AsSpan(0x20 + (((index1 * 4) + index2) * 2)));
public override void SetMessage(int index1, int index2, ushort value) => WriteUInt16LittleEndian(Data.AsSpan(0x20 + (((index1 * 4) + index2) * 2)), value);
Style updates split pcd/pgt add more xmldoc
2018-08-10 04:53:39 +00:00
Minor clean Annotations (nullable), some switch cases for readability
2021-03-14 23:16:55 +00:00
public override bool? IsEmpty => MailType switch
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
{
Minor clean Annotations (nullable), some switch cases for readability
2021-03-14 23:16:55 +00:00
0xFF => true,
<= 11 => false,
Trailing commas No functional change
2021-08-20 20:49:20 +00:00
_ => null,
Minor clean Annotations (nullable), some switch cases for readability
2021-03-14 23:16:55 +00:00
};
Style updates split pcd/pgt add more xmldoc
2018-08-10 04:53:39 +00:00
Misc tweaks RNG frame mismatch -> fishy (for now) fix xmldoc copypaste clean up some resharper warnings
2017-12-05 00:26:26 +00:00
public override void SetBlank() => SetBlank(null, null);
public void SetBlank(byte? lang, byte? ver) => new Mail5(lang: lang, ver: ver).Data.CopyTo(Data, 0);
fix MailBoxEditor add Mail5, almost same as Mail4.
2017-12-03 14:48:04 +00:00
}
}
Reference in a new issue Copy permalink