UTransactor::Begin

Begins a new undo transaction.

Windows
MacOS
Linux

Override Hierarchy

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Classes/Editor/Transactor.h

Include

#include "Editor/Transactor.h"

Syntax

virtual int32 Begin
(
    const TCHAR * SessionContext,
    const FText & Description
)

Remarks

Begins 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, increments that transaction's action counter instead of beginning a new transaction.

Returns

Number of active actions when Begin() was called; values greater than 0 indicate that there was already an existing undo transaction in progress.

Parameters

Parameter

Description

SessionContext

the context for the undo session; typically the tool/editor that cause 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

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