ITransaction

Interface for transactions.

Windows
MacOS
Linux

Inheritance Hierarchy

ITransaction

FTransaction

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/ITransaction.h

Include

#include "Misc/ITransaction.h"

Syntax

class ITransaction

Remarks

Interface for transactions.

Transactions are created each time an UObject is modified, for example in the Editor. The data stored inside a transaction object can then be used to provide undo/redo functionality.

Functions

Name Description

Public function

void

 

Apply()

Applies the transaction.

Public function

void

 

BeginOperation()

BeginOperation should be called when a transaction or undo/redo starts

Public function Const

bool

 

ContainsPieObjects()

Public function

void

 

EndOperation()

EndOperation should be called when a transaction is finalized or canceled or undo/redo ends

Public function

void

 

Finalize()

Called when this transaction is completed to finalize the transaction

Public function Const

FTransaction...

 

GetContext()

Gets the full context for the transaction

Public function Const

bool

 

IsTransient()

Report if a transaction should be put in the undo buffer.

Public function

void

 

SaveArray

(
    UObject* Object,
    FScriptArray* Array,
    int32 Index,
    int32 Count,
    int32 Oper,
    int32 ElementSize,
    STRUCT_DC DefaultConstructor,
    STRUCT_AR Serializer,
    STRUCT_DTOR Destructor
)

Saves an array to the transaction.

Public function

void

 

SaveObject

(
    UObject* Object
)

Saves an UObject to the transaction.

Public function

void

 

SetPrimaryObject

(
    UObject* Object
)

Sets the transaction's primary object.

Public function

void

 

SnapshotObject

(
    UObject* Object,
    TArrayView< const FProperty* >...
)

Snapshots a UObject within the transaction.

Public function

void

 

StoreUndo

(
    UObject* Object,
    TUniquePtr< FChange > CustomChange
)

Stores a command that can be used to undo a change to the specified object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss