unreal.EditorDialog

class unreal.EditorDialog(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Utility class to create simple pop-up dialogs to notify the user of task completion, or to ask them to make simple Yes/No/Retry/Cancel type decisions.

C++ Source:

  • Plugin: EditorScriptingUtilities

  • Module: EditorScriptingUtilities

  • File: EditorDialogLibrary.h

classmethod show_message(title, message, message_type, default_value=AppReturnType.NO) → AppReturnType

Open a modal message box dialog with the given message. If running in “-unattended” mode it will immediately return the value specified by DefaultValue. If not running in “-unattended” mode then it will block execution until the user makes a decision, at which point their decision will be returned.

Parameters

  • title (Text) – The title of the created dialog window

  • message (Text) – Text of the message to show

  • message_type (AppMsgType) – Specifies which buttons the dialog should have

  • default_value (AppReturnType) – If the application is Unattended, the function will log and return DefaultValue

Returns

The result of the users decision, or DefaultValue if running in unattended mode.

Return type

AppReturnType