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.

Button

Eredita: BaseButton < Control < CanvasItem < Node < Object

Ereditato da: CheckBox, CheckButton, ColorPickerButton, MenuButton, OptionButton

Un pulsante con tema che può contenere testo e un'icona.

Descrizione

Button is the standard themed button. It can contain text and an icon, and it will display them according to the current Theme.

Example: Create a button and connect a method that will be called when the button is pressed:

func _ready():
    var button = Button.new()
    button.text = "Click me"
    button.pressed.connect(_button_pressed)
    add_child(button)

func _button_pressed():
    print("Hello world!")

See also BaseButton which contains common properties and methods associated with this node.

Note: Buttons support multitouch via touch input, allowing multiple buttons to be pressed at the same time. Otherwise, mouse input is used, limiting interaction to one button press at a time.

Tutorial

Proprietà

HorizontalAlignment

alignment

1

AutowrapMode

autowrap_mode

0

BitField[LineBreakFlag]

autowrap_trim_flags

128

bool

clip_text

false

bool

expand_icon

false

bool

flat

false

Texture2D

icon

HorizontalAlignment

icon_alignment

0

String

language

""

String

text

""

TextDirection

text_direction

0

OverrunBehavior

text_overrun_behavior

0

VerticalAlignment

vertical_icon_alignment

1

Proprietà del tema

Color

font_color

Color(0.875, 0.875, 0.875, 1)

Color

font_disabled_color

Color(0.875, 0.875, 0.875, 0.5)

Color

font_focus_color

Color(0.95, 0.95, 0.95, 1)

Color

font_hover_color

Color(0.95, 0.95, 0.95, 1)

Color

font_hover_pressed_color

Color(1, 1, 1, 1)

Color

font_outline_color

Color(0, 0, 0, 1)

Color

font_pressed_color

Color(1, 1, 1, 1)

Color

icon_disabled_color

Color(1, 1, 1, 0.4)

Color

icon_focus_color

Color(1, 1, 1, 1)

Color

icon_hover_color

Color(1, 1, 1, 1)

Color

icon_hover_pressed_color

Color(1, 1, 1, 1)

Color

icon_normal_color

Color(1, 1, 1, 1)

Color

icon_pressed_color

Color(1, 1, 1, 1)

int

align_to_largest_stylebox

0

int

h_separation

4

int

icon_max_width

0

int

line_spacing

0

int

outline_size

0

Font

font

int

font_size

Texture2D

icon

StyleBox

disabled

StyleBox

disabled_mirrored

StyleBox

focus

StyleBox

hover

StyleBox

hover_mirrored

StyleBox

hover_pressed

StyleBox

hover_pressed_mirrored

StyleBox

normal

StyleBox

normal_mirrored

StyleBox

pressed

StyleBox

pressed_mirrored


Descrizioni delle proprietà

HorizontalAlignment alignment = 1 🔗

Criterio di allineamento del testo per il testo del pulsante.


AutowrapMode autowrap_mode = 0 🔗

Se impostato a un valore diverso da TextServer.AUTOWRAP_OFF, il testo è racchiuso all'interno del rettangolo di delimitazione del nodo.


BitField[LineBreakFlag] autowrap_trim_flags = 128 🔗

Flag di troncamento spazi per il ritorno a capo automatico. Vedi TextServer.BREAK_TRIM_START_EDGE_SPACES e TextServer.BREAK_TRIM_END_EDGE_SPACES per ulteriori informazioni.


bool clip_text = false 🔗

  • void set_clip_text(value: bool)

  • bool get_clip_text()

Se true, il testo che è troppo grande per adattarsi al pulsante è ritagliato orizzontalmente. Se false, il pulsante sarà sempre abbastanza largo da contenere il testo. Il testo non è ritagliato verticalmente e l'altezza del pulsante non è influenzata da questa proprietà.


bool expand_icon = false 🔗

  • void set_expand_icon(value: bool)

  • bool is_expand_icon()

Quando abilitata, l'icona del pulsante si espanderà o rimpicciolirà per adattarsi alle dimensioni del pulsante, mantenendo il suo aspetto. Vedi anche icon_max_width.


bool flat = false 🔗

  • void set_flat(value: bool)

  • bool is_flat()

I pulsanti piatti non visualizzano decorazioni.


Texture2D icon 🔗

L'icona del pulsante. Se è presente testo, l'icona sarà posizionata prima del testo.

Per modificare il margine e la spaziatura dell'icona, usa la proprietà del tema h_separation e le proprietà content_margin_* degli StyleBox utilizzati.


HorizontalAlignment icon_alignment = 0 🔗

Specifica se l'icona deve essere allineata orizzontalmente a sinistra, a destra o al centro di un pulsante. Utilizza le stesse costanti HorizontalAlignment dell'allineamento del testo. Se centrato orizzontalmente e verticalmente, il testo sarà disegnato sopra l'icona.


String language = "" 🔗

Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.


String text = "" 🔗

Il testo del pulsante che sarà visualizzato all'interno dell'area del pulsante.


TextDirection text_direction = 0 🔗

Direzione di scrittura del testo di base.


OverrunBehavior text_overrun_behavior = 0 🔗

Imposta il comportamento di ritaglio quando il testo supera il rettangolo di delimitazione del nodo.


VerticalAlignment vertical_icon_alignment = 1 🔗

Specifica se l'icona deve essere allineata verticalmente in alto, in basso, o al centro di un pulsante. Usa le stesse costanti VerticalAlignment dell'allineamento del testo. Se centrato orizzontalmente e verticalmente, il testo sarà disegnato sopra l'icona.


Descrizioni delle proprietà del tema

Color font_color = Color(0.875, 0.875, 0.875, 1) 🔗

Color predefinito del testo del Button.


Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5) 🔗

Color del testo utilizzato quando il Button è disabilitato.


Color font_focus_color = Color(0.95, 0.95, 0.95, 1) 🔗

Color del testo utilizzato quando il Button è focalizzato. Sostituisce solo il colore normale del testo del pulsante. I colori definiti per gli stati disabilitato, al passaggio del mouse e premuto hanno la precedenza su questo colore.


Color font_hover_color = Color(0.95, 0.95, 0.95, 1) 🔗

Color del testo utilizzato quando il Button è passato dal cursore del mouse.


Color font_hover_pressed_color = Color(1, 1, 1, 1) 🔗

Color del testo utilizzato quando il Button è passato dal mouse e premuto.


Color font_outline_color = Color(0, 0, 0, 1) 🔗

La tinta del contorno del testo del Button.


Color font_pressed_color = Color(1, 1, 1, 1) 🔗

Color del testo utilizzato quando il Button è premuto.


Color icon_disabled_color = Color(1, 1, 1, 0.4) 🔗

Color di modulazione dell'icona utilizzato quando il Button è disabilitato.


Color icon_focus_color = Color(1, 1, 1, 1) 🔗

Color di modulazione dell'icona utilizzato quando il Button è focalizzato. Sostituisce solo il colore normale di modulazione del pulsante. I colori degli stati disabilitato, al passaggio del mouse e premuto hanno la precedenza su questo colore.


Color icon_hover_color = Color(1, 1, 1, 1) 🔗

Color di modulazione dell'icona utilizzato quando il Button è passato dal cursore del mouse.


Color icon_hover_pressed_color = Color(1, 1, 1, 1) 🔗

Color di modulazione dell'icona utilizzato quando il Button è passato dal mouse e premuto.


Color icon_normal_color = Color(1, 1, 1, 1) 🔗

Color di modulazione predefinito dell'icona del Button.


Color icon_pressed_color = Color(1, 1, 1, 1) 🔗

Color di modulazione dell'icona usato quando il Button è premuto.


int align_to_largest_stylebox = 0 🔗

Questa costante agisce come un valore booleano. Se true, la dimensione minima del pulsante e l'allineamento del testo e dell'icona si basa sempre sui margini più grandi della stylebox, altrimenti si basa sui margini dello stylebox dello stato corrente del pulsante.


int h_separation = 4 🔗

Lo spazio orizzontale tra l'icona e il testo del Button. I valori negativi saranno trattati come 0 quando usati.


int icon_max_width = 0 🔗

La larghezza massima consentita dell'icona del Button. Questo limite è applicato oltre alla dimensione predefinita dell'icona o alla sua dimensione espansa se expand_icon è true. L'altezza è regolata in base al rapporto dell'icona. Se il pulsante ha icone aggiuntive (ad esempio CheckBox), anche queste saranno limitate.


int line_spacing = 0 🔗

Spaziatura verticale aggiuntiva tra le righe (in pixel), la spaziatura è aggiunta alla discesa della riga. Questo valore può essere negativo.


int outline_size = 0 🔗

La dimensione del contorno del testo.

Nota: Se si utilizza un font con FontFile.multichannel_signed_distance_field abilitato, il suo FontFile.msdf_pixel_range deve essere impostato su almeno il doppio del valore di outline_size affinché il rendering del contorno appaia corretto. Altrimenti, il contorno potrebbe apparire troncato prima del previsto.


Font font 🔗

Font del testo del Button.


int font_size 🔗

Dimensione del Font del testo del Button.


Texture2D icon 🔗

Icona predefinita per il Button. È visualizzato solo se icon non è assegnata.


StyleBox disabled 🔗

StyleBox utilizzato quando il Button è disabilitato.


StyleBox disabled_mirrored 🔗

StyleBox utilizzato quando il Button è disabilitato (per i layout da destra a sinistra).


StyleBox focus 🔗

StyleBox utilizzato quando il Button è focalizzato. Lo StyleBox di focus è visualizzato sopra lo StyleBox di base, quindi è necessario utilizzare uno StyleBox parzialmente trasparente per garantire che lo StyleBox di base rimanga visibile. Uno StyleBox che rappresenta un contorno o una sottolineatura funziona bene per questo scopo. Per disabilitare l'effetto visivo del focus, assegna una risorsa StyleBoxEmpty. Tieni presente che disattivare l'effetto visivo di focus ridurrà l'usabilità della navigazione tramite tastiera o controller, perciò non è consigliato per motivi di accessibilità.


StyleBox hover 🔗

StyleBox utilizzato quando si passa il mouse sul Button.


StyleBox hover_mirrored 🔗

StyleBox utilizzato quando si passa il mouse sul Button (per i layout da destra a sinistra).


StyleBox hover_pressed 🔗

StyleBox utilizzato quando il Button è premuto e si passa il mouse allo stesso tempo.


StyleBox hover_pressed_mirrored 🔗

StyleBox utilizzato quando il Button è premuto e si passa il mouse allo stesso tempo (per i layout da destra a sinistra).


StyleBox normal 🔗

StyleBox predefinito per il Button.


StyleBox normal_mirrored 🔗

StyleBox predefinito per il Button (per i layout da destra a sinistra).


StyleBox pressed 🔗

StyleBox utilizzato quando il Button è premuto.


StyleBox pressed_mirrored 🔗

StyleBox utilizzato quando il Button è premuto (per i layout da destra a sinistra).