Very quick rundown of Editor Undo System?

Development Programming & Scripting C++
, ,
1

Dear Friends at Epic,

Any chance of a very short rundown of all steps to work with undo system in the editor?

I got this far

I run this upon selecting new actor

//Set Transactonal
VictoryEngine->VSelectedActor->SetFlags(RF_Transactional);

I am running this each time a vertex snap / editor action occrs

void DoSnap()
{
    const FScopedTransaction Transaction( TEXT("Snap"), LOCTEXT( "VictoryEditor", "Vertex Snap" ), VictoryEngine->VSelectedActor  );
    
    VictoryEngine->VSelectedActor->Modify();

    //I then do the vertex snap here, and end the local context / scope
    VictoryEngine->VSelectedActor->SetActorLocation(...);
}

…

And that’s all I know so far!

The issue I have is that sometimes the above works, but others time the chain of undo/redo is broken,

Are there additional steps to play nice with the existing undo/redo system?

#Thanks!

Rama

2

You seem to have gotten the majority of it worked out, my guess is that your issue is that every object that has properties modified as part of the transaction needs to have modify called on it. In the case of SetActorLocation that means that properties will be set on the RootComponent and there isn’t an internal Modify call made on the component (possibly questionable that there isn’t, but it is what it is), so you need to do one yourself.

3

It’s also worth noting that transactions are only saved when the outermost transaction is closed.

That means if you open a scoped transaction in FuncA and call FuncB that also opens a scoped transaction, you won’t see the transaction from FuncB as a separate undo, as it will be merged into the undo opened for FuncA.

4

2538-undo.jpg
2538-undo.jpg700×526 19.5 KB

#Thank You Marc Audy!

That did it!!!

I dont know how long it would have taken me to figure that out on my own

My Vertex Snap Editor Plugin now fully supports the UE4 Undo system, thanks to you!

#Plugin Link With Entire Source Code

#Thank You Jamie!

And thank you Jamie for being so prompt in answering my questions :heart:!

2537-rainbow.jpg

#Code Sample for Others

#.cpp

#include "ScopedTransaction.h"
#define LOCTEXT_NAMESPACE "VictoryVertexSnapEditor"

//Save an Undo, must target the components directly

//this is after a SetActorLocation() has occurred
//TheActor->SetActorLocation();

const FScopedTransaction Transaction( TEXT("Snap"), LOCTEXT( "VictoryGame", "Victory Vertex Snap" ), TheActor->GetRootComponent()  );
TheActor->GetRootComponent()->Modify();
5

For other folks, now-a-days (4.10) the preferred method is to use the 2 parameter constructor version for FScopedTransaction (second param has default value and isn’t required) rather than the 4 param version e.g.:

    const FScopedTransaction Transaction(LOCTEXT("Text1", "Text2"));
    TheActor->GetRootComponent()->Modify();

and make sure to called Modify() before actually modifying the object, which is what takes the snapshot