2019-06-09 02:56:11 +00:00
|
|
|
|
using System;
|
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
|
|
|
|
using System.Collections.Generic;
|
2022-01-03 05:35:59 +00:00
|
|
|
|
using static System.Buffers.Binary.BinaryPrimitives;
|
2019-06-09 02:56:11 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Generation 6 <see cref="SaveFile"/> object for <see cref="GameVersion.XY"/>.
|
|
|
|
|
/// </summary>
|
|
|
|
|
/// <inheritdoc cref="SAV6" />
|
|
|
|
|
public sealed class SAV6XY : SAV6, ISaveBlock6XY, IMultiplayerSprite
|
2019-06-09 02:56:11 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public SAV6XY(byte[] data) : base(data, SaveBlockAccessor6XY.BlockMetadataOffset)
|
2019-06-09 02:56:11 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
Blocks = new SaveBlockAccessor6XY(this);
|
|
|
|
|
Initialize();
|
|
|
|
|
}
|
2019-07-05 18:53:13 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public SAV6XY() : base(SaveUtil.SIZE_G6XY, SaveBlockAccessor6XY.BlockMetadataOffset)
|
|
|
|
|
{
|
|
|
|
|
Blocks = new SaveBlockAccessor6XY(this);
|
|
|
|
|
Initialize();
|
|
|
|
|
ClearBoxes();
|
|
|
|
|
}
|
2019-07-05 18:53:13 +00:00
|
|
|
|
|
Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves
In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.
The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.
The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.
* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 23:15:27 +00:00
|
|
|
|
public override IPersonalTable Personal => PersonalTable.XY;
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public override IReadOnlyList<ushort> HeldItems => Legal.HeldItem_XY;
|
|
|
|
|
public SaveBlockAccessor6XY Blocks { get; }
|
|
|
|
|
protected override SaveFile CloneInternal() => new SAV6XY((byte[])Data.Clone());
|
|
|
|
|
public override int MaxMoveID => Legal.MaxMoveID_6_XY;
|
|
|
|
|
public override int MaxItemID => Legal.MaxItemID_6_XY;
|
|
|
|
|
public override int MaxAbilityID => Legal.MaxAbilityID_6_XY;
|
2019-06-09 02:56:11 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
protected override int EventWork => 0x14A00;
|
|
|
|
|
protected override int EventFlag => EventWork + 0x2F0;
|
2022-04-10 01:12:57 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
private void Initialize()
|
|
|
|
|
{
|
|
|
|
|
// Enable Features
|
|
|
|
|
Party = 0x14200;
|
|
|
|
|
PCLayout = 0x4400;
|
|
|
|
|
BattleBoxOffset = 0x04A00;
|
|
|
|
|
PSS = 0x05000;
|
|
|
|
|
PokeDex = 0x15000;
|
|
|
|
|
HoF = 0x19400;
|
|
|
|
|
DaycareOffset = 0x1B200;
|
|
|
|
|
BerryField = 0x1B800;
|
|
|
|
|
WondercardFlags = 0x1BC00;
|
|
|
|
|
Box = 0x22600;
|
|
|
|
|
JPEG = 0x57200;
|
|
|
|
|
|
|
|
|
|
WondercardData = WondercardFlags + 0x100;
|
|
|
|
|
|
|
|
|
|
// Extra Viewable Slots
|
|
|
|
|
Fused = 0x16000;
|
|
|
|
|
GTS = 0x17800;
|
|
|
|
|
}
|
2019-06-09 02:56:11 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public int GTS { get; private set; } = int.MinValue;
|
|
|
|
|
public int Fused { get; private set; } = int.MinValue;
|
|
|
|
|
|
|
|
|
|
#region Blocks
|
|
|
|
|
public override IReadOnlyList<BlockInfo> AllBlocks => Blocks.BlockInfo;
|
|
|
|
|
public override MyItem Items => Blocks.Items;
|
|
|
|
|
public override ItemInfo6 ItemInfo => Blocks.ItemInfo;
|
|
|
|
|
public override GameTime6 GameTime => Blocks.GameTime;
|
|
|
|
|
public override Situation6 Situation => Blocks.Situation;
|
|
|
|
|
public override PlayTime6 Played => Blocks.Played;
|
|
|
|
|
public override MyStatus6 Status => Blocks.Status;
|
|
|
|
|
public override RecordBlock6 Records => Blocks.Records;
|
|
|
|
|
public Puff6 Puff => Blocks.Puff;
|
|
|
|
|
public OPower6 OPower => Blocks.OPower;
|
|
|
|
|
public LinkBlock6 Link => Blocks.Link;
|
|
|
|
|
public BoxLayout6 BoxLayout => Blocks.BoxLayout;
|
|
|
|
|
public BattleBox6 BattleBox => Blocks.BattleBox;
|
|
|
|
|
public MysteryBlock6 MysteryGift => Blocks.MysteryGift;
|
|
|
|
|
public SuperTrainBlock SuperTrain => Blocks.SuperTrain;
|
|
|
|
|
public MaisonBlock Maison => Blocks.Maison;
|
|
|
|
|
public Zukan6XY Zukan => Blocks.Zukan;
|
|
|
|
|
public Misc6XY Misc => Blocks.Misc;
|
|
|
|
|
public Fashion6XY Fashion => Blocks.Fashion;
|
|
|
|
|
public SubEventLog6 SUBE => Blocks.SUBE;
|
|
|
|
|
public ConfigSave6 Config => Blocks.Config;
|
|
|
|
|
public Encount6 Encount => Blocks.Encount;
|
|
|
|
|
#endregion
|
|
|
|
|
|
|
|
|
|
protected override void SetDex(PKM pk) => Blocks.Zukan.SetDex(pk);
|
|
|
|
|
|
|
|
|
|
// Daycare
|
|
|
|
|
public override int DaycareSeedSize => 16;
|
|
|
|
|
public override bool HasTwoDaycares => false;
|
|
|
|
|
public override bool? IsDaycareOccupied(int loc, int slot) => Data[DaycareOffset + 0 + ((SIZE_STORED + 8) * slot)] == 1;
|
|
|
|
|
public override uint? GetDaycareEXP(int loc, int slot) => ReadUInt32LittleEndian(Data.AsSpan(DaycareOffset + 4 + ((SIZE_STORED + 8) * slot)));
|
|
|
|
|
|
|
|
|
|
public override int GetDaycareSlotOffset(int loc, int slot) => DaycareOffset + 8 + (slot * (SIZE_STORED + 8));
|
|
|
|
|
public override bool? IsDaycareHasEgg(int loc) => Data[DaycareOffset + 0x1E0] == 1;
|
|
|
|
|
public override void SetDaycareHasEgg(int loc, bool hasEgg) => Data[DaycareOffset + 0x1E0] = hasEgg ? (byte)1 : (byte)0;
|
|
|
|
|
public override void SetDaycareOccupied(int loc, int slot, bool occupied) => Data[DaycareOffset + ((SIZE_STORED + 8) * slot)] = occupied ? (byte)1 : (byte)0;
|
|
|
|
|
public override void SetDaycareEXP(int loc, int slot, uint EXP) => WriteUInt32LittleEndian(Data.AsSpan(DaycareOffset + 4 + ((SIZE_STORED + 8) * slot)), EXP);
|
|
|
|
|
public override string GetDaycareRNGSeed(int loc) => Util.GetHexStringFromBytes(Data.AsSpan(DaycareOffset + 0x1E8, DaycareSeedSize / 2));
|
|
|
|
|
|
|
|
|
|
public override void SetDaycareRNGSeed(int loc, string seed)
|
|
|
|
|
{
|
|
|
|
|
if (loc != 0)
|
|
|
|
|
return;
|
|
|
|
|
if (DaycareOffset < 0)
|
|
|
|
|
return;
|
|
|
|
|
if (seed.Length > DaycareSeedSize)
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
Util.GetBytesFromHexString(seed).CopyTo(Data, DaycareOffset + 0x1E8);
|
|
|
|
|
}
|
2019-06-09 02:56:11 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public override string JPEGTitle => !HasJPPEGData ? string.Empty : StringConverter6.GetString(Data.AsSpan(JPEG, 0x1A));
|
|
|
|
|
public override byte[] GetJPEGData() => !HasJPPEGData ? Array.Empty<byte>() : GetData(JPEG + 0x54, 0xE004);
|
|
|
|
|
private bool HasJPPEGData => Data[JPEG + 0x54] == 0xFF;
|
2019-06-09 02:56:11 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public void UnlockAllFriendSafariSlots()
|
|
|
|
|
{
|
|
|
|
|
// Unlock + reveal all safari slots if friend data is present
|
|
|
|
|
const int start = 0x1E7FF;
|
|
|
|
|
const int size = 0x15;
|
|
|
|
|
for (int i = 1; i < 101; i++)
|
2019-06-09 02:56:11 +00:00
|
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
|
int ofs = start + (i * size);
|
|
|
|
|
if (Data[ofs] != 0) // no friend data == 0x00
|
|
|
|
|
Data[ofs] = 0x3D;
|
2019-06-09 02:56:11 +00:00
|
|
|
|
}
|
2019-10-26 19:33:58 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
State.Edited = true;
|
|
|
|
|
}
|
2019-06-09 02:56:11 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public override GameVersion Version => Game switch
|
|
|
|
|
{
|
|
|
|
|
(int) GameVersion.X => GameVersion.X,
|
|
|
|
|
(int) GameVersion.Y => GameVersion.Y,
|
|
|
|
|
_ => GameVersion.Invalid,
|
|
|
|
|
};
|
2019-10-26 19:33:58 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
protected override bool[] MysteryGiftReceivedFlags { get => Blocks.MysteryGift.GetReceivedFlags(); set => Blocks.MysteryGift.SetReceivedFlags(value); }
|
|
|
|
|
protected override DataMysteryGift[] MysteryGiftCards { get => Blocks.MysteryGift.GetGifts(); set => Blocks.MysteryGift.SetGifts(value); }
|
2019-06-09 02:56:11 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public override bool GetCaught(int species) => Blocks.Zukan.GetCaught(species);
|
|
|
|
|
public override bool GetSeen(int species) => Blocks.Zukan.GetSeen(species);
|
|
|
|
|
public override void SetSeen(int species, bool seen) => Blocks.Zukan.SetSeen(species, seen);
|
|
|
|
|
public override void SetCaught(int species, bool caught) => Blocks.Zukan.SetCaught(species, caught);
|
2019-07-06 04:39:47 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public override int CurrentBox { get => Blocks.BoxLayout.CurrentBox; set => Blocks.BoxLayout.CurrentBox = value; }
|
|
|
|
|
protected override int GetBoxWallpaperOffset(int box) => Blocks.BoxLayout.GetBoxWallpaperOffset(box);
|
|
|
|
|
public override int BoxesUnlocked { get => Blocks.BoxLayout.BoxesUnlocked; set => Blocks.BoxLayout.BoxesUnlocked = value; }
|
|
|
|
|
public override byte[] BoxFlags { get => Blocks.BoxLayout.BoxFlags; set => Blocks.BoxLayout.BoxFlags = value; }
|
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
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public bool BattleBoxLocked
|
|
|
|
|
{
|
|
|
|
|
get => Blocks.BattleBox.Locked;
|
|
|
|
|
set => Blocks.BattleBox.Locked = value;
|
|
|
|
|
}
|
2021-08-05 20:22:06 +00:00
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
|
public override uint Money { get => Blocks.Misc.Money; set => Blocks.Misc.Money = value; }
|
|
|
|
|
public override int Vivillon { get => Blocks.Misc.Vivillon; set => Blocks.Misc.Vivillon = value; }
|
|
|
|
|
public override int Badges { get => Blocks.Misc.Badges; set => Blocks.Misc.Badges = value; }
|
|
|
|
|
public override int BP { get => Blocks.Misc.BP; set => Blocks.Misc.BP = value; }
|
|
|
|
|
|
|
|
|
|
public int MultiplayerSpriteID
|
|
|
|
|
{
|
|
|
|
|
get => Blocks.Status.MultiplayerSpriteID_1;
|
|
|
|
|
set => Blocks.Status.MultiplayerSpriteID_1 = Blocks.Status.MultiplayerSpriteID_2 = value;
|
2019-06-09 02:56:11 +00:00
|
|
|
|
}
|
2019-07-08 05:58:33 +00:00
|
|
|
|
}
|