PKHeX/PKHeX.Core/Saves/SAV4Sinnoh.cs
Kurt 02420d3e93
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-16 18:47:31 -07:00

204 lines
No EOL
7.9 KiB
C#

using System;
namespace PKHeX.Core
{
/// <summary>
/// Abstract <see cref="SaveFile"/> format for <see cref="GameVersion.DP"/> and <see cref="GameVersion.Pt"/>
/// </summary>
public abstract class SAV4Sinnoh : SAV4
{
protected override int StorageStart => GeneralSize;
protected override int FooterSize => 0x14;
protected SAV4Sinnoh() { }
protected SAV4Sinnoh(byte[] data) : base(data) { }
#region Storage
// u32 currentBox
// box{pk4[30}[18]
// g4str[18] boxNames
// byte[18] boxWallpapers
private const int BOX_COUNT = 18;
private const int BOX_SLOTS = 30;
private const int BOX_NAME_LEN = 40; // 20 characters
private const int BOX_DATA_LEN = (BOX_SLOTS * PKX.SIZE_4STORED); // 0xFF0, no padding between boxes (to nearest 0x100)
private const int BOX_END = BOX_COUNT * BOX_DATA_LEN; // 18 * 0xFF0
private const int BOX_NAME = 4 + BOX_END; // after box data
private const int BOX_WP = BOX_NAME + (BOX_COUNT * BOX_NAME_LEN); // 0x121B4;
private const int BOX_WP_END = 18 + BOX_WP; // 0x121C6
public override int GetBoxOffset(int box) => 4 + (box * BOX_DATA_LEN);
private static int GetBoxNameOffset(int box) => BOX_NAME + (box * BOX_NAME_LEN);
protected override int GetBoxWallpaperOffset(int box) => BOX_WP + box;
public override int CurrentBox // (align 32)
{
get => Storage[0];
set => Storage[0] = (byte)value;
}
public int Unknown
{
get => BitConverter.ToInt32(Storage, BOX_WP_END);
set => SetData(Storage, BitConverter.GetBytes(value), BOX_WP_END);
}
public override string GetBoxName(int box) => GetString(Storage, GetBoxNameOffset(box), BOX_NAME_LEN);
public override void SetBoxName(int box, string value)
{
const int maxlen = BOX_NAME_LEN / 2;
if (value.Length > maxlen)
value = value.Substring(0, maxlen); // Hard cap
int offset = GetBoxNameOffset(box);
var str = SetString(value, maxlen);
SetData(Storage, str, offset);
}
#endregion
#region Poketch
public int PoketchStart { get; protected set; }
private byte PoketchPacked { get => General[PoketchStart]; set => General[PoketchStart] = value; }
public bool PoketchEnabled { get => (PoketchPacked & 1) != 0; set => PoketchPacked = (byte)(value ? (PoketchPacked | 1) : (PoketchPacked & ~1)); }
public bool PoketchFlag1 { get => (PoketchPacked & 2) != 0; set => PoketchPacked = (byte)(value ? (PoketchPacked | 2) : (PoketchPacked & ~2)); }
public bool PoketchFlag2 { get => (PoketchPacked & 4) != 0; set => PoketchPacked = (byte)(value ? (PoketchPacked | 4) : (PoketchPacked & ~4)); }
public PoketchColor PoketchColor
{
get => (PoketchColor) ((PoketchPacked >> 3) & 7);
set => PoketchPacked = (byte) ((PoketchPacked & 0xC7) | ((int) value << 3));
}
public bool PoketchFlag6 { get => (PoketchPacked & 0x40) != 0; set => PoketchPacked = (byte)(value ? (PoketchPacked | 0x40) : (PoketchPacked & ~0x40)); }
public bool PoketchFlag7 { get => (PoketchPacked & 0x80) != 0; set => PoketchPacked = (byte)(value ? (PoketchPacked | 0x80) : (PoketchPacked & ~0x80)); }
private byte Poketch1 { get => General[PoketchStart + 1]; set => General[PoketchStart + 1] = value; }
public sbyte CurrentPoketchApp { get => (sbyte)General[PoketchStart + 2]; set => General[PoketchStart + 2] = (byte)Math.Min((sbyte)PoketchApp.Alarm_Clock, value); }
public bool GetPoketchAppUnlocked(PoketchApp index)
{
if (index > PoketchApp.Alarm_Clock)
throw new ArgumentException(nameof(index));
return General[PoketchStart + 3 + (int) index] != 0;
}
public void SetPoketchAppUnlocked(PoketchApp index, bool value = true)
{
if (index > PoketchApp.Alarm_Clock)
throw new ArgumentException(nameof(index));
var b = value ? 1 : 0;
General[PoketchStart + 3 + (int)index] = (byte)b;
}
// 8 bytes unk
public uint PoketchStepCounter
{
get => BitConverter.ToUInt32(General, PoketchStart + 0x24);
set => SetData(General, BitConverter.GetBytes(value), PoketchStart + 0x24);
}
// 2 bytes for alarm clock time setting
public byte[] PoketchDotArtistData
{
get => General.Slice(PoketchStart + 0x2A, 120);
set => SetData(General, value, PoketchStart + 0x2A);
}
// map marking stuff is at the end, unimportant
#endregion
#region Honey Trees
protected int OFS_HONEY;
protected const int HONEY_SIZE = 8;
public HoneyTree GetHoneyTree(int index)
{
if ((uint)index > 21)
throw new ArgumentException(nameof(index));
return new HoneyTree(General.Slice(OFS_HONEY + (HONEY_SIZE * index), HONEY_SIZE));
}
public void SetHoneyTree(HoneyTree tree, int index)
{
if (index <= 21)
SetData(General, tree.Data, OFS_HONEY + (HONEY_SIZE * index));
}
public int[] MunchlaxTrees
{
get
{
int A = (TID >> 8) % 21;
int B = (TID & 0x00FF) % 21;
int C = (SID >> 8) % 21;
int D = (SID & 0x00FF) % 21;
if (A == B) B = (B + 1) % 21;
if (A == C) C = (C + 1) % 21;
if (B == C) C = (C + 1) % 21;
if (A == D) D = (D + 1) % 21;
if (B == D) D = (D + 1) % 21;
if (C == D) D = (D + 1) % 21;
return new[] { A, B, C, D };
}
}
#endregion
public int OFS_PoffinCase { get; protected set; }
//Underground Scores
protected int OFS_UG_Stats;
public int UG_PlayersMet { get => BitConverter.ToInt32(General, OFS_UG_Stats); set => SetData(General, BitConverter.GetBytes(value), OFS_UG_Stats); }
public int UG_Gifts { get => BitConverter.ToInt32(General, OFS_UG_Stats + 0x4); set => SetData(General, BitConverter.GetBytes(value), OFS_UG_Stats + 0x4); }
public int UG_Spheres { get => BitConverter.ToInt32(General, OFS_UG_Stats + 0xC); set => SetData(General, BitConverter.GetBytes(value), OFS_UG_Stats + 0xC); }
public int UG_Fossils { get => BitConverter.ToInt32(General, OFS_UG_Stats + 0x10); set => SetData(General, BitConverter.GetBytes(value), OFS_UG_Stats + 0x10); }
public int UG_TrapsAvoided { get => BitConverter.ToInt32(General, OFS_UG_Stats + 0x18); set => SetData(General, BitConverter.GetBytes(value), OFS_UG_Stats + 0x18); }
public int UG_TrapsTriggered { get => BitConverter.ToInt32(General, OFS_UG_Stats + 0x1C); set => SetData(General, BitConverter.GetBytes(value), OFS_UG_Stats + 0x1C); }
public int UG_Flags { get => BitConverter.ToInt32(General, OFS_UG_Stats + 0x34); set => SetData(General, BitConverter.GetBytes(value), OFS_UG_Stats + 0x34); }
}
public enum PoketchColor
{
Green = 0,
Yellow = 1,
Orange = 2,
Red = 3,
Purple = 4,
Blue = 5,
Turquoise = 6,
White = 7,
}
public enum PoketchApp
{
Digital_Watch,
Calculator,
Memo_Pad,
Pedometer,
Party,
Friendship_Checker,
Dowsing_Machine,
Berry_Searcher,
Daycare,
History,
Counter,
Analog_Watch,
Marking_Map,
Link_Searcher,
Coin_Toss,
Move_Tester,
Calendar,
Dot_Artist,
Roulette,
Trainer_Counter,
Kitchen_Timer,
Color_Changer,
Matchup_Checker,
Stopwatch,
Alarm_Clock,
}
}