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

Hereda: Control < CanvasItem < Node < Object

Heredado por: Button, LinkButton, TextureButton

Clase base abstracta para botones GUI.

Descripción

BaseButton es una clase base abstracta para botones de interfaz gráfica. No muestra nada por sí sola.

Propiedades

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étodos

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)

Señales

button_down() 🔗

Emitida cuando el botón comienza a ser presionado.

button_up() 🔗

Emitida cuando el botón deja de ser presionado.

pressed() 🔗

Emitida cuando el botón se conmuta o se presiona. Esto está en button_down si el action_mode es ACTION_MODE_BUTTON_PRESS y en button_up en caso contrario.

Si necesitas saber el estado de pulsación del botón (y toggle_mode está activo), utiliza toggled en su lugar.

toggled(toggled_on: bool) 🔗

Se emite cuando el botón acaba de conmutar entre los estados presionado y normal (solo si toggle_mode está activo). El nuevo estado se incluye en el argumento toggled_on.

Enumeraciones

enum DrawMode: 🔗

DrawMode DRAW_NORMAL = 0

El estado normal (es decir, no presionado, no encima del botón, no activado y activado) de los botones.

DrawMode DRAW_PRESSED = 1

El estado de los botones se presiona.

DrawMode DRAW_HOVER = 2

El estado de los botones que tienen el cursor encima.

DrawMode DRAW_DISABLED = 3

El estado de los botones está desactivado.

DrawMode DRAW_HOVER_PRESSED = 4

El estado de los botones cuyo cursor esta encima y se presiona.

enum ActionMode: 🔗

ActionMode ACTION_MODE_BUTTON_PRESS = 0

Requiere sólo una pulsación para considerar el botón pulsado.

ActionMode ACTION_MODE_BUTTON_RELEASE = 1

Requiere de una pulsación y una posterior liberación antes de considerar el botón pulsado.

Descripciones de Propiedades

ActionMode action_mode = 1 🔗

Determina cuándo se considera que se hizo clic en el botón.

ButtonGroup button_group 🔗

El ButtonGroup asociado con el botón. No confundir con grupos de nodos.

Nota: El botón se configurará como un botón de opción si se le asigna un ButtonGroup.

BitField[MouseButtonMask] button_mask = 1 🔗

Máscara binaria para elegir a qué botones del ratón responderá este botón.

Para permitir clics izquierdo y derecho, utiliza MOUSE_BUTTON_MASK_LEFT | MOUSE_BUTTON_MASK_RIGHT.

bool button_pressed = false 🔗

  • void set_pressed(value: bool)

  • bool is_pressed()

Si es true, el estado del botón es presionado. Significa que el botón está hundido o activado (si toggle_mode está activo). Solo funciona si toggle_mode es true.

Nota: Cambiar el valor de button_pressed resultará en la emisión de la señal toggled. Si deseas cambiar el estado de presión sin emitir esa señal, utiliza set_pressed_no_signal().

bool disabled = false 🔗

  • void set_disabled(value: bool)

  • bool is_disabled()

Si es true, el botón está en estado deshabilitado y no se puede hacer clic ni alternar.

Nota: Si el botón se deshabilita mientras se mantiene presionado, se emitirá button_up.

bool keep_pressed_outside = false 🔗

  • void set_keep_pressed_outside(value: bool)

  • bool is_keep_pressed_outside()

Si es true, el botón permanecee pulsado cuando el cursor se mueve fuera mientras se presiona.

Nota: Esta propiedad solo afecta la apariencia visual del botón. Se emitirán señales en el mismo momento sin tener en cuenta el valor de esta propiedad.

Shortcut shortcut 🔗

Shortcut asociado al botón.

bool shortcut_feedback = true 🔗

  • void set_shortcut_feedback(value: bool)

  • bool is_shortcut_feedback()

Si es true, el botón se resaltará durante un breve periodo de tiempo cuando se active su atajo. Si es false y toggle_mode es false, el atajo se activará sin ningún tipo de respuesta visual.

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 es true, el botón está en modo de conmutación. Hace que el botón cambie de estado entre presionado y no presionado cada vez que se hace clic en su área.

Descripciones de Métodos

void _pressed() virtual 🔗

Se llama cuando se presiona el botón. Si necesitas saber el estado de pulsación del botón (y toggle_mode está activo), utiliza en su lugar el _toggled().

void _toggled(toggled_on: bool) virtual 🔗

Se llama cuando se cambia el estado del botón(Activado/Desactivado) (sólo si toggle_mode está activo).

DrawMode get_draw_mode() const 🔗

Devuelve el estado visual utilizado para dibujar el botón. Esto es útil principalmente cuando implementas tu propio código de dibujo, ya sea anulando _draw() o conectando la señal de "dibujo". El estado visual del botón está definido por el enum DrawMode.

bool is_hovered() const 🔗

Devuelve true si el ratón ha entrado en el botón y no lo ha dejado todavía.

void set_pressed_no_signal(pressed: bool) 🔗

Cambia el estado de button_pressed del botón, sin emitir toggled. Úsalo cuando solo quieras cambiar el estado del botón sin enviar el evento de pulsado (por ejemplo, al inicializar la escena). Solo funciona si toggle_mode está en true.

Nota: Este método no desactiva otros botones en button_group.