PKHeX/PKHeX.Core/PersonalInfo/PersonalInfoSM.cs

using System;
using static System.Buffers.Binary.BinaryPrimitives;

namespace PKHeX.Core
{
    /// <summary>
    /// <see cref="PersonalInfo"/> class with values from the Sun &amp; Moon games.
    /// </summary>
    public class PersonalInfoSM : PersonalInfoXY
    {
        public new const int SIZE = 0x54;

        public PersonalInfoSM(byte[] data) : base(data)
        {
            TMHM = GetBits(Data.AsSpan(0x28, 0x10)); // 36-39
            TypeTutors = GetBits(Data.AsSpan(0x38, 0x4)); // 40

            SpecialTutors = new[]
            {
                GetBits(Data.AsSpan(0x3C, 0x0A)),
            };
        }

        public override byte[] Write()
        {
            SetBits(TMHM, Data.AsSpan(0x28));
            SetBits(TypeTutors, Data.AsSpan(0x38));
            SetBits(SpecialTutors[0], Data.AsSpan(0x3C));
            return Data;
        }

        public int SpecialZ_Item { get => ReadUInt16LittleEndian(Data.AsSpan(0x4C)); set => WriteUInt16LittleEndian(Data.AsSpan(0x4C), (ushort)value); }
        public int SpecialZ_BaseMove { get => ReadUInt16LittleEndian(Data.AsSpan(0x4E)); set => WriteUInt16LittleEndian(Data.AsSpan(0x4E), (ushort)value); }
        public int SpecialZ_ZMove { get => ReadUInt16LittleEndian(Data.AsSpan(0x50)); set => WriteUInt16LittleEndian(Data.AsSpan(0x50), (ushort)value); }
        public bool LocalVariant { get => Data[0x52] == 1; set => Data[0x52] = value ? (byte)1 : (byte)0; }
    }
}
-												Add more S&M support

Pokedex flag setting added, no forme setting for now.

											
										
										
											2016-10-23 03:09:22 +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;
-												Add more S&M support

Pokedex flag setting added, no forme setting for now.

											
										
										
											2016-10-23 03:09:22 +00:00
-												Split winforms to separate project

resources still are associated with winforms, eh
program still runs fine and I've replicated the mono build options. lmk
if this breaks stuff

											
										
										
											2017-01-08 07:54:09 +00:00
+								namespace PKHeX.Core
-												Initial Sun/Moon Support

Loads the save file, still not finished.

											
										
										
											2016-10-20 01:19:01 +00:00
+								{
-												add more pkhex.core xml documentation

adds a bunch of documentation useful for those unfamiliar with the core
library

											
										
										
											2017-10-24 06:12:58 +00:00
+								    /// <summary>
-												Misc clean / xmldoc updates

remove unused label in QR (use window Font)
escape & -> &amp; for xmldoc proper style

											
										
										
											2018-07-22 02:20:11 +00:00
+								    /// <see cref="PersonalInfo"/> class with values from the Sun &amp; Moon games.
-												add more pkhex.core xml documentation

adds a bunch of documentation useful for those unfamiliar with the core
library

											
										
										
											2017-10-24 06:12:58 +00:00
+								    /// </summary>
-												Initial Sun/Moon Support

Loads the save file, still not finished.

											
										
										
											2016-10-20 01:19:01 +00:00
+								    public class PersonalInfoSM : PersonalInfoXY
 								    {
 								        public new const int SIZE = 0x54;
-												Respacening

Style guidelines, handle a bunch of files
no functional change

											
										
										
											2018-07-27 02:34:27 +00:00
-												PKHeX.Core Nullable cleanup (#2401)

* Handle some nullable cases

Refactor MysteryGift into a second abstract class (backed by a byte array, or fake data)
Make some classes have explicit constructors instead of { } initialization

* Handle bits more obviously without null

* Make SaveFile.BAK explicitly readonly again

* merge constructor methods to have readonly fields

* Inline some properties

* More nullable handling

* Rearrange box actions

define straightforward classes to not have any null properties

* Make extrabyte reference array immutable

* Move tooltip creation to designer

* Rearrange some logic to reduce nesting

* Cache generated fonts
* Split mystery gift album purpose
* Handle more tooltips
* Disallow null setters
* Don't capture RNG object, only type enum

* Unify learnset objects
Now have readonly properties which are never null
don't new() empty learnsets (>800 Learnset objects no longer created,
total of 2400 objects since we also new() a move & level array)
optimize g1/2 reader for early abort case

* Access rewrite
Initialize blocks in a separate object, and get via that object
removes a couple hundred "might be null" warnings since blocks are now readonly getters
some block references have been relocated, but interfaces should expose all that's needed
put HoF6 controls in a groupbox, and disable

* Readonly personal data
* IVs non nullable for mystery gift
* Explicitly initialize forced encounter moves
* Make shadow objects readonly & non-null
Put murkrow fix in binary data resource, instead of on startup
* Assign dex form fetch on constructor
Fixes legality parsing edge cases
also handle cxd parse for valid; exit before exception is thrown in FrameGenerator

* Remove unnecessary null checks
* Keep empty value until init
SetPouch sets the value to an actual one during load, but whatever

* Readonly team lock data
* Readonly locks
Put locked encounters at bottom (favor unlocked)

* Mail readonly data / offset
Rearrange some call flow and pass defaults
Add fake classes for SaveDataEditor mocking
Always party size, no need to check twice in stat editor
use a fake save file as initial data for savedata editor, and for
gamedata (wow i found a usage)
constrain eventwork editor to struct variable types (uint, int, etc),
thus preventing null assignment errors
											
										
										
											2019-10-17 01:47:31 +00:00
+								        public PersonalInfoSM(byte[] data) : base(data)
-												Initial Sun/Moon Support

Loads the save file, still not finished.

											
										
										
											2016-10-20 01:19:01 +00:00
+								        {
-												Make bitflag get/set span-based

no temp array on write (unused in pkhex anyways)
no length checking on read

											
										
										
											2021-10-09 00:48:34 +00:00
+								            TMHM = GetBits(Data.AsSpan(0x28, 0x10)); // 36-39
 								            TypeTutors = GetBits(Data.AsSpan(0x38, 0x4)); // 40
-												Add usum special tutor bitflags

( ͡° ͜ʖ ͡°)

											
										
										
											2017-10-25 02:59:46 +00:00
 								            SpecialTutors = new[]
 								            {
-												Make bitflag get/set span-based

no temp array on write (unused in pkhex anyways)
no length checking on read

											
										
										
											2021-10-09 00:48:34 +00:00
+								                GetBits(Data.AsSpan(0x3C, 0x0A)),
-												Add usum special tutor bitflags

( ͡° ͜ʖ ͡°)

											
										
										
											2017-10-25 02:59:46 +00:00
+								            };
-												Initial Sun/Moon Support

Loads the save file, still not finished.

											
										
										
											2016-10-20 01:19:01 +00:00
+								        }
-												Respacening

Style guidelines, handle a bunch of files
no functional change

											
										
										
											2018-07-27 02:34:27 +00:00
-												Initial Sun/Moon Support

Loads the save file, still not finished.

											
										
										
											2016-10-20 01:19:01 +00:00
+								        public override byte[] Write()
 								        {
-												Make bitflag get/set span-based

no temp array on write (unused in pkhex anyways)
no length checking on read

											
										
										
											2021-10-09 00:48:34 +00:00
+								            SetBits(TMHM, Data.AsSpan(0x28));
 								            SetBits(TypeTutors, Data.AsSpan(0x38));
 								            SetBits(SpecialTutors[0], Data.AsSpan(0x3C));
-												Initial Sun/Moon Support

Loads the save file, still not finished.

											
										
										
											2016-10-20 01:19:01 +00:00
+								            return Data;
 								        }
-												Add more S&M support

Pokedex flag setting added, no forme setting for now.

											
										
										
											2016-10-23 03:09:22 +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 SpecialZ_Item { get => ReadUInt16LittleEndian(Data.AsSpan(0x4C)); set => WriteUInt16LittleEndian(Data.AsSpan(0x4C), (ushort)value); }
 								        public int SpecialZ_BaseMove { get => ReadUInt16LittleEndian(Data.AsSpan(0x4E)); set => WriteUInt16LittleEndian(Data.AsSpan(0x4E), (ushort)value); }
 								        public int SpecialZ_ZMove { get => ReadUInt16LittleEndian(Data.AsSpan(0x50)); set => WriteUInt16LittleEndian(Data.AsSpan(0x50), (ushort)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 bool LocalVariant { get => Data[0x52] == 1; set => Data[0x52] = value ? (byte)1 : (byte)0; }
-												Initial Sun/Moon Support

Loads the save file, still not finished.

											
										
										
											2016-10-20 01:19:01 +00:00
+								    }
 								}