mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with current master branch (f87858a8f)
This commit is contained in:
Yuri Sizov
@@ -14,6 +14,8 @@ TouchScreenButton
|
||||
|
||||
Button for touch screen devices for gameplay use.
|
||||
|
||||
.. rst-class:: classref-introduction-group
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
@@ -23,213 +25,280 @@ This node inherits from :ref:`Node2D<class_Node2D>`. Unlike with :ref:`Control<c
|
||||
|
||||
You can configure TouchScreenButton to be visible only on touch devices, helping you develop your game both for desktop and mobile devices.
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`action<class_TouchScreenButton_property_action>` | ``""`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`BitMap<class_BitMap>` | :ref:`bitmask<class_TouchScreenButton_property_bitmask>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`passby_press<class_TouchScreenButton_property_passby_press>` | ``false`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_TouchScreenButton_property_shape>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shape_centered<class_TouchScreenButton_property_shape_centered>` | ``true`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shape_visible<class_TouchScreenButton_property_shape_visible>` | ``true`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture_normal<class_TouchScreenButton_property_texture_normal>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture_pressed<class_TouchScreenButton_property_texture_pressed>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` | :ref:`visibility_mode<class_TouchScreenButton_property_visibility_mode>` | ``0`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`String<class_String>` | :ref:`action<class_TouchScreenButton_property_action>` | ``""`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`BitMap<class_BitMap>` | :ref:`bitmask<class_TouchScreenButton_property_bitmask>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`passby_press<class_TouchScreenButton_property_passby_press>` | ``false`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`Shape2D<class_Shape2D>` | :ref:`shape<class_TouchScreenButton_property_shape>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shape_centered<class_TouchScreenButton_property_shape_centered>` | ``true`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`bool<class_bool>` | :ref:`shape_visible<class_TouchScreenButton_property_shape_visible>` | ``true`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture_normal<class_TouchScreenButton_property_texture_normal>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`texture_pressed<class_TouchScreenButton_property_texture_pressed>` | |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
| :ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` | :ref:`visibility_mode<class_TouchScreenButton_property_visibility_mode>` | ``0`` |
|
||||
+--------------------------------------------------------------+--------------------------------------------------------------------------+-----------+
|
||||
|
||||
.. rst-class:: classref-reftable-group
|
||||
|
||||
Methods
|
||||
-------
|
||||
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_TouchScreenButton_method_is_pressed>` **(** **)** |const| |
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
.. table::
|
||||
:widths: auto
|
||||
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_TouchScreenButton_method_is_pressed>` **(** **)** |const| |
|
||||
+-------------------------+----------------------------------------------------------------------------------+
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Signals
|
||||
-------
|
||||
|
||||
.. _class_TouchScreenButton_signal_pressed:
|
||||
|
||||
- **pressed** **(** **)**
|
||||
.. rst-class:: classref-signal
|
||||
|
||||
**pressed** **(** **)**
|
||||
|
||||
Emitted when the button is pressed (down).
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_signal_released:
|
||||
|
||||
- **released** **(** **)**
|
||||
.. rst-class:: classref-signal
|
||||
|
||||
**released** **(** **)**
|
||||
|
||||
Emitted when the button is released (up).
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Enumerations
|
||||
------------
|
||||
|
||||
.. _enum_TouchScreenButton_VisibilityMode:
|
||||
|
||||
.. _class_TouchScreenButton_constant_VISIBILITY_ALWAYS:
|
||||
|
||||
.. _class_TouchScreenButton_constant_VISIBILITY_TOUCHSCREEN_ONLY:
|
||||
.. rst-class:: classref-enumeration
|
||||
|
||||
enum **VisibilityMode**:
|
||||
|
||||
- **VISIBILITY_ALWAYS** = **0** --- Always visible.
|
||||
.. _class_TouchScreenButton_constant_VISIBILITY_ALWAYS:
|
||||
|
||||
- **VISIBILITY_TOUCHSCREEN_ONLY** = **1** --- Visible on touch screens only.
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` **VISIBILITY_ALWAYS** = ``0``
|
||||
|
||||
Always visible.
|
||||
|
||||
.. _class_TouchScreenButton_constant_VISIBILITY_TOUCHSCREEN_ONLY:
|
||||
|
||||
.. rst-class:: classref-enumeration-constant
|
||||
|
||||
:ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` **VISIBILITY_TOUCHSCREEN_ONLY** = ``1``
|
||||
|
||||
Visible on touch screens only.
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Property Descriptions
|
||||
---------------------
|
||||
|
||||
.. _class_TouchScreenButton_property_action:
|
||||
|
||||
- :ref:`String<class_String>` **action**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+-------------------+
|
||||
| *Default* | ``""`` |
|
||||
+-----------+-------------------+
|
||||
| *Setter* | set_action(value) |
|
||||
+-----------+-------------------+
|
||||
| *Getter* | get_action() |
|
||||
+-----------+-------------------+
|
||||
:ref:`String<class_String>` **action** = ``""``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_action** **(** :ref:`String<class_String>` value **)**
|
||||
- :ref:`String<class_String>` **get_action** **(** **)**
|
||||
|
||||
The button's action. Actions can be handled with :ref:`InputEventAction<class_InputEventAction>`.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_bitmask:
|
||||
|
||||
- :ref:`BitMap<class_BitMap>` **bitmask**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+----------+--------------------+
|
||||
| *Setter* | set_bitmask(value) |
|
||||
+----------+--------------------+
|
||||
| *Getter* | get_bitmask() |
|
||||
+----------+--------------------+
|
||||
:ref:`BitMap<class_BitMap>` **bitmask**
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_bitmask** **(** :ref:`BitMap<class_BitMap>` value **)**
|
||||
- :ref:`BitMap<class_BitMap>` **get_bitmask** **(** **)**
|
||||
|
||||
The button's bitmask.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_passby_press:
|
||||
|
||||
- :ref:`bool<class_bool>` **passby_press**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``false`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_passby_press(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | is_passby_press_enabled() |
|
||||
+-----------+---------------------------+
|
||||
:ref:`bool<class_bool>` **passby_press** = ``false``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_passby_press** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_passby_press_enabled** **(** **)**
|
||||
|
||||
If ``true``, the :ref:`pressed<class_TouchScreenButton_signal_pressed>` and :ref:`released<class_TouchScreenButton_signal_released>` signals are emitted whenever a pressed finger goes in and out of the button, even if the pressure started outside the active area of the button.
|
||||
|
||||
\ **Note:** This is a "pass-by" (not "bypass") press mode.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_shape:
|
||||
|
||||
- :ref:`Shape2D<class_Shape2D>` **shape**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+----------+------------------+
|
||||
| *Setter* | set_shape(value) |
|
||||
+----------+------------------+
|
||||
| *Getter* | get_shape() |
|
||||
+----------+------------------+
|
||||
:ref:`Shape2D<class_Shape2D>` **shape**
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_shape** **(** :ref:`Shape2D<class_Shape2D>` value **)**
|
||||
- :ref:`Shape2D<class_Shape2D>` **get_shape** **(** **)**
|
||||
|
||||
The button's shape.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_shape_centered:
|
||||
|
||||
- :ref:`bool<class_bool>` **shape_centered**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+---------------------------+
|
||||
| *Default* | ``true`` |
|
||||
+-----------+---------------------------+
|
||||
| *Setter* | set_shape_centered(value) |
|
||||
+-----------+---------------------------+
|
||||
| *Getter* | is_shape_centered() |
|
||||
+-----------+---------------------------+
|
||||
:ref:`bool<class_bool>` **shape_centered** = ``true``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_shape_centered** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_shape_centered** **(** **)**
|
||||
|
||||
If ``true``, the button's shape is centered in the provided texture. If no texture is used, this property has no effect.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_shape_visible:
|
||||
|
||||
- :ref:`bool<class_bool>` **shape_visible**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+--------------------------+
|
||||
| *Default* | ``true`` |
|
||||
+-----------+--------------------------+
|
||||
| *Setter* | set_shape_visible(value) |
|
||||
+-----------+--------------------------+
|
||||
| *Getter* | is_shape_visible() |
|
||||
+-----------+--------------------------+
|
||||
:ref:`bool<class_bool>` **shape_visible** = ``true``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_shape_visible** **(** :ref:`bool<class_bool>` value **)**
|
||||
- :ref:`bool<class_bool>` **is_shape_visible** **(** **)**
|
||||
|
||||
If ``true``, the button's shape is visible in the editor.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_texture_normal:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **texture_normal**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+----------+---------------------------+
|
||||
| *Setter* | set_texture_normal(value) |
|
||||
+----------+---------------------------+
|
||||
| *Getter* | get_texture_normal() |
|
||||
+----------+---------------------------+
|
||||
:ref:`Texture2D<class_Texture2D>` **texture_normal**
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_texture_normal** **(** :ref:`Texture2D<class_Texture2D>` value **)**
|
||||
- :ref:`Texture2D<class_Texture2D>` **get_texture_normal** **(** **)**
|
||||
|
||||
The button's texture for the normal state.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_texture_pressed:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **texture_pressed**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+----------+----------------------------+
|
||||
| *Setter* | set_texture_pressed(value) |
|
||||
+----------+----------------------------+
|
||||
| *Getter* | get_texture_pressed() |
|
||||
+----------+----------------------------+
|
||||
:ref:`Texture2D<class_Texture2D>` **texture_pressed**
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_texture_pressed** **(** :ref:`Texture2D<class_Texture2D>` value **)**
|
||||
- :ref:`Texture2D<class_Texture2D>` **get_texture_pressed** **(** **)**
|
||||
|
||||
The button's texture for the pressed state.
|
||||
|
||||
.. rst-class:: classref-item-separator
|
||||
|
||||
----
|
||||
|
||||
.. _class_TouchScreenButton_property_visibility_mode:
|
||||
|
||||
- :ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` **visibility_mode**
|
||||
.. rst-class:: classref-property
|
||||
|
||||
+-----------+----------------------------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+----------------------------+
|
||||
| *Setter* | set_visibility_mode(value) |
|
||||
+-----------+----------------------------+
|
||||
| *Getter* | get_visibility_mode() |
|
||||
+-----------+----------------------------+
|
||||
:ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` **visibility_mode** = ``0``
|
||||
|
||||
.. rst-class:: classref-property-setget
|
||||
|
||||
- void **set_visibility_mode** **(** :ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` value **)**
|
||||
- :ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` **get_visibility_mode** **(** **)**
|
||||
|
||||
The button's visibility mode. See :ref:`VisibilityMode<enum_TouchScreenButton_VisibilityMode>` for possible values.
|
||||
|
||||
.. rst-class:: classref-section-separator
|
||||
|
||||
----
|
||||
|
||||
.. rst-class:: classref-descriptions-group
|
||||
|
||||
Method Descriptions
|
||||
-------------------
|
||||
|
||||
.. _class_TouchScreenButton_method_is_pressed:
|
||||
|
||||
- :ref:`bool<class_bool>` **is_pressed** **(** **)** |const|
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_pressed** **(** **)** |const|
|
||||
|
||||
Returns ``true`` if this button is currently pressed.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user