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

Light Theme

Dark Theme

FEditorModeTools::EnsureNotInMode

Returns true if the current mode is not the specified ModeID. Also optionally warns the user.

Windows

MacOS

Linux

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/EditorModeManager.h
Include	#include "EditorModeManager.h"
Source	/Engine/Source/Editor/UnrealEd/Private/EditorModeManager.cpp

Syntax

bool EnsureNotInMode
(
    FEditorModeID ModeID,
    const FText & ErrorMsg,
    bool bNotifyUser
) const

Remarks

Returns true if the current mode is not the specified ModeID. Also optionally warns the user.

Returns

true if the current mode is not the specified mode.

Parameters

Parameter	Description
ModeID	The editor mode to query.
ErrorMsg	If specified, inform the user the reason why this is a problem
bNotifyUser	If true, display the error as a notification, instead of a dialog

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

Take our survey

Dismiss