BaseButton

Inherits: Control < CanvasItem < Node < Object

Inherited By: Button, LinkButton, TextureButton

Clase base para diferentes tipos de botones.

Descripción

BaseButton es la clase base abstracta para los botones, por lo que no debe usarse directamente (no muestra nada). Otros tipos de botones heredan de ella.

Métodos

void

_pressed ( ) virtual

void

_toggled ( bool button_pressed ) virtual

DrawMode

get_draw_mode ( ) const

bool

is_hovered ( ) const

void

set_pressed_no_signal ( bool pressed )

Señales

  • button_down ( )

Emitido cuando el botón comienza a ser presionado.


  • button_up ( )

Emitido cuando el botón deja de ser presionado.


  • pressed ( )

Se emite 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 necesita saber el estado de pulsación del botón (y toggle_mode está activo), utilice toggled en su lugar.


  • toggled ( bool button_pressed )

Emitido cuando el botón acaba de conmutar entre los estados de pulsado y normal (sólo si toggle_mode está activo). El nuevo estado está contenido en el argumento button_pressed.

Enumeraciones

enum DrawMode:

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

  • DRAW_PRESSED = 1 --- El estado de los botones se presiona.

  • DRAW_HOVER = 2 --- El estado de los botones que tienen el cursor encima.

  • DRAW_DISABLED = 3 --- El estado de los botones está desactivado.

  • DRAW_HOVER_PRESSED = 4 --- El estado de los botones cuyo cursor esta encima y se presiona.


enum ActionMode:

  • ACTION_MODE_BUTTON_PRESS = 0 --- Requiere sólo una pulsación para considerar el botón pulsado.

  • 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

Default

1

Setter

set_action_mode(value)

Getter

get_action_mode()

Determina cuándo se considera que se ha hecho clic en el botón, una de las constantes de ActionMode.


  • int button_mask

Default

1

Setter

set_button_mask(value)

Getter

get_button_mask()

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

Para permitir tanto el clic izquierdo como el derecho, use el BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT.


Default

false

Setter

set_disabled(value)

Getter

is_disabled()

Si true, el botón está en estado de desactivación y no se puede hacer clic o alternar el estado.


Default

2

Setter

set_enabled_focus_mode(value)

Getter

get_enabled_focus_mode()

Deprecated. This property has been deprecated due to redundancy and will be removed in Godot 4.0. This property no longer has any effect when set. Please use Control.focus_mode instead.


Setter

set_button_group(value)

Getter

get_button_group()

ButtonGroup asociado al botón.


  • bool keep_pressed_outside

Default

false

Setter

set_keep_pressed_outside(value)

Getter

is_keep_pressed_outside()

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


Default

false

Setter

set_pressed(value)

Getter

is_pressed()

If true, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). Only works if toggle_mode is true.

Note: Setting pressed will result in toggled to be emitted. If you want to change the pressed state without emitting that signal, use set_pressed_no_signal.


Setter

set_shortcut(value)

Getter

get_shortcut()

Atajo de teclado asociado al botón.


  • bool shortcut_in_tooltip

Default

true

Setter

set_shortcut_in_tooltip(value)

Getter

is_shortcut_in_tooltip_enabled()

Si true, el botón añadirá información sobre su atajo en el mensaje de ayuda.


Default

false

Setter

set_toggle_mode(value)

Getter

is_toggle_mode()

Si 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 necesita saber el estado de pulsación del botón (y toggle_mode está activo), utilice en su lugar el _toggled.


  • void _toggled ( bool button_pressed ) virtual

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


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

Changes the pressed state of the button, without emitting toggled. Use when you just want to change the state of the button without sending the pressed event (e.g. when initializing scene). Only works if toggle_mode is true.

Note: This method doesn't unpress other buttons in its button group.