Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

AcceptDialog

Inherits: Window < Viewport < Node < Object

Inherited By: ConfirmationDialog

A base dialog used for user notification.

Description

The default use of AcceptDialog is to allow it to only be accepted or closed, with the same result. However, the confirmed and canceled signals allow to make the two actions different, and the add_button method allows to add custom buttons and actions.

Properties

bool

dialog_autowrap

false

bool

dialog_close_on_escape

true

bool

dialog_hide_on_ok

true

String

dialog_text

""

bool

exclusive

true (overrides Window)

bool

keep_title_visible

true (overrides Window)

String

ok_button_text

"OK"

String

title

"Alert!" (overrides Window)

bool

transient

true (overrides Window)

bool

visible

false (overrides Window)

bool

wrap_controls

true (overrides Window)

Methods

Button

add_button ( String text, bool right=false, String action="" )

Button

add_cancel_button ( String name )

Label

get_label ( )

Button

get_ok_button ( )

void

register_text_enter ( Control line_edit )

void

remove_button ( Control button )

Theme Properties

int

buttons_separation

10

StyleBox

panel

Signals

canceled ( )

Emitted when the dialog is closed or the button created with add_cancel_button is pressed.

confirmed ( )

Emitted when the dialog is accepted, i.e. the OK button is pressed.

custom_action ( StringName action )

Emitted when a custom button is pressed. See add_button.

Property Descriptions

bool dialog_autowrap = false

  • void set_autowrap ( bool value )

  • bool has_autowrap ( )

Sets autowrapping for the text in the dialog.

bool dialog_close_on_escape = true

  • void set_close_on_escape ( bool value )

  • bool get_close_on_escape ( )

If true, the dialog will be hidden when the escape key (@GlobalScope.KEY_ESCAPE) is pressed.

bool dialog_hide_on_ok = true

  • void set_hide_on_ok ( bool value )

  • bool get_hide_on_ok ( )

If true, the dialog is hidden when the OK button is pressed. You can set it to false if you want to do e.g. input validation when receiving the confirmed signal, and handle hiding the dialog in your own logic.

Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example FileDialog defaults to false, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such, this property can't be used in FileDialog to disable hiding the dialog when pressing OK.

String dialog_text = ""

The text displayed by the dialog.