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

Hérite de : Window < Viewport < Node < Object

Hérité par : ConfirmationDialog

Une boîte de dialogue de base utilisée pour la notification des utilisateurs.

Description

Par défaut, AcceptDialog permet uniquement d'accepter ou de fermer la boîte de dialogue, avec le même résultat. Cependant, les signaux confirmed et canceled permettent de différencier les deux actions, et la méthode add_button() permet d'ajouter des boutons et des actions personnalisés.

Remarque : AcceptDialog est invisible par défaut. Pour le rendre visible, appelez l'une des méthodes popup_* de Window sur le nœud, telle que Window.popup_centered_clamped().

Propriétés

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)
bool	maximize_disabled	`true` (overrides Window)
bool	minimize_disabled	`true` (overrides Window)
String	ok_button_text	`""`
String	title	`"Alert!"` (overrides Window)
bool	transient	`true` (overrides Window)
bool	visible	`false` (overrides Window)
bool	wrap_controls	`true` (overrides Window)

Méthodes

Button	add_button(text: String, right: bool = false, action: String = "")
Button	add_cancel_button(name: String)
Label	get_label()
Button	get_ok_button()
void	register_text_enter(line_edit: LineEdit)
void	remove_button(button: Button)

Propriétés du thème

int	buttons_min_height	`0`
int	buttons_min_width	`0`
int	buttons_separation	`10`
StyleBox	panel

Signaux

canceled() 🔗

Émis lorsque la fenêtre est fermée ou que le bouton créé avec add_cancel_button() est pressé.

confirmed() 🔗

Émis lorsque le dialogue est accepté, c'est-à-dire lorsque le bouton OK est enfoncé.

custom_action(action: StringName) 🔗

Émis lorsqu'un bouton personnalisé est appuyé. Voir add_button().

Descriptions des propriétés

bool dialog_autowrap = false 🔗

void set_autowrap(value: bool)
bool has_autowrap()

Défini le retour à la ligne automatique du texte dans la fenêtre de dialogue.

bool dialog_close_on_escape = true 🔗

void set_close_on_escape(value: bool)
bool get_close_on_escape()

Si true, la boîte de dialogue sera cachée lorsque l'action ui_close_dialog est pressée (par défaut, cette action est liée à o Echap, ou Cmd + W sur macOS).

bool dialog_hide_on_ok = true 🔗

void set_hide_on_ok(value: bool)
bool get_hide_on_ok()

Si true, la boîte de dialogue est cachée quand le bouton OK est pressé. Vous pouvez le mettre à false si vous voulez, par exemple, valider l'entrée quand le signal confirmed est reçu et masquer manuellement la boîte de dialogue.

Note: Plusieurs nœuds dérivés de cette classe peuvent avoir une valeur par défaut différente mais aussi leur propre logique intégrée qui outrepassera ce réglage. Par exemple FileDialog utilise par défaut false, et contient sa propre logique pour valider l'entrée qui est appelée quand vous pressez OK, puis va cacher le dialogue si cette entrée est valide. Telle quelle, cette propriété ne peut pas être utilisée dans FileDialog pour désactiver la dissimulation de la boîte de dialogue quand OK est pressé.

String dialog_text = "" 🔗

void set_text(value: String)
String get_text()

Le texte affiché par le dialogue.

String ok_button_text = "" 🔗

void set_ok_button_text(value: String)
String get_ok_button_text()

Le texte affiché par le bouton OK (voir get_ok_button()). Si vide, un texte par défaut sera utilisé.

Descriptions des méthodes

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

Ajoute un bouton avec l'étiquette text et une action personnalisée à la boite de dialogue et renvoie le bouton créé.

Si l'action n'est pas vide, appuyer sur le bouton émettra le signal custom_action avec la chaîne d'action spécifiée.

Si true, right placera le bouton à la droite des autres boutons frères.

Vous pouvez utiliser la méthode remove_button() pour supprimer de la boite de dialogue un bouton créé avec cette méthode.

Button add_cancel_button(name: String) 🔗

Ajoute un bouton avec l'étiquette name et une action d'annulation à la boîte de dialogue et renvoie le bouton créé.

Vous pouvez utiliser la méthode remove_button() pour supprimer de la boite de dialogue un bouton un bouton créé avec cette méthode.

Label get_label() 🔗

Renvoie le label utilisé pour le texte intégré.

Avertissement : Il s'agit d'un nœud interne nécessaire, le retirer et le libérer peut causer un plantage. Si vous voulez le cacher lui ou l'un de ses enfants, utilisez plutôt CanvasItem.visible.

Button get_ok_button() 🔗

Renvoie l'instance du Button "OK".

Avertissement : Il s'agit d'un nœud interne nécessaire, le retirer et le libérer peut causer un plantage. Si vous voulez le cacher lui ou l'un de ses enfants, utilisez plutôt CanvasItem.visible.

void register_text_enter(line_edit: LineEdit) 🔗

Ajoute une LineEdit dans le dialogue. Quand on appuie sur la touche entrée, le dialogue sera accepté.

void remove_button(button: Button) 🔗

Retire le button de la boite de dialogue. Ne libère PAS le button. Le button doit être un Button ajouté avec la méthode add_button() ou add_cancel_button(). Après retrait, appuyer sur button n'émettra plus les signaux custom_action ou canceled de la boite de dialogue.

Descriptions des propriétés du thème

int buttons_min_height = 0 🔗

La hauteur minimale de chaque bouton de la ligne inférieure (comme OK/Annuler) en pixels. Cela peut être augmenté pour rendre les boutons avec des textes courts plus faciles à cliquer/presser.

int buttons_min_width = 0 🔗

La largeur minimale de chaque bouton de la ligne inférieure (comme OK/Annuler) en pixels. Cela peut être augmenté pour rendre les boutons avec des textes courts plus faciles à cliquer/presser.

int buttons_separation = 10 🔗

La taille de l'espace vertical entre le contenu de la fenêtre et la ligne de boutons.

StyleBox panel 🔗

Le panneau qui remplit l'arrière-plan de la fenêtre.