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...

BaseButton

Hérite de : Control < CanvasItem < Node < Object

Hérité par : Button, LinkButton, TextureButton

Classe commune abstraite pour les boutons GUI.

Description

BaseButton est une classe de base abstraite pour les boutons GUI. Ça n'affiche rien seul.

Propriétés

ActionMode

action_mode

1

ButtonGroup

button_group

BitField[MouseButtonMask]

button_mask

1

bool

button_pressed

false

bool

disabled

false

FocusMode

focus_mode

2 (overrides Control)

bool

keep_pressed_outside

false

Shortcut

shortcut

bool

shortcut_feedback

true

bool

shortcut_in_tooltip

true

bool

toggle_mode

false

Méthodes

void

_pressed() virtual

void

_toggled(toggled_on: bool) virtual

DrawMode

get_draw_mode() const

bool

is_hovered() const

void

set_pressed_no_signal(pressed: bool)

Signaux

button_down() 🔗

Émis quand le bouton commence à être appuyé.

button_up() 🔗

Émis quand le bouton cesse d'être appuyé.

pressed() 🔗

Émis quand le bouton est basculé ou pressé. Émis lors de button_down si action_mode est ACTION_MODE_BUTTON_PRESS et lors de button_up sinon.

Si vous avez besoin de connaître l'état du bouton (et que toggle_mode est actif), utilisez plutôt toggled.

toggled(toggled_on: bool) 🔗

Émis lorsque le bouton vient de changer d'état entre les états pressés et normaux (seulement si toggle_mode est actif). Le nouvel état est contenu dans l'argument toggled_on.

Énumérations

enum DrawMode: 🔗

DrawMode DRAW_NORMAL = 0

L'état normal (c'est-à-dire non pressé, non survolé, non basculé ni activé) des boutons.

DrawMode DRAW_PRESSED = 1

L'état des boutons est : pressé.

DrawMode DRAW_HOVER = 2

L'état des boutons est : survolé.

DrawMode DRAW_DISABLED = 3

L'état des boutons est : désactivé.

DrawMode DRAW_HOVER_PRESSED = 4

L'état des boutons est à la fois survolé et appuyé.

enum ActionMode: 🔗

ActionMode ACTION_MODE_BUTTON_PRESS = 0

Il suffit d'appuyer sur le bouton pour le considérer comme cliqué.

ActionMode ACTION_MODE_BUTTON_RELEASE = 1

Requiert un appui suivi d'un relâchement avant de considérer le bouton comme cliqué.

Descriptions des propriétés

ActionMode action_mode = 1 🔗

Détermine quand le bouton est considéré comme cliqué.

ButtonGroup button_group 🔗

Le ButtonGroup associé au bouton. À ne pas confondre avec des groupes de nœuds.

Note : Le bouton sera configuré comme un bouton radio si un ButtonGroup lui est assigné.

BitField[MouseButtonMask] button_mask = 1 🔗

Masque binaire pour choisir auxquels boutons de la souris ce bouton répondra.

Pour permettre à la fois le clic gauche et le clic droit, utilisez MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT.

bool button_pressed = false 🔗

  • void set_pressed(value: bool)

  • bool is_pressed()

Si true, l'état du bouton est appuyé. Ce qui signifie que le bouton est appuyé ou basculé (si toggle_mode est actif). Ne fonctionne que si toggle_mode est true.

Note : Changer la valeur de button_pressed émettra le signal toggled. Si vous voulez changer l'état pressé sans émettre ce signal, utilisez plutôt set_pressed_no_signal().

bool disabled = false 🔗

  • void set_disabled(value: bool)

  • bool is_disabled()

Si true, le bouton est désactivé et il ne peut donc pas être appuyé ou basculé.

Note : Si le bouton est désactivé alors qu'il est en train d'être appuyé, button_up sera émis.

bool keep_pressed_outside = false 🔗

  • void set_keep_pressed_outside(value: bool)

  • bool is_keep_pressed_outside()

Si true, le bouton reste pressé quand le clic est maintenu mais que le curseur est déplacé en dehors du bouton.

Note : Cette propriété n'affecte que l'aspect visuel du bouton. Les signaux seront toujours émis au même moment, peu importe la valeur de cette propriété.

Shortcut shortcut 🔗

Le Shortcut associé au bouton.

bool shortcut_feedback = true 🔗

  • void set_shortcut_feedback(value: bool)

  • bool is_shortcut_feedback()

Si true, le bouton sera mis en évidence pour une courte durée lorsque son raccourci est activé. Si false et toggle_mode vaut false, le raccourci s'active sans retour visuel.

bool shortcut_in_tooltip = true 🔗

  • void set_shortcut_in_tooltip(value: bool)

  • bool is_shortcut_in_tooltip_enabled()

If true, the button will add information about its shortcut in the tooltip. This includes the shortcut's events and its Resource.resource_name. If both events and name are empty, the shortcut will not be included.

Note: This property does nothing when the tooltip control is customized using Control._make_custom_tooltip().

bool toggle_mode = false 🔗

  • void set_toggle_mode(value: bool)

  • bool is_toggle_mode()

Si true, le bouton est en mode basculement. Fait basculer le bouton entre les états pressé et non-pressé chaque fois qu'il est cliqué.

Descriptions des méthodes

void _pressed() virtual 🔗

Appelée quand le bouton est appuyé. Si vous avez besoin de connaître l'état du bouton activé (et que toggle_mode est actif), utilisez plutôt _toggled().

void _toggled(toggled_on: bool) virtual 🔗

Appelée quand un bouton est basculé (seulement si toggle_mode est actif).

DrawMode get_draw_mode() const 🔗

Renvoie l'état visuel utilisé pour dessiner le bouton. Ceci est utile surtout pour implémenter votre propre code d'affichage en surchargeant _draw() ou en se connectant au signal "draw". L'état visuel du bouton est défini par l’énumération DrawMode.

bool is_hovered() const 🔗

Renvoie true si la souris est entrée dans le bouton mais ne l'a pas encore quitté.

void set_pressed_no_signal(pressed: bool) 🔗

Change l'état button_pressed du bouton, sans émettre toggled. Utilisez lorsque vous voulez simplement changer l'état du bouton sans envoyer l'événement quand il est manuellement pressé (par ex. au moment de l'initialisation de la scène). Fonctionne seulement si toggle_mode est true.

Note : Cette méthode ne désélectionne pas les autres boutons dans son button_group.