2
0
Fork 0
mirror of https://github.com/kwsch/PKHeX synced 2024-12-24 11:23:11 +00:00
PKHeX/PKHeX.Core/PKM/CK3.cs
Kurt 88830e0d00
Update from .NET Framework 4.6 to .NET 7 ()
Updates from net46->net7, dropping support for mono in favor of using the latest runtime (along with the performance/API improvements). Releases will be posted as 64bit only for now.

Refactors a good amount of internal API methods to be more performant and more customizable for future updates & fixes.

Adds functionality for Batch Editor commands to `>`, `<` and <=/>=

TID/SID properties renamed to TID16/SID16 for clarity; other properties exposed for Gen7 / display variants.

Main window has a new layout to account for DPI scaling (8 point grid)

Fixed: Tatsugiri and Paldean Tauros now output Showdown form names as Showdown expects
Changed: Gen9 species now interact based on the confirmed National Dex IDs (closes )
Fixed: Pokedex set all no longer clears species with unavailable non-base forms (closes )
Changed: Hyper Training suggestions now apply for level 50 in SV. (closes )
Fixed: B2/W2 hatched egg met locations exclusive to specific versions are now explicitly checked (closes )
Added: Properties for ribbon/mark count (closes )
Fixed: Traded SV eggs are now checked correctly (closes )
2023-01-21 20:02:33 -08:00

201 lines
14 KiB
C#

using System;
using System.Collections.Generic;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core;
/// <summary> Generation 3 <see cref="PKM"/> format, exclusively for Pokémon Colosseum. </summary>
public sealed class CK3 : G3PKM, IShadowCapture
{
private static readonly ushort[] Unused =
{
0x11, 0x12, 0x13,
0x61, 0x62, 0x63, 0x64,
0xD1, 0xD2, 0xD3, 0xD4, 0xD5, 0xDA, 0xDB,
0xE4, 0xE5, 0xE6, 0xE7, 0xCE,
0xFB, // not fateful -- what is it?
0xD7, // index within party
// 0xFC onwards unused? no, it's some pointers and values used by the game?
};
public override IReadOnlyList<ushort> ExtraBytes => Unused;
public override int SIZE_PARTY => PokeCrypto.SIZE_3CSTORED;
public override int SIZE_STORED => PokeCrypto.SIZE_3CSTORED;
public override EntityContext Context => EntityContext.Gen3;
public override PersonalInfo3 PersonalInfo => PersonalTable.RS[Species];
public CK3(byte[] data) : base(data) { }
public CK3() : this(new byte[PokeCrypto.SIZE_3CSTORED]) { }
public override CK3 Clone() => new((byte[])Data.Clone());
// Trash Bytes
public override Span<byte> OT_Trash => Data.AsSpan(0x18, 22);
public override Span<byte> Nickname_Trash => Data.AsSpan(0x2E, 22);
public Span<byte> NicknameCopy_Trash => Data.AsSpan(0x44, 22);
// Future Attributes
public override ushort SpeciesInternal { get => ReadUInt16BigEndian(Data.AsSpan(0x00)); set => WriteUInt16BigEndian(Data.AsSpan(0x00), value); } // raw access
public override ushort Species { get => SpeciesConverter.GetNational3(SpeciesInternal); set => SpeciesInternal = SpeciesConverter.GetInternal3(value); }
// 02-04 unused
public override uint PID { get => ReadUInt32BigEndian(Data.AsSpan(0x04)); set => WriteUInt32BigEndian(Data.AsSpan(0x04), value); }
public override int Version { get => GetGBAVersionID(Data[0x08]); set => Data[0x08] = GetGCVersionID(value); }
public int CurrentRegion { get => Data[0x09]; set => Data[0x09] = (byte)value; }
public int OriginalRegion { get => Data[0x0A]; set => Data[0x0A] = (byte)value; }
public override int Language { get => Core.Language.GetMainLangIDfromGC(Data[0x0B]); set => Data[0x0B] = Core.Language.GetGCLangIDfromMain((byte)value); }
public override int Met_Location { get => ReadUInt16BigEndian(Data.AsSpan(0x0C)); set => WriteUInt16BigEndian(Data.AsSpan(0x0C), (ushort)value); }
public override int Met_Level { get => Data[0x0E]; set => Data[0x0E] = (byte)value; }
public override int Ball { get => Data[0x0F]; set => Data[0x0F] = (byte)value; }
public override int OT_Gender { get => Data[0x10]; set => Data[0x10] = (byte)value; }
public override uint ID32 { get => ReadUInt32BigEndian(Data.AsSpan(0x14)); set => WriteUInt32BigEndian(Data.AsSpan(0x14), value); }
public override ushort SID16 { get => ReadUInt16BigEndian(Data.AsSpan(0x14)); set => WriteUInt16BigEndian(Data.AsSpan(0x14), value); }
public override ushort TID16 { get => ReadUInt16BigEndian(Data.AsSpan(0x16)); set => WriteUInt16BigEndian(Data.AsSpan(0x16), value); }
public override string OT_Name { get => StringConverter3GC.GetString(OT_Trash); set => StringConverter3GC.SetString(OT_Trash, value, 10, StringConverterOption.None); }
public override string Nickname { get => StringConverter3GC.GetString(Nickname_Trash); set { StringConverter3GC.SetString(Nickname_Trash, value, 10, StringConverterOption.None); NicknameCopy = value; } }
public string NicknameCopy { get => StringConverter3GC.GetString(NicknameCopy_Trash); set => StringConverter3GC.SetString(NicknameCopy_Trash, value, 10, StringConverterOption.None); }
public override uint EXP { get => ReadUInt32BigEndian(Data.AsSpan(0x5C)); set => WriteUInt32BigEndian(Data.AsSpan(0x5C), value); }
public override int Stat_Level { get => Data[0x60]; set => Data[0x60] = (byte)value; }
// 0x64-0x77 are battle/status related
public override int Status_Condition { get; set; } // where are we
// Not that the program cares
// Moves
public override ushort Move1 { get => ReadUInt16BigEndian(Data.AsSpan(0x78)); set => WriteUInt16BigEndian(Data.AsSpan(0x78), value); }
public override int Move1_PP { get => Data[0x7A]; set => Data[0x7A] = (byte)value; }
public override int Move1_PPUps { get => Data[0x7B]; set => Data[0x7B] = (byte)value; }
public override ushort Move2 { get => ReadUInt16BigEndian(Data.AsSpan(0x7C)); set => WriteUInt16BigEndian(Data.AsSpan(0x7C), value); }
public override int Move2_PP { get => Data[0x7E]; set => Data[0x7E] = (byte)value; }
public override int Move2_PPUps { get => Data[0x7F]; set => Data[0x7F] = (byte)value; }
public override ushort Move3 { get => ReadUInt16BigEndian(Data.AsSpan(0x80)); set => WriteUInt16BigEndian(Data.AsSpan(0x80), value); }
public override int Move3_PP { get => Data[0x82]; set => Data[0x82] = (byte)value; }
public override int Move3_PPUps { get => Data[0x83]; set => Data[0x83] = (byte)value; }
public override ushort Move4 { get => ReadUInt16BigEndian(Data.AsSpan(0x84)); set => WriteUInt16BigEndian(Data.AsSpan(0x84), value); }
public override int Move4_PP { get => Data[0x86]; set => Data[0x86] = (byte)value; }
public override int Move4_PPUps { get => Data[0x87]; set => Data[0x87] = (byte)value; }
public override int SpriteItem => ItemConverter.GetItemFuture3((ushort)HeldItem);
public override int HeldItem { get => ReadUInt16BigEndian(Data.AsSpan(0x88)); set => WriteUInt16BigEndian(Data.AsSpan(0x88), (ushort)value); }
// More party stats
public override int Stat_HPCurrent { get => ReadUInt16BigEndian(Data.AsSpan(0x8A)); set => WriteUInt16BigEndian(Data.AsSpan(0x8A), (ushort)value); }
public override int Stat_HPMax { get => ReadUInt16BigEndian(Data.AsSpan(0x8C)); set => WriteUInt16BigEndian(Data.AsSpan(0x8C), (ushort)value); }
public override int Stat_ATK { get => ReadUInt16BigEndian(Data.AsSpan(0x8E)); set => WriteUInt16BigEndian(Data.AsSpan(0x8E), (ushort)value); }
public override int Stat_DEF { get => ReadUInt16BigEndian(Data.AsSpan(0x90)); set => WriteUInt16BigEndian(Data.AsSpan(0x90), (ushort)value); }
public override int Stat_SPA { get => ReadUInt16BigEndian(Data.AsSpan(0x92)); set => WriteUInt16BigEndian(Data.AsSpan(0x92), (ushort)value); }
public override int Stat_SPD { get => ReadUInt16BigEndian(Data.AsSpan(0x94)); set => WriteUInt16BigEndian(Data.AsSpan(0x94), (ushort)value); }
public override int Stat_SPE { get => ReadUInt16BigEndian(Data.AsSpan(0x96)); set => WriteUInt16BigEndian(Data.AsSpan(0x96), (ushort)value); }
// EVs
public override int EV_HP {
get => Math.Min(byte.MaxValue, ReadUInt16BigEndian(Data.AsSpan(0x98)));
set => WriteUInt16BigEndian(Data.AsSpan(0x98), (ushort)(value & 0xFF)); }
public override int EV_ATK {
get => Math.Min(byte.MaxValue, ReadUInt16BigEndian(Data.AsSpan(0x9A)));
set => WriteUInt16BigEndian(Data.AsSpan(0x9A), (ushort)(value & 0xFF)); }
public override int EV_DEF {
get => Math.Min(byte.MaxValue, ReadUInt16BigEndian(Data.AsSpan(0x9C)));
set => WriteUInt16BigEndian(Data.AsSpan(0x9C), (ushort)(value & 0xFF)); }
public override int EV_SPA {
get => Math.Min(byte.MaxValue, ReadUInt16BigEndian(Data.AsSpan(0x9E)));
set => WriteUInt16BigEndian(Data.AsSpan(0x9E), (ushort)(value & 0xFF)); }
public override int EV_SPD {
get => Math.Min(byte.MaxValue, ReadUInt16BigEndian(Data.AsSpan(0xA0)));
set => WriteUInt16BigEndian(Data.AsSpan(0xA0), (ushort)(value & 0xFF)); }
public override int EV_SPE {
get => Math.Min(byte.MaxValue, ReadUInt16BigEndian(Data.AsSpan(0xA2)));
set => WriteUInt16BigEndian(Data.AsSpan(0xA2), (ushort)(value & 0xFF)); }
// IVs
public override int IV_HP {
get => Math.Min((ushort)31, ReadUInt16BigEndian(Data.AsSpan(0xA4)));
set => WriteUInt16BigEndian(Data.AsSpan(0xA4), (ushort)(value & 0x1F)); }
public override int IV_ATK {
get => Math.Min((ushort)31, ReadUInt16BigEndian(Data.AsSpan(0xA6)));
set => WriteUInt16BigEndian(Data.AsSpan(0xA6), (ushort)(value & 0x1F)); }
public override int IV_DEF {
get => Math.Min((ushort)31, ReadUInt16BigEndian(Data.AsSpan(0xA8)));
set => WriteUInt16BigEndian(Data.AsSpan(0xA8), (ushort)(value & 0x1F)); }
public override int IV_SPA {
get => Math.Min((ushort)31, ReadUInt16BigEndian(Data.AsSpan(0xAA)));
set => WriteUInt16BigEndian(Data.AsSpan(0xAA), (ushort)(value & 0x1F)); }
public override int IV_SPD {
get => Math.Min((ushort)31, ReadUInt16BigEndian(Data.AsSpan(0xAC)));
set => WriteUInt16BigEndian(Data.AsSpan(0xAC), (ushort)(value & 0x1F)); }
public override int IV_SPE {
get => Math.Min((ushort)31, ReadUInt16BigEndian(Data.AsSpan(0xAE)));
set => WriteUInt16BigEndian(Data.AsSpan(0xAE), (ushort)(value & 0x1F)); }
public override int OT_Friendship {
get => Math.Min((ushort)0xFF, ReadUInt16BigEndian(Data.AsSpan(0xB0)));
set => WriteUInt16BigEndian(Data.AsSpan(0xB0), (ushort)(value & 0xFF));
}
// Contest
public override byte CNT_Cool { get => Data[0xB2]; set => Data[0xB2] = value; }
public override byte CNT_Beauty { get => Data[0xB3]; set => Data[0xB3] = value; }
public override byte CNT_Cute { get => Data[0xB4]; set => Data[0xB4] = value; }
public override byte CNT_Smart { get => Data[0xB5]; set => Data[0xB5] = value; }
public override byte CNT_Tough { get => Data[0xB6]; set => Data[0xB6] = value; }
public override byte RibbonCountG3Cool { get => Data[0xB7]; set => Data[0xB7] = value; }
public override byte RibbonCountG3Beauty { get => Data[0xB8]; set => Data[0xB8] = value; }
public override byte RibbonCountG3Cute { get => Data[0xB9]; set => Data[0xB9] = value; }
public override byte RibbonCountG3Smart { get => Data[0xBA]; set => Data[0xBA] = value; }
public override byte RibbonCountG3Tough { get => Data[0xBB]; set => Data[0xBB] = value; }
public override byte CNT_Sheen { get => Data[0xBC]; set => Data[0xBC] = value; }
// Ribbons
public override bool RibbonChampionG3 { get => Data[0xBD] == 1; set => Data[0xBD] = value ? (byte)1 : (byte)0; }
public override bool RibbonWinning { get => Data[0xBE] == 1; set => Data[0xBE] = value ? (byte)1 : (byte)0; }
public override bool RibbonVictory { get => Data[0xBF] == 1; set => Data[0xBF] = value ? (byte)1 : (byte)0; }
public override bool RibbonArtist { get => Data[0xC0] == 1; set => Data[0xC0] = value ? (byte)1 : (byte)0; }
public override bool RibbonEffort { get => Data[0xC1] == 1; set => Data[0xC1] = value ? (byte)1 : (byte)0; }
public override bool RibbonChampionBattle { get => Data[0xC2] == 1; set => Data[0xC2] = value ? (byte)1 : (byte)0; }
public override bool RibbonChampionRegional { get => Data[0xC3] == 1; set => Data[0xC3] = value ? (byte)1 : (byte)0; }
public override bool RibbonChampionNational { get => Data[0xC4] == 1; set => Data[0xC4] = value ? (byte)1 : (byte)0; }
public override bool RibbonCountry { get => Data[0xC5] == 1; set => Data[0xC5] = value ? (byte)1 : (byte)0; }
public override bool RibbonNational { get => Data[0xC6] == 1; set => Data[0xC6] = value ? (byte)1 : (byte)0; }
public override bool RibbonEarth { get => Data[0xC7] == 1; set => Data[0xC7] = value ? (byte)1 : (byte)0; }
public override bool RibbonWorld { get => Data[0xC8] == 1; set => Data[0xC8] = value ? (byte)1 : (byte)0; }
public override bool Unused1 { get => ((Data[0xC9] >> 0) & 1) == 1; set => Data[0xC9] = (byte)((Data[0xC9] & ~1) | (value ? 1 : 0)); }
public override bool Unused2 { get => ((Data[0xC9] >> 1) & 1) == 1; set => Data[0xC9] = (byte)((Data[0xC9] & ~2) | (value ? 2 : 0)); }
public override bool Unused3 { get => ((Data[0xC9] >> 2) & 1) == 1; set => Data[0xC9] = (byte)((Data[0xC9] & ~4) | (value ? 4 : 0)); }
public override bool Unused4 { get => ((Data[0xC9] >> 3) & 1) == 1; set => Data[0xC9] = (byte)((Data[0xC9] & ~8) | (value ? 8 : 0)); }
public override bool FatefulEncounter { get => ((Data[0xC9] >> 4) & 1) == 1; set => Data[0xC9] = (byte)((Data[0xC9] &~16) | (value ?16 : 0)); }
public override int RibbonCount => Data.AsSpan(0xBD, 12).Count<byte>(1) + RibbonCountG3Cool + RibbonCountG3Beauty + RibbonCountG3Cute + RibbonCountG3Smart + RibbonCountG3Tough;
public override int PKRS_Strain { get => Data[0xCA] & 0xF; set => Data[0xCA] = (byte)(value & 0xF); }
public override bool IsEgg { get => Data[0xCB] == 1; set => Data[0xCB] = value ? (byte)1 : (byte)0; }
public override bool AbilityBit { get => Data[0xCC] == 1; set => Data[0xCC] = value ? (byte)1 : (byte)0; }
public override bool Valid { get => Data[0xCD] == 0; set => Data[0xCD] = !value ? (byte)1 : (byte)0; }
public override int MarkValue { get => SwapBits(Data[0xCF], 1, 2); set => Data[0xCF] = (byte)SwapBits(value, 1, 2); }
public override int PKRS_Days { get => Math.Max((sbyte)Data[0xD0], (sbyte)0); set => Data[0xD0] = (byte)(value == 0 ? 0xFF : value & 0xF); }
public int PartySlot { get => Data[0xD7]; set => Data[0xD7] = (byte)value; } // or not; only really used while in party?
public ushort ShadowID { get => ReadUInt16BigEndian(Data.AsSpan(0xD8)); set => WriteUInt16BigEndian(Data.AsSpan(0xD8), value); }
public int Purification { get => ReadInt32BigEndian(Data.AsSpan(0xDC)); set => WriteInt32BigEndian(Data.AsSpan(0xDC), value); }
public uint EXP_Shadow { get => ReadUInt32BigEndian(Data.AsSpan(0xC0)); set => WriteUInt32BigEndian(Data.AsSpan(0xC0), value); }
public const int Purified = -100;
public bool IsShadow => ShadowID != 0 && Purification != Purified;
protected override byte[] Encrypt() => (byte[])Data.Clone();
public PK3 ConvertToPK3()
{
var pk = ConvertTo<PK3>();
pk.FlagHasSpecies = pk.SpeciesInternal != 0; // Update Flag
pk.RefreshChecksum();
return pk;
}
}