Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/PKForge.Engine/SaveEngine.cs
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ public bool Validate(ReadOnlyMemory<byte> bytes)
// Surgical: seeding the editor must not dex-mark or rewrite handler data on
// the loose entity being edited.
blank.SetBoxSlotAtIndex(converted, 0, 0, EntityImportSettings.None);
return new SaveEngineSession(blank, displayName);
return new SaveEngineSession(blank, displayName, entity is RK4 ? entity.Data.ToArray() : null);
}

/// <summary>One representative game per generation for blank generation contexts.</summary>
Expand Down
13 changes: 12 additions & 1 deletion src/PKForge.Engine/SaveEngineSession.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ public sealed class SaveEngineSession : ISaveEngineSession

private readonly byte[] _originalBytes;
private readonly string? _displayName;
private readonly byte[]? _ranchRecord;
private bool _disposed;

public SaveEngineSession(ReadOnlyMemory<byte> bytes, string? displayName = null)
Expand Down Expand Up @@ -48,11 +49,12 @@ public void MakeActive()
/// be written out (SAV3.WriteSectors throws), and a standalone entity session is never
/// written back to a save file - only its single mon is exported via ExportSlot.
/// </summary>
internal SaveEngineSession(SaveFile save, string? displayName)
internal SaveEngineSession(SaveFile save, string? displayName, byte[]? ranchRecord = null)
{
_save = save;
_originalBytes = [];
_displayName = displayName;
_ranchRecord = ranchRecord;
}

/// <summary>Built on demand: every read must reflect writes made through this
Expand Down Expand Up @@ -997,6 +999,15 @@ public SlotExport ExportSlot(int box, int slot)
{
ThrowIfDisposed();
var entity = GetEntityCore(box, slot);
if (_ranchRecord is not null && box == 0 && slot == 0)
{
// The Bank edits a PK4 view; keep the original Ranch-only ownership tail
// instead of silently replacing the native entry with that portable view.
var native = new RK4(_ranchRecord.ToArray());
entity.WriteDecryptedDataStored(native.Data[..entity.SIZE_STORED]);
native.RefreshChecksum();
entity = native;
}
var data = new byte[entity.SIZE_PARTY];
entity.WriteDecryptedDataParty(data);
var safeName = string.Concat(entity.FileName.Select(c => char.IsAsciiLetterOrDigit(c) || c is '.' or '-' or '_' or ' ' ? c : '_'));
Expand Down
48 changes: 48 additions & 0 deletions tests/PKForge.Engine.Tests/RanchBankRecordTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
using PKForge.Engine;
using PKHeX.Core;
using Xunit;

namespace PKForge.Engine.Tests;

public sealed class RanchBankRecordTests
{
[Theory]
[InlineData(RanchOwnershipType.Trainer)]
[InlineData(RanchOwnershipType.Hayley)]
[InlineData(RanchOwnershipType.Hayley_Traded)]
public void BankEditorRetainsTheNativeRecordAndOwnershipTail(RanchOwnershipType owner)
{
// RK4's first 136 bytes are the PK4 view. The remaining 28 bytes carry
// Ranch ownership/handler data (pinned PKHeX.Core RK4.ConvertToPK4).
var native = new RK4 { Species = 25, PID = 12345, ID32 = 23456,
Language = 2, Version = GameVersion.D, OwnershipType = owner,
HandlingTrainerTID = 99, HandlingTrainerSID = 88, HandlingTrainerName = "HANDLER" };
native.Data[0x89] = 0xAB; // include an uninterpreted byte in preservation checks
native.RefreshChecksum();
var original = new byte[native.SIZE_STORED];
native.WriteDecryptedDataStored(original);
var engine = new SaveEngine();
using var session = engine.OpenEntitySession(original, format: "RK4");
Assert.NotNull(session);
var noop = session.ExportSlot(0, 0);
Assert.Equal("RK4", noop.Format);
Assert.Equal(original, noop.Data);

session.ApplyEdit(0, 0, new(Nickname: "COPY"));
var changed = session.ExportSlot(0, 0);
Assert.Equal("RK4", changed.Format);
Assert.Equal(164, changed.Data.Length);
var reread = new RK4(changed.Data);
Assert.Equal("COPY", reread.Nickname);
Assert.True(reread.ChecksumValid);
Assert.Equal(owner, reread.OwnershipType);
Assert.Equal(99, reread.HandlingTrainerTID);
Assert.Equal(88, reread.HandlingTrainerSID);
Assert.Equal("HANDLER", reread.HandlingTrainerName);
Assert.True(original.AsSpan(136).SequenceEqual(changed.Data.AsSpan(136)));

using var reopened = engine.OpenEntitySession(changed.Data, format: changed.Format);
Assert.NotNull(reopened);
Assert.Equal(changed.Data, reopened.ExportSlot(0, 0).Data);
}
}