FTransaction | Unreal Engine 5.7 Documentation

API > API/Editor > API/Editor/UnrealEd

Base class for tracking transactions for undo/redo. A single transaction, representing a set of serialized, undo-able changes to a set of objects.

warning: The undo buffer cannot be made persistent because of its dependence on offsets of arrays from their owning UObjects.

warning: UObject::Serialize implicitly assumes that class properties do not change in between transaction resets.


Name	FTransaction
Type	class
Header File	/Engine/Source/Editor/UnrealEd/Classes/Editor/Transactor.h
Include Path	#include "Editor/Transactor.h"

Syntax

class FTransaction : public ITransaction

Implements Interfaces

ITransaction

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FTransaction ( const FTransaction& )	Non-copyable.	Editor/Transactor.h
FTransaction ( const TCHAR* InContext, const FText& InTitle, bool bInFlip )	Constructor.	Editor/Transactor.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FTransaction()		Editor/Transactor.h

Classes

Name	Remarks
FObjectRecord	Record of an object.

Structs

Name	Remarks
FChangedObjectValue
FObjectRecords
FPackageRecord

Functions

Public

Name	Remarks	Include Path
void AddReferencedObjects ( FReferenceCollector& Collector )	Used by GC to collect referenced objects.	Editor/Transactor.h
SIZE_T DataSize()		Editor/Transactor.h
void DumpObjectMap ( FOutputDevice& Ar ) const	Outputs the contents of the ObjectMap to the specified output device.	Editor/Transactor.h
FTransactionDiff GenerateDiff()	Create a map that holds information about objects of a given transaction compared to the current state of the object.	Editor/Transactor.h
FText GetDescription()	Returns the description of each contained Object Record	Editor/Transactor.h
FTransactionDiff GetHistoricDiff()	Create a map that holds information about objects of a given transaction compared to their previous state the last time this transaction was applied to those objects (via PostTransacted).	Editor/Transactor.h
FGuid GetId()	Returns the unique identifier for this transaction, used to track it during its lifetime	Editor/Transactor.h
FGuid GetOperationId()	Returns the unique identifier for the active operation on this transaction (if any)	Editor/Transactor.h
const UObject * GetPrimaryObject()		Editor/Transactor.h
int32 GetRecordCount()		Editor/Transactor.h
FText GetTitle()	Returns the descriptive text for the transaction	Editor/Transactor.h
void GetTransactionObjects ( TArray< UObject* >& Objects ) const	Get all the objects that are part of this transaction.	Editor/Transactor.h
virtual const TCHAR * GetTransactionType()	Returns a unique string to serve as a type ID for the FTranscationBase-derived type.	Editor/Transactor.h
virtual bool HasExpired()		Editor/Transactor.h
bool IsObjectTransacting ( const UObject* Object ) const	Checks if a specific object is in the transaction currently underway	Editor/Transactor.h

Overridden from ITransaction

Name	Remarks	Include Path
virtual void Apply()	Enacts the transaction.	Editor/Transactor.h
virtual void BeginOperation()	BeginOperation should be called when a transaction or undo/redo starts	Editor/Transactor.h
virtual bool ContainsObject ( const UObject* Object ) const		Editor/Transactor.h
virtual bool ContainsPieObjects()		Editor/Transactor.h
virtual void EndOperation()	EndOperation should be called when a transaction is finalized or canceled or undo/redo ends	Editor/Transactor.h
virtual void Finalize()	Finalize the transaction (try and work out what's changed).	Editor/Transactor.h
virtual FTransactionContext GetContext()	Gets the full context for the transaction.	Editor/Transactor.h
virtual bool IsTransient()		Editor/Transactor.h
virtual void SaveArray ( UObject* Object, FScriptArray* Array, int32 Index, int32 Count, int32 Oper, int32 ElementSize, uint32 ElementAlignment, STRUCT_DC DefaultConstructor, STRUCT_AR Serializer, STRUCT_DTOR Destructor )		Editor/Transactor.h
virtual void SaveObject ( UObject* Object )		Editor/Transactor.h
virtual void SetPrimaryObject ( UObject* InObject )		Editor/Transactor.h
virtual void SnapshotObject ( UObject* InObject, TArrayView< const FProperty* > Properties )		Editor/Transactor.h
virtual void StoreUndo ( UObject* Object, TUniquePtr< FChange > UndoChange )		Editor/Transactor.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
FTransaction & operator= ( const FTransaction& )		Editor/Transactor.h

Navigation