KSPModdingLibs / KSPCommunityFixes

Community patches for bugs in the KSP codebase
49 stars 17 forks source link

Better Undo/Redo can merge two steps into one #206

Closed numberlesstim closed 5 months ago

numberlesstim commented 6 months ago

Steps to reproduce:

  1. Place 2 tanks attached to each other.
  2. Move the second (not root tank) using the "Move" tool.
  3. Undo step 2.
  4. Observe the tank disappearing instead of getting moved to the original place.

Using Redo after this will add the tank back in at the position it was after moving it, so it appears that two steps have been merged.

This "merging" of steps also happens if you change anything in the paw. For example changing fuellevel, open/close a bay, extend panels, change part variant etc.

I did test this with no other mods installed and verified this does not happen without KSPCF.

numberlesstim commented 6 months ago

Further, if in the above steps you instead move the root tank, it will both remove the second tank and move the root tank back to the original place. Maybe that is a better example.

gotmachine commented 6 months ago

So...

It's not really a "merging" of steps, but more an oversight of the consequences of inverting the undo/redo logic.

Basically, what the patch does is invert the core undo/redo logic from capturing state after events to capturing it before events.

However, I only moved at which point the state is captured for attach/detach events, not for offset/rotate events, which means you end up with twice the same state captured (in your reproduction steps, you will notice that you have to undo twice at step 3 for step 4 to happen), and the state before offsetting/rotating not being captured at all.

Now that I'm looking at it, there are actually more events that result in the same issue (same repro steps, just change step 2 with the following actions) :

This will need quite a bit of work to fix them all. Basically, we need to move the call to EditorLogic.SetBackup() before the actions take place (instead of after).

gotmachine commented 5 months ago

Fix released in 1.35.0