mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-04 10:09:56 +03:00
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`
335 lines
14 KiB
ReStructuredText
335 lines
14 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 Button.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_Button:
|
|
|
|
Button
|
|
======
|
|
|
|
**Inherits:** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Inherited By:** :ref:`CheckBox<class_CheckBox>`, :ref:`CheckButton<class_CheckButton>`, :ref:`ColorPickerButton<class_ColorPickerButton>`, :ref:`MenuButton<class_MenuButton>`, :ref:`OptionButton<class_OptionButton>`, :ref:`ToolButton<class_ToolButton>`
|
|
|
|
Botón temático estándar.
|
|
|
|
Descripción
|
|
----------------------
|
|
|
|
Button is the standard themed button. It can contain text and an icon, and will display them according to the current :ref:`Theme<class_Theme>`.
|
|
|
|
\ **Example of creating a button and assigning an action when pressed by code:**\
|
|
|
|
::
|
|
|
|
func _ready():
|
|
var button = Button.new()
|
|
button.text = "Click me"
|
|
button.connect("pressed", self, "_button_pressed")
|
|
add_child(button)
|
|
|
|
func _button_pressed():
|
|
print("Hello world!")
|
|
|
|
Buttons (like all Control nodes) can also be created in the editor, but some situations may require creating them from code.
|
|
|
|
See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
|
|
|
|
\ **Note:** Buttons do not interpret touch input and therefore don't support multitouch, since mouse emulation can only press one button at a given time. Use :ref:`TouchScreenButton<class_TouchScreenButton>` for buttons that trigger gameplay movement or actions, as :ref:`TouchScreenButton<class_TouchScreenButton>` supports multitouch.
|
|
|
|
Tutoriales
|
|
--------------------
|
|
|
|
- `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
|
|
|
|
- `OS Test Demo <https://godotengine.org/asset-library/asset/677>`__
|
|
|
|
Propiedades
|
|
----------------------
|
|
|
|
+-----------------------------------------+-------------------------------------------------------+-----------+
|
|
| :ref:`TextAlign<enum_Button_TextAlign>` | :ref:`align<class_Button_property_align>` | ``1`` |
|
|
+-----------------------------------------+-------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`clip_text<class_Button_property_clip_text>` | ``false`` |
|
|
+-----------------------------------------+-------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`expand_icon<class_Button_property_expand_icon>` | ``false`` |
|
|
+-----------------------------------------+-------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`flat<class_Button_property_flat>` | ``false`` |
|
|
+-----------------------------------------+-------------------------------------------------------+-----------+
|
|
| :ref:`Texture<class_Texture>` | :ref:`icon<class_Button_property_icon>` | |
|
|
+-----------------------------------------+-------------------------------------------------------+-----------+
|
|
| :ref:`String<class_String>` | :ref:`text<class_Button_property_text>` | ``""`` |
|
|
+-----------------------------------------+-------------------------------------------------------+-----------+
|
|
|
|
Propiedades del Theme
|
|
------------------------------------------
|
|
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color<class_Button_theme_color_font_color>` | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_disabled<class_Button_theme_color_font_color_disabled>` | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_focus<class_Button_theme_color_font_color_focus>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_hover<class_Button_theme_color_font_color_hover>` | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color_pressed<class_Button_theme_color_font_color_pressed>` | ``Color( 1, 1, 1, 1 )`` |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`hseparation<class_Button_theme_constant_hseparation>` | ``2`` |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`Font<class_Font>` | :ref:`font<class_Button_theme_font_font>` | |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`disabled<class_Button_theme_style_disabled>` | |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_Button_theme_style_focus>` | |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`hover<class_Button_theme_style_hover>` | |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_Button_theme_style_normal>` | |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`pressed<class_Button_theme_style_pressed>` | |
|
|
+---------------------------------+--------------------------------------------------------------------------+----------------------------------+
|
|
|
|
Enumeraciones
|
|
--------------------------
|
|
|
|
.. _enum_Button_TextAlign:
|
|
|
|
.. _class_Button_constant_ALIGN_LEFT:
|
|
|
|
.. _class_Button_constant_ALIGN_CENTER:
|
|
|
|
.. _class_Button_constant_ALIGN_RIGHT:
|
|
|
|
enum **TextAlign**:
|
|
|
|
- **ALIGN_LEFT** = **0** --- Alinea el texto a la izquierda.
|
|
|
|
- **ALIGN_CENTER** = **1** --- Alinea el texto con el centro.
|
|
|
|
- **ALIGN_RIGHT** = **2** --- Alinea el texto a la derecha.
|
|
|
|
Descripciones de Propiedades
|
|
--------------------------------------------------------
|
|
|
|
.. _class_Button_property_align:
|
|
|
|
- :ref:`TextAlign<enum_Button_TextAlign>` **align**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``1`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_text_align(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_text_align() |
|
|
+-----------+-----------------------+
|
|
|
|
Política de alineación de texto para el texto del botón, usa una de las constantes :ref:`TextAlign<enum_Button_TextAlign>`.
|
|
|
|
----
|
|
|
|
.. _class_Button_property_clip_text:
|
|
|
|
- :ref:`bool<class_bool>` **clip_text**
|
|
|
|
+-----------+----------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+----------------------+
|
|
| *Setter* | set_clip_text(value) |
|
|
+-----------+----------------------+
|
|
| *Getter* | get_clip_text() |
|
|
+-----------+----------------------+
|
|
|
|
Cuando esta propiedad está activada, el texto que es demasiado grande para caber en el botón se recorta, cuando está desactivada el botón siempre será lo suficientemente ancho para contener el texto.
|
|
|
|
----
|
|
|
|
.. _class_Button_property_expand_icon:
|
|
|
|
- :ref:`bool<class_bool>` **expand_icon**
|
|
|
|
+-----------+------------------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+------------------------+
|
|
| *Setter* | set_expand_icon(value) |
|
|
+-----------+------------------------+
|
|
| *Getter* | is_expand_icon() |
|
|
+-----------+------------------------+
|
|
|
|
Cuando se habilita, el icono del botón se expandirá o encogerá para adaptarse al tamaño del botón, manteniendo su aspecto.
|
|
|
|
----
|
|
|
|
.. _class_Button_property_flat:
|
|
|
|
- :ref:`bool<class_bool>` **flat**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | ``false`` |
|
|
+-----------+-----------------+
|
|
| *Setter* | set_flat(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | is_flat() |
|
|
+-----------+-----------------+
|
|
|
|
Los botones planos no muestran decoración.
|
|
|
|
----
|
|
|
|
.. _class_Button_property_icon:
|
|
|
|
- :ref:`Texture<class_Texture>` **icon**
|
|
|
|
+----------+------------------------+
|
|
| *Setter* | set_button_icon(value) |
|
|
+----------+------------------------+
|
|
| *Getter* | get_button_icon() |
|
|
+----------+------------------------+
|
|
|
|
Button's icon, if text is present the icon will be placed before the text.
|
|
|
|
To edit margin and spacing of the icon, use ``hseparation`` theme property of ``Button`` and ``content_margin_*`` properties of the used :ref:`StyleBox<class_StyleBox>`\ es.
|
|
|
|
----
|
|
|
|
.. _class_Button_property_text:
|
|
|
|
- :ref:`String<class_String>` **text**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | ``""`` |
|
|
+-----------+-----------------+
|
|
| *Setter* | set_text(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_text() |
|
|
+-----------+-----------------+
|
|
|
|
El texto del botón que se mostrará dentro del área del botón.
|
|
|
|
Theme Property Descriptions
|
|
---------------------------
|
|
|
|
.. _class_Button_theme_color_font_color:
|
|
|
|
- :ref:`Color<class_Color>` **font_color**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``Color( 0.88, 0.88, 0.88, 1 )`` |
|
|
+-----------+----------------------------------+
|
|
|
|
:ref:`Color<class_Color>` del texto predeterminado del ``Button``.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_color_font_color_disabled:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_disabled**
|
|
|
|
+-----------+---------------------------------+
|
|
| *Default* | ``Color( 0.9, 0.9, 0.9, 0.2 )`` |
|
|
+-----------+---------------------------------+
|
|
|
|
:ref:`Color<class_Color>` del texto utilizado cuando el ``Button`` está desactivado.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_color_font_color_focus:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_focus**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+-----------+----------------------------------+
|
|
|
|
Text :ref:`Color<class_Color>` used when the ``Button`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_color_font_color_hover:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_hover**
|
|
|
|
+-----------+----------------------------------+
|
|
| *Default* | ``Color( 0.94, 0.94, 0.94, 1 )`` |
|
|
+-----------+----------------------------------+
|
|
|
|
:ref:`Color<class_Color>` del texto usado cuando el ``Button`` tiene encima el cursor.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_color_font_color_pressed:
|
|
|
|
- :ref:`Color<class_Color>` **font_color_pressed**
|
|
|
|
+-----------+-------------------------+
|
|
| *Default* | ``Color( 1, 1, 1, 1 )`` |
|
|
+-----------+-------------------------+
|
|
|
|
:ref:`Color<class_Color>` del texto utilizado cuando se pulsa el ``Button``.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_constant_hseparation:
|
|
|
|
- :ref:`int<class_int>` **hseparation**
|
|
|
|
+-----------+-------+
|
|
| *Default* | ``2`` |
|
|
+-----------+-------+
|
|
|
|
El espacio horizontal entre el icono y el texto de ``Button``.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_font_font:
|
|
|
|
- :ref:`Font<class_Font>` **font**
|
|
|
|
:ref:`Font<class_Font>` del texto del ``Button``.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_style_disabled:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **disabled**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` usado cuando el ``Button`` está desactivado.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_style_focus:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **focus**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` que se usa cuando el ``Button`` está enfocado. Se muestra sobre el :ref:`StyleBox<class_StyleBox>` actual, por lo que al usar :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` sólo desactivará el efecto visual de enfoque.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_style_hover:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **hover**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` que se usa cuando el ``Button`` tiene encima el cursor.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_style_normal:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **normal**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` por defecto para el ``Button``.
|
|
|
|
----
|
|
|
|
.. _class_Button_theme_style_pressed:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **pressed**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` que se usa cuando se presiona el ``Button``.
|
|
|
|
.. |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.)`
|