godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Add property overview and setter/getter like in editor docs

Browse Source 
Output from godotengine/godot#22013.
Fixes #1729.
This commit is contained in:
Rémi Verschelde
2018-09-13 11:06:52 +02:00
parent f9caa4be29
commit ab3f908221
578 changed files with 33831 additions and 6706 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
classes/class_inputeventjoypadbutton.rst
View File

@@ -8,6 +8,7 @@ InputEventJoypadButton
======================
**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -15,6 +16,17 @@ Brief Description
Input event for gamepad buttons.
Properties
----------
+---------------------------+----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`button_index<class_InputEventJoypadButton_button_index>` |
+---------------------------+----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventJoypadButton_pressed>` |
+---------------------------+----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pressure<class_InputEventJoypadButton_pressure>` |
+---------------------------+----------------------------------------------------------------+
Description
-----------
@@ -24,20 +36,42 @@ Tutorials
---------
- :doc:`../tutorials/inputs/inputevent`
Property Descriptions
---------------------
.. _class_InputEventJoypadButton_button_index:
- :ref:`int<class_int>` **button_index** - Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope<class_@GlobalScope>`.
- :ref:`int<class_int>` **button_index**
+----------+-------------------------+
| *Setter* | set_button_index(value) |
+----------+-------------------------+
| *Getter* | get_button_index() |
+----------+-------------------------+
Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope<class_@GlobalScope>`.
.. _class_InputEventJoypadButton_pressed:
- :ref:`bool<class_bool>` **pressed** - If ``true`` the button's state is pressed. If ``false`` the button's state is released.
- :ref:`bool<class_bool>` **pressed**
+----------+--------------------+
| *Setter* | set_pressed(value) |
+----------+--------------------+
| *Getter* | is_pressed() |
+----------+--------------------+
If ``true`` the button's state is pressed. If ``false`` the button's state is released.
.. _class_InputEventJoypadButton_pressure:
- :ref:`float<class_float>` **pressure** - Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``.
- :ref:`float<class_float>` **pressure**
+----------+---------------------+
| *Setter* | set_pressure(value) |
+----------+---------------------+
| *Getter* | get_pressure() |
+----------+---------------------+
Represents the pressure the user puts on the button with his finger, if the controller supports it. Ranges from ``0`` to ``1``.