Sync classref with current source

This commit is contained in:
Rémi Verschelde
2019-06-11 10:00:01 +02:00
parent 0bf17179bc
commit 471a0e23ac
17 changed files with 192 additions and 87 deletions

View File

@@ -19,11 +19,13 @@ Input event type for actions.
Properties
----------
+-----------------------------+---------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`action<class_InputEventAction_property_action>` |
+-----------------------------+---------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventAction_property_pressed>` |
+-----------------------------+---------------------------------------------------------+
+-----------------------------+-----------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`action<class_InputEventAction_property_action>` |
+-----------------------------+-----------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pressed<class_InputEventAction_property_pressed>` |
+-----------------------------+-----------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`strength<class_InputEventAction_property_strength>` |
+-----------------------------+-----------------------------------------------------------+
Description
-----------
@@ -62,3 +64,15 @@ The action's name. Actions are accessed via this :ref:`String<class_String>`.
If ``true``, the action's state is pressed. If ``false``, the action's state is released.
.. _class_InputEventAction_property_strength:
- :ref:`float<class_float>` **strength**
+----------+---------------------+
| *Setter* | set_strength(value) |
+----------+---------------------+
| *Getter* | get_strength() |
+----------+---------------------+
The action's strength between 0 and 1. This value is consired as equal to 0 if pressed is ``false``. The event strength allows faking analog joypad motion events, by precising how strongly is the joypad axis bent or pressed.