Navigation
API > API/Runtime > API/Runtime/CoreUObject
Transaction object events.
Transaction object events are used to notify objects when they are transacted in some way. This mostly just means that an object has had an undo/redo applied to it, however an event is also triggered when the object has been finalized as part of a transaction (allowing you to detect object changes).
| Name | FTransactionObjectEvent |
| Type | class |
| Header File | /Engine/Source/Runtime/CoreUObject/Public/Misc/TransactionObjectEvent.h |
| Include Path | #include "Misc/TransactionObjectEvent.h" |
Syntax
class FTransactionObjectEvent
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTransactionObjectEvent
(
const FGuid& InTransactionId, |
Misc/TransactionObjectEvent.h | ||
| Misc/TransactionObjectEvent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Annotation | TSharedPtr< ITransactionObjectAnnotation > | Misc/TransactionObjectEvent.h | ||
| EventType | ETransactionObjectEventType | Misc/TransactionObjectEvent.h | ||
| ObjectChange | FTransactionObjectChange | Misc/TransactionObjectEvent.h | ||
| ObjectChangeCreatedBy | ETransactionObjectChangeCreatedBy | Misc/TransactionObjectEvent.h | ||
| OperationId | FGuid | Misc/TransactionObjectEvent.h | ||
| TransactionId | FGuid | Misc/TransactionObjectEvent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< ITransactionObjectAnnotation > GetAnnotation() |
Get the annotation object associated with the object being transacted (if any). | Misc/TransactionObjectEvent.h | |
| Get the list of changed properties. | Misc/TransactionObjectEvent.h | ||
ETransactionObjectEventType GetEventType() |
What kind of action caused this event? | Misc/TransactionObjectEvent.h | |
ETransactionObjectChangeCreatedBy GetObjectChangeCreatedBy() |
What kind of thing created this object change? | Misc/TransactionObjectEvent.h | |
const FGuid & GetOperationId() |
The unique identifier for the active operation on the transaction this event belongs to | Misc/TransactionObjectEvent.h | |
FName GetOriginalObjectClassPathName() |
Misc/TransactionObjectEvent.h | ||
FName GetOriginalObjectExternalPackageName() |
Get the original package name of this object | Misc/TransactionObjectEvent.h | |
EObjectFlags GetOriginalObjectFlags() |
Get the original flags of this object | Misc/TransactionObjectEvent.h | |
const FTransactionObjectId & GetOriginalObjectId() |
Get the original ID of this object | Misc/TransactionObjectEvent.h | |
FName GetOriginalObjectName() |
Get the original name of this object | Misc/TransactionObjectEvent.h | |
FName GetOriginalObjectOuterPathName() |
Get the original outer path name of this object | Misc/TransactionObjectEvent.h | |
FName GetOriginalObjectPackageName() |
Get the original package name of this object | Misc/TransactionObjectEvent.h | |
FName GetOriginalObjectPathName() |
Get the original path name of this object | Misc/TransactionObjectEvent.h | |
const FGuid & GetTransactionId() |
The unique identifier of the transaction this event belongs to | Misc/TransactionObjectEvent.h | |
bool HasExternalPackageChange() |
Has the package assigned to this object changed? (implies non-property changes) | Misc/TransactionObjectEvent.h | |
bool HasIdOrPendingKillChanges() |
Were ID (name, outer, package) or pending kill changes made to the object? | Misc/TransactionObjectEvent.h | |
bool HasNameChange() |
Was the name of this object changed? (implies non-property changes) | Misc/TransactionObjectEvent.h | |
bool HasNonPropertyChanges
(
const bool InSerializationOnly |
Were any non-property changes made to the object? (name, outer, package, pending kill, or serialized non-property data) | Misc/TransactionObjectEvent.h | |
bool HasOuterChange() |
Was the outer of this object changed? (implies non-property changes) | Misc/TransactionObjectEvent.h | |
bool HasPendingKillChange() |
Was the pending kill state of this object changed? (implies non-property changes) | Misc/TransactionObjectEvent.h | |
bool HasPropertyChanges() |
Were any property changes made to the object? | Misc/TransactionObjectEvent.h | |
void Merge
(
const FTransactionObjectEvent& InOther |
Merge this transaction event with another | Misc/TransactionObjectEvent.h |