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

Eredita: Control < CanvasItem < Node < Object

Ereditato da: Button, LinkButton, TextureButton

Classe di base astratta per i pulsanti della GUI.

Descrizione

BaseButton è una classe di base astratta per pulsanti della GUI. Da solo non visualizza nulla.

Proprietà

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

Metodi

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)

Segnali

button_down() 🔗

Emesso quando il pulsante comincia a essere premuto.

button_up() 🔗

Emesso quando il pulsante smette di essere premuto.

pressed() 🔗

Emesso quando il pulsante viene commutato o premuto. Questo è su button_down se action_mode è ACTION_MODE_BUTTON_PRESS e su button_up altrimenti.

Se hai bisogno di conoscere lo stato di pressione del pulsante (e toggle_mode è attivo), usa invece toggled.

toggled(toggled_on: bool) 🔗

Emesso quando il pulsante è stato appena commutato tra lo stato premuto e lo stato normale (solo se toggle_mode è attivo). Il nuovo stato è contenuto nell'argomento toggled_on.

Enumerazioni

enum DrawMode: 🔗

DrawMode DRAW_NORMAL = 0

Lo stato normale (ovvero non premuto, non passato dal mouse, non attivato e abilitato) dei pulsanti.

DrawMode DRAW_PRESSED = 1

Lo stato dei pulsanti è premuto.

DrawMode DRAW_HOVER = 2

Lo stato dei pulsanti che hanno il cursore sopra.

DrawMode DRAW_DISABLED = 3

Lo stato dei pulsanti è disattivato.

DrawMode DRAW_HOVER_PRESSED = 4

Lo stato dei pulsanti sono sia con il cursore sopra e premuto.

enum ActionMode: 🔗

ActionMode ACTION_MODE_BUTTON_PRESS = 0

Richiede solo una pressione per considerare il pulsante come cliccato.

ActionMode ACTION_MODE_BUTTON_RELEASE = 1

Richiedere una pressione e un successivo rilascio prima di considerare il pulsante come cliccato.

Descrizioni delle proprietà

ActionMode action_mode = 1 🔗

Determina quando il pulsante viene considerato cliccato.

ButtonGroup button_group 🔗

Il ButtonGroup associato al pulsante. Da non confondere con i gruppi di nodi.

Nota: Il pulsante verrà configurato come pulsante di opzione se gli viene assegnato un ButtonGroup.

BitField[MouseButtonMask] button_mask = 1 🔗

Maschera binaria per scegliere a quali pulsanti del mouse questo pulsante risponderà.

Per consentire sia il clic sinistro sia il clic destro, usa MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT.

bool button_pressed = false 🔗

  • void set_pressed(value: bool)

  • bool is_pressed()

Se true, lo stato del pulsante è premuto. Significa che il pulsante è premuto o commutato (se toggle_mode è attivo). Funziona solo se toggle_mode è true.

Nota: Cambiando il valore di button_pressed verrà emesso toggled. Se si desidera cambiare lo stato di pressione senza emettere quel segnale, usa set_pressed_no_signal().

bool disabled = false 🔗

  • void set_disabled(value: bool)

  • bool is_disabled()

Se true, il pulsante è disabilitato e non può essere cliccato o commutato.

Nota: Se il pulsante viene disattivato mentre è tenuto premuto, verrà emesso button_up .

bool keep_pressed_outside = false 🔗

  • void set_keep_pressed_outside(value: bool)

  • bool is_keep_pressed_outside()

Se true, il pulsante rimane premuto quando si sposta il cursore fuori dal pulsante mentre lo si preme.

Nota: Questa proprietà influisce solo sull'aspetto visivo del pulsante. I segnali saranno emessi nello stesso momento a prescindere dal valore di questa proprietà.

Shortcut shortcut 🔗

La scorciatoia associata al pulsante.

bool shortcut_feedback = true 🔗

  • void set_shortcut_feedback(value: bool)

  • bool is_shortcut_feedback()

Se true, il pulsante verrà evidenziato per un breve periodo di tempo quando la sua scorciatoia viene attivata. Se false e toggle_mode è false, la scorciatoia si attiverà senza alcun feedback visivo.

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()

Se true, il pulsante è in modalità di commutazione. Fa invertire lo stato del pulsante da premuto a non premuto ogni volta che si clicca sulla sua area.

Descrizioni dei metodi

void _pressed() virtual 🔗

Chiamato quando il pulsante viene premuto. Se hai bisogno di conoscere lo stato di pressione del pulsante (e se toggle_mode è attivo), usa invece _toggled().

void _toggled(toggled_on: bool) virtual 🔗

Chiamato quando il pulsante è commutato (solo se toggle_mode è attivo).

DrawMode get_draw_mode() const 🔗

Restituisce lo stato visivo utilizzato per disegnare il pulsante. Ciò è utile principalmente quando si implementa il proprio codice di disegno sovrascrivendo _draw() o collegandosi al segnale "draw". Lo stato visivo del pulsante è definito dall'enumerazione DrawMode.

bool is_hovered() const 🔗

Restituisce true se il mouse è entrato nel pulsante e non lo ha ancora lasciato.

void set_pressed_no_signal(pressed: bool) 🔗

Cambia lo stato button_pressed del pulsante, senza emettere toggled. Da usare quando si desidera solo cambiare lo stato del pulsante senza inviare l'evento premuto (ad esempio quando si inizializza una scena). Funziona solo se toggle_mode è true.

Nota: Questo metodo non rilascia gli altri pulsanti in button_group.