Inherits: WindowDialog < Popup < Control < CanvasItem < Node < Object

Inherited By: ConfirmationDialog

Category: Core

Brief Description

Base dialog for user notification.

Member Functions

Button add_button ( String text, bool right=false, String action=”” )
Button add_cancel ( String name )
Label get_label ( )
Button get_ok ( )
void register_text_enter ( Node line_edit )


  • confirmed ( )

Emitted when the dialog is accepted.

  • custom_action ( String action )

Emitted when a custom button is pressed. See add_button.

Member Variables

  • bool dialog_hide_on_ok - If true the dialog is hidden when accepted. Default value: true.
  • String dialog_text - The text displayed by this dialog.


This dialog is useful for small notifications to the user about an event. It can only be accepted or closed, with the same result.

Member Function Description

Adds a button with label text and a custom action to the dialog and returns the created button. action will be passed to the custom_action signal when pressed.

If true, right will place the button to the right of any sibling buttons. Default value: false.

Adds a button with label name and a cancel action to the dialog and returns the created button.

Return the label used for built-in text.

Return the OK Button.

  • void register_text_enter ( Node line_edit )

Registers a LineEdit in the dialog. When the enter key is pressed, the dialog will be accepted.