Class reference
AcceptDialog
Inherits Window
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_autowrap = falseSets autowrapping for the text in the dialog.
bool dialog_close_on_escape = true
bool dialog_close_on_escape = trueIf true, the dialog will be hidden when the ui_cancel action is pressed (by default, this action is bound to KEY_ESCAPE).
bool dialog_hide_on_ok = true
bool dialog_hide_on_ok = trueIf 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 = ""
String dialog_text = ""The text displayed by the dialog.
bool exclusive = true
bool exclusive = truebool keep_title_visible = true
bool keep_title_visible = truebool maximize_disabled = true
bool maximize_disabled = truebool minimize_disabled = true
bool minimize_disabled = trueString ok_button_text = ""
String ok_button_text = ""The text displayed by the OK button (see get_ok_button()). If empty, a default text will be used.
String title = "Alert!"
String title = "Alert!"bool transient = true
bool transient = truebool visible = false
bool visible = falsebool wrap_controls = true
bool wrap_controls = trueMethods
Button add_button(String text, bool right = false, String action = "")
Button add_button(String text, bool right = false, String action = "")Adds a button with label text and a custom action to the dialog and returns the created button. If action is not empty, pressing the button will emit the custom_action signal with the specified action string. If true, right will place the button to the right of any sibling buttons. You can use remove_button() method to remove a button created with this method from the dialog.
Button add_cancel_button(String name)
Button add_cancel_button(String name)Adds a button with label name and a cancel action to the dialog and returns the created button. You can use remove_button() method to remove a button created with this method from the dialog.
Label get_label()
Label get_label()Returns the label used for built-in text. Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.
Button get_ok_button()
Button get_ok_button()Returns the OK Button instance. Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.
void register_text_enter(LineEdit line_edit)
LineEdit line_edit)Registers a LineEdit in the dialog. When the enter key is pressed, the dialog will be accepted.
void remove_button(Button button)
Button button)Removes the button from the dialog. Does NOT free the button. The button must be a Button added with add_button() or add_cancel_button() method. After removal, pressing the button will no longer emit this dialog's custom_action or canceled signals.
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)
StringName action)Emitted when a custom button with an action is pressed. See add_button().
Theme properties
int buttons_min_height = 0
int buttons_min_height = 0The minimum height of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.
int buttons_min_width = 0
int buttons_min_width = 0The minimum width of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.
int buttons_separation = 10
int buttons_separation = 10The size of the vertical space between the dialog's content and the button row.
StyleBox panel
StyleBox panelThe panel that fills the background of the window.