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).

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback