Button
Hereda: BaseButton < Control < CanvasItem < Node < Object
Heredado por: CheckBox, CheckButton, ColorPickerButton, MenuButton, OptionButton
Un botón temático que puede contener texto y un icono.
Descripción
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!")
public override void _Ready()
{
var button = new Button();
button.Text = "Click me";
button.Pressed += ButtonPressed;
AddChild(button);
}
private void ButtonPressed()
{
GD.Print("Hello world!");
}
See also BaseButton which contains common properties and methods associated with this node.
Note: Buttons do not detect touch input and therefore don't support multitouch, since mouse emulation can only press one button at a given time. Use TouchScreenButton for buttons that trigger gameplay movement or actions.
Tutoriales
Propiedades
|
||
|
||
BitField[LineBreakFlag] |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Propiedades del Tema
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Descripciones de Propiedades
HorizontalAlignment alignment = 1 🔗
void set_text_alignment(value: HorizontalAlignment)
HorizontalAlignment get_text_alignment()
Política de alineación del texto del botón.
AutowrapMode autowrap_mode = 0 🔗
void set_autowrap_mode(value: AutowrapMode)
AutowrapMode get_autowrap_mode()
Si se establece en un valor distinto de TextServer.AUTOWRAP_OFF, el texto se ajusta dentro del rectángulo delimitador del nodo.
BitField[LineBreakFlag] autowrap_trim_flags = 128 🔗
void set_autowrap_trim_flags(value: BitField[LineBreakFlag])
BitField[LineBreakFlag] get_autowrap_trim_flags()
Flags de recorte de espacio de ajuste automático. Véase TextServer.BREAK_TRIM_START_EDGE_SPACES y TextServer.BREAK_TRIM_END_EDGE_SPACES para más información.
Si es true, el texto que es demasiado grande para caber en el botón se recorta horizontalmente. Si es false, el botón siempre será lo suficientemente ancho como para contener el texto. El texto no se recorta verticalmente, y la altura del botón no se ve afectada por esta propiedad.
Cuando está activado, el icono del botón se expandirá o encogerá para adaptarse al tamaño del botón, manteniendo su aspecto. Véase también icon_max_width.
Los botones planos no muestran decoración.
Icono del botón, si hay texto presente, el icono se colocará antes del texto.
Para editar el margen y el espaciado del icono, usa la propiedad del tema h_separation y las propiedades content_margin_* de los StyleBox usados.
HorizontalAlignment icon_alignment = 0 🔗
void set_icon_alignment(value: HorizontalAlignment)
HorizontalAlignment get_icon_alignment()
Especifica si el icono debe estar alineado horizontalmente a la izquierda, a la derecha o al centro de un botón. Utiliza las mismas constantes de HorizontalAlignment que la alineación del texto. Si está centrado horizontal y verticalmente, el texto se dibujará encima del icono.
Código de idioma utilizado para los algoritmos de salto de línea y forma del texto, si se deja vacío se utiliza la configuración regional actual.
El texto del botón que se mostrará dentro del área del botón.
TextDirection text_direction = 0 🔗
void set_text_direction(value: TextDirection)
TextDirection get_text_direction()
Dirección base de escritura del texto.
OverrunBehavior text_overrun_behavior = 0 🔗
void set_text_overrun_behavior(value: OverrunBehavior)
OverrunBehavior get_text_overrun_behavior()
Sets the clipping behavior when the text exceeds the node's bounding rectangle.
VerticalAlignment vertical_icon_alignment = 1 🔗
void set_vertical_icon_alignment(value: VerticalAlignment)
VerticalAlignment get_vertical_icon_alignment()
Especifica si el icono debe alinearse verticalmente a la parte superior, inferior o al centro de un botón. Utiliza las mismas constantes de VerticalAlignment que la alineación del texto. Si está centrado horizontal y verticalmente, el texto se dibujará encima del icono.
Descripciones de las propiedades del tema
Color font_color = Color(0.875, 0.875, 0.875, 1) 🔗
Color del texto predeterminado del Button.
Color font_disabled_color = Color(0.875, 0.875, 0.875, 0.5) 🔗
Color del texto utilizado cuando el Button está desactivado.
Color font_focus_color = Color(0.95, 0.95, 0.95, 1) 🔗
El Color del texto que se usa cuando el Button está enfocado. Solo reemplaza el color normal del texto del botón. Los estados desactivado, flotante y presionado tienen prioridad sobre este color.
Color font_hover_color = Color(0.95, 0.95, 0.95, 1) 🔗
Color del texto usado cuando el Button tiene encima el cursor.
Color font_hover_pressed_color = Color(1, 1, 1, 1) 🔗
Color del texto utilizado cuando se está pasando el ratón y pulsando el Button.
Color font_outline_color = Color(0, 0, 0, 1) 🔗
El tinte del contorno del texto del Button.
Color font_pressed_color = Color(1, 1, 1, 1) 🔗
Color del texto utilizado cuando se pulsa el Button.
Color icon_disabled_color = Color(1, 1, 1, 0.4) 🔗
Color de modulación del icono que se usa cuando el Button está desactivado.
Color icon_focus_color = Color(1, 1, 1, 1) 🔗
Color de modulación del icono que se usa cuando el Button está enfocado. Solo reemplaza el color de modulación normal del botón. Los estados desactivado, flotante y presionado tienen prioridad sobre este color.
Color icon_hover_color = Color(1, 1, 1, 1) 🔗
Color de modulación del icono que se usa cuando se está pasando el ratón por encima del Button.
Color icon_hover_pressed_color = Color(1, 1, 1, 1) 🔗
Color de modulación del icono que se usa cuando se está pasando el ratón por encima del Button y se está pulsando.
Color icon_normal_color = Color(1, 1, 1, 1) 🔗
Color de modulación del icono predeterminado del Button.
Color icon_pressed_color = Color(1, 1, 1, 1) 🔗
Color de modulación del icono usado cuando se está pulsando el Button.
int align_to_largest_stylebox = 0 🔗
This constant acts as a boolean. If true, the minimum size of the button and text/icon alignment is always based on the largest stylebox margins, otherwise it's based on the current button state stylebox margins.
El espacio horizontal entre el icono y el texto del Button. Los valores negativos se tratarán como 0 cuando se utilicen.
The maximum allowed width of the Button's icon. This limit is applied on top of the default size of the icon, or its expanded size if expand_icon is true. The height is adjusted according to the icon's ratio. If the button has additional icons (e.g. CheckBox), they will also be limited.
Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.
The size of the text outline.
Note: If using a font with FontFile.multichannel_signed_distance_field enabled, its FontFile.msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Font del texto del Button.
Tamaño de fuente del texto del Button.
Icono predeterminado para el Button. Aparece solo si icon no está asignado.
StyleBox usado cuando el Button está desactivado.
StyleBox usado cuando el Button está desactivado (para diseños de derecha a izquierda).
StyleBox used when the Button is focused. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
StyleBox que se usa cuando el Button tiene encima el cursor.
StyleBox utilizado cuando el puntero está sobre el Button (para diseños de derecha a izquierda).
StyleBox utilizado cuando se está pulsando el Button y el puntero está encima a la vez.
StyleBox hover_pressed_mirrored 🔗
StyleBox utilizado cuando se está pulsando el Button y el puntero está encima a la vez (para diseños de derecha a izquierda).
StyleBox por defecto para el Button.
El StyleBox predeterminado para el Button (para diseños de derecha a izquierda).
StyleBox que se usa cuando se presiona el Button.
StyleBox used when the Button is being pressed (for right-to-left layouts).