mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
cf78697eea
Currently including `zh_CN` and `es` which both have very high completion ratios. Others will be added once they reach a significant percentage too. These RST files will be used by godot-docs in place of its `classes` folder after we sync with https://github.com/godotengine/godot-docs/pull/5458. The update workflow is manual for now (example for `zh_CN`): - Build `godotengine/godot` in the branch we currently track (now `3.x`) - Run `godot --doctool -l zh_CN` - Run `cd doc && make rst LANGARG=zh_CN` - Copy `doc/_build/rst/*` to `classes/zh_CN/` here - Make sure to have `classes/zh_CN/index.rst` copied from `docs/classes`
350 lines
17 KiB
ReStructuredText
350 lines
17 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the BaseButton.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_BaseButton:
|
|
|
|
BaseButton
|
|
==========
|
|
|
|
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`Button<class_Button>`, :ref:`LinkButton<class_LinkButton>`, :ref:`TextureButton<class_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.
|
|
|
|
Propiedades
|
|
----------------------
|
|
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`ActionMode<enum_BaseButton_ActionMode>` | :ref:`action_mode<class_BaseButton_property_action_mode>` | ``1`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`button_mask<class_BaseButton_property_button_mask>` | ``1`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`disabled<class_BaseButton_property_disabled>` | ``false`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`FocusMode<enum_Control_FocusMode>` | :ref:`enabled_focus_mode<class_BaseButton_property_enabled_focus_mode>` | ``2`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`ButtonGroup<class_ButtonGroup>` | :ref:`group<class_BaseButton_property_group>` | |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`keep_pressed_outside<class_BaseButton_property_keep_pressed_outside>` | ``false`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`pressed<class_BaseButton_property_pressed>` | ``false`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`ShortCut<class_ShortCut>` | :ref:`shortcut<class_BaseButton_property_shortcut>` | |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`shortcut_in_tooltip<class_BaseButton_property_shortcut_in_tooltip>` | ``true`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` | ``false`` |
|
|
+-----------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+
|
|
|
|
Métodos
|
|
--------------
|
|
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_pressed<class_BaseButton_method__pressed>` **(** **)** |virtual| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_toggled<class_BaseButton_method__toggled>` **(** :ref:`bool<class_bool>` button_pressed **)** |virtual| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`DrawMode<enum_BaseButton_DrawMode>` | :ref:`get_draw_mode<class_BaseButton_method_get_draw_mode>` **(** **)** |const| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_method_is_hovered>` **(** **)** |const| |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_pressed_no_signal<class_BaseButton_method_set_pressed_no_signal>` **(** :ref:`bool<class_bool>` pressed **)** |
|
|
+-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Señales
|
|
--------------
|
|
|
|
.. _class_BaseButton_signal_button_down:
|
|
|
|
- **button_down** **(** **)**
|
|
|
|
Emitido cuando el botón comienza a ser presionado.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_signal_button_up:
|
|
|
|
- **button_up** **(** **)**
|
|
|
|
Emitido cuando el botón deja de ser presionado.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_signal_pressed:
|
|
|
|
- **pressed** **(** **)**
|
|
|
|
Se emite cuando el botón se conmuta o se presiona. Esto está en :ref:`button_down<class_BaseButton_signal_button_down>` si el :ref:`action_mode<class_BaseButton_property_action_mode>` es :ref:`ACTION_MODE_BUTTON_PRESS<class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS>` y en :ref:`button_up<class_BaseButton_signal_button_up>` en caso contrario.
|
|
|
|
Si necesita saber el estado de pulsación del botón (y :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` está activo), utilice :ref:`toggled<class_BaseButton_signal_toggled>` en su lugar.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_signal_toggled:
|
|
|
|
- **toggled** **(** :ref:`bool<class_bool>` button_pressed **)**
|
|
|
|
Emitido cuando el botón acaba de conmutar entre los estados de pulsado y normal (sólo si :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` está activo). El nuevo estado está contenido en el argumento ``button_pressed``.
|
|
|
|
Enumeraciones
|
|
--------------------------
|
|
|
|
.. _enum_BaseButton_DrawMode:
|
|
|
|
.. _class_BaseButton_constant_DRAW_NORMAL:
|
|
|
|
.. _class_BaseButton_constant_DRAW_PRESSED:
|
|
|
|
.. _class_BaseButton_constant_DRAW_HOVER:
|
|
|
|
.. _class_BaseButton_constant_DRAW_DISABLED:
|
|
|
|
.. _class_BaseButton_constant_DRAW_HOVER_PRESSED:
|
|
|
|
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_BaseButton_ActionMode:
|
|
|
|
.. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS:
|
|
|
|
.. _class_BaseButton_constant_ACTION_MODE_BUTTON_RELEASE:
|
|
|
|
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
|
|
--------------------------------------------------------
|
|
|
|
.. _class_BaseButton_property_action_mode:
|
|
|
|
- :ref:`ActionMode<enum_BaseButton_ActionMode>` **action_mode**
|
|
|
|
+-----------+------------------------+
|
|
| *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 :ref:`ActionMode<enum_BaseButton_ActionMode>`.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_button_mask:
|
|
|
|
- :ref:`int<class_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``.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_disabled:
|
|
|
|
- :ref:`bool<class_bool>` **disabled**
|
|
|
|
+-----------+---------------------+
|
|
| *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.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_enabled_focus_mode:
|
|
|
|
- :ref:`FocusMode<enum_Control_FocusMode>` **enabled_focus_mode**
|
|
|
|
+-----------+-------------------------------+
|
|
| *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 :ref:`Control.focus_mode<class_Control_property_focus_mode>` instead.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_group:
|
|
|
|
- :ref:`ButtonGroup<class_ButtonGroup>` **group**
|
|
|
|
+----------+-------------------------+
|
|
| *Setter* | set_button_group(value) |
|
|
+----------+-------------------------+
|
|
| *Getter* | get_button_group() |
|
|
+----------+-------------------------+
|
|
|
|
:ref:`ButtonGroup<class_ButtonGroup>` asociado al botón.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_keep_pressed_outside:
|
|
|
|
- :ref:`bool<class_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.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_pressed:
|
|
|
|
- :ref:`bool<class_bool>` **pressed**
|
|
|
|
+-----------+--------------------+
|
|
| *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 :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is active). Only works if :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is ``true``.
|
|
|
|
\ **Note:** Setting :ref:`pressed<class_BaseButton_property_pressed>` will result in :ref:`toggled<class_BaseButton_signal_toggled>` to be emitted. If you want to change the pressed state without emitting that signal, use :ref:`set_pressed_no_signal<class_BaseButton_method_set_pressed_no_signal>`.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_shortcut:
|
|
|
|
- :ref:`ShortCut<class_ShortCut>` **shortcut**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_shortcut(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | get_shortcut() |
|
|
+----------+---------------------+
|
|
|
|
Atajo de teclado asociado al botón.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_shortcut_in_tooltip:
|
|
|
|
- :ref:`bool<class_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.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_property_toggle_mode:
|
|
|
|
- :ref:`bool<class_bool>` **toggle_mode**
|
|
|
|
+-----------+------------------------+
|
|
| *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
|
|
------------------------------------------------
|
|
|
|
.. _class_BaseButton_method__pressed:
|
|
|
|
- void **_pressed** **(** **)** |virtual|
|
|
|
|
Se llama cuando se presiona el botón. Si necesita saber el estado de pulsación del botón (y :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` está activo), utilice en su lugar el :ref:`_toggled<class_BaseButton_method__toggled>`.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method__toggled:
|
|
|
|
- void **_toggled** **(** :ref:`bool<class_bool>` button_pressed **)** |virtual|
|
|
|
|
Se llama cuando se cambia el estado del botón(Activado/Desactivado) (sólo si :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` está activo).
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method_get_draw_mode:
|
|
|
|
- :ref:`DrawMode<enum_BaseButton_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 :ref:`DrawMode<enum_BaseButton_DrawMode>`.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method_is_hovered:
|
|
|
|
- :ref:`bool<class_bool>` **is_hovered** **(** **)** |const|
|
|
|
|
Devuelve ``true`` si el ratón ha entrado en el botón y no lo ha dejado todavía.
|
|
|
|
----
|
|
|
|
.. _class_BaseButton_method_set_pressed_no_signal:
|
|
|
|
- void **set_pressed_no_signal** **(** :ref:`bool<class_bool>` pressed **)**
|
|
|
|
Changes the :ref:`pressed<class_BaseButton_property_pressed>` state of the button, without emitting :ref:`toggled<class_BaseButton_signal_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 :ref:`toggle_mode<class_BaseButton_property_toggle_mode>` is ``true``.
|
|
|
|
\ **Note:** This method doesn't unpress other buttons in its button :ref:`group<class_BaseButton_property_group>`.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|