Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Kismet > UKismetSystemLibrary > UKismetSystemLibrary::BeginTransaction

Light Theme

Dark Theme

UKismetSystemLibrary::BeginTransaction

Begin a new undo transaction.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Kismet/KismetSystemLibrary.h
Include	#include "Kismet/KismetSystemLibrary.h"
Source	/Engine/Source/Runtime/Engine/Private/KismetSystemLibrary.cpp

Syntax

static int32 BeginTransaction
(
    const FString & Context,
    FText Description,
    UObject * PrimaryObject
)

Remarks

Begin a new undo transaction. An undo transaction is defined as all actions which take place when the user selects "undo" a single time.

If there is already an active transaction in progress, then this increments that transaction's action counter instead of beginning a new transaction.

You must call TransactObject before modifying each object that should be included in this undo transaction.

Only available in the editor.

Returns

The number of active actions when BeginTransaction was called (values greater than 0 indicate that there was already an existing undo transaction in progress), or -1 on failure.

Parameters

Parameter	Description
Context	The context for the undo session. Typically the tool/editor that caused the undo operation.
Description	The description for the undo session. This is the text that will appear in the "Edit" menu next to the Undo item.
PrimaryObject	The primary object that the undo session operators on (can be null, and mostly is).

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

Take our survey

Dismiss