Sync classes with upstream 2.0 branch

Constants get reordered in their definition order.
This commit is contained in:
Rémi Verschelde
2016-07-08 23:46:59 +02:00
parent 6789e98658
commit 577559cfe9
63 changed files with 1134 additions and 987 deletions

View File

@@ -11,7 +11,7 @@ InputEventMouseMotion
Brief Description
-----------------
Built-in input event type for mouse motion events.
Member Functions
----------------
@@ -19,9 +19,9 @@ Member Functions
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action<class_InputEventMouseMotion_is_action>` **(** :ref:`String<class_string>` action **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventMouseMotion_is_action_pressed>` **(** :ref:`String<class_string>` is_action_pressed **)** |
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_InputEventMouseMotion_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventMouseMotion_is_action_released>` **(** :ref:`String<class_string>` is_action_released **)** |
| :ref:`bool<class_bool>` | :ref:`is_action_released<class_InputEventMouseMotion_is_action_released>` **(** :ref:`String<class_string>` action **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_echo<class_InputEventMouseMotion_is_echo>` **(** **)** |
+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -33,39 +33,44 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **ID**
- :ref:`bool<class_bool>` **alt**
- :ref:`int<class_int>` **button_mask**
- :ref:`bool<class_bool>` **control**
- :ref:`int<class_int>` **device**
- :ref:`Vector2<class_vector2>` **global_pos**
- :ref:`int<class_int>` **global_x**
- :ref:`int<class_int>` **global_y**
- :ref:`bool<class_bool>` **meta**
- :ref:`Vector2<class_vector2>` **pos**
- :ref:`Vector2<class_vector2>` **relative_pos**
- :ref:`int<class_int>` **relative_x**
- :ref:`int<class_int>` **relative_y**
- :ref:`bool<class_bool>` **shift**
- :ref:`Vector2<class_vector2>` **speed**
- :ref:`float<class_float>` **speed_x**
- :ref:`float<class_float>` **speed_y**
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **x**
- :ref:`int<class_int>` **y**
- :ref:`int<class_int>` **ID** - Event identifier, positive integer increased at each new event.
- :ref:`bool<class_bool>` **alt** - State of the Alt modifier.
- :ref:`int<class_int>` **button_mask** - Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
- :ref:`bool<class_bool>` **control** - State of the Ctrl modifier.
- :ref:`int<class_int>` **device** - Device identifier.
- :ref:`Vector2<class_vector2>` **global_pos** - Global position of the mouse pointer.
- :ref:`int<class_int>` **global_x** - Global X coordinate of the mouse pointer.
- :ref:`int<class_int>` **global_y** - Global Y coordinate of the mouse pointer.
- :ref:`bool<class_bool>` **meta** - State of the Meta modifier.
- :ref:`Vector2<class_vector2>` **pos** - Local position of the mouse pointer.
- :ref:`Vector2<class_vector2>` **relative_pos** - Position of the mouse pointer relative to the previous mouse position.
- :ref:`int<class_int>` **relative_x** - X coordinate of the mouse pointer relative to the previous mouse position.
- :ref:`int<class_int>` **relative_y** - Y coordinate of the mouse pointer relative to the previous mouse position.
- :ref:`bool<class_bool>` **shift** - State of the Shift modifier.
- :ref:`Vector2<class_vector2>` **speed** - Speed of the mouse pointer.
- :ref:`float<class_float>` **speed_x** - Speed of the mouse pointer on the X axis.
- :ref:`float<class_float>` **speed_y** - Speed of the mouse pointer on the Y axis.
- :ref:`int<class_int>` **type** - Type of event (one of the [InputEvent] constants).
- :ref:`int<class_int>` **x** - Local X coordinate of the mouse pointer.
- :ref:`int<class_int>` **y** - Local Y coordinate of the mouse pointer.
Numeric Constants
-----------------
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **NONE** = **0** --- Empty input event.
- **KEY** = **1** --- Key event.
- **MOUSE_MOTION** = **2** --- Mouse motion event.
- **MOUSE_BUTTON** = **3** --- Mouse button event.
- **JOYSTICK_MOTION** = **4** --- Joystick motion event.
- **JOYSTICK_BUTTON** = **5** --- Joystick button event.
- **SCREEN_TOUCH** = **6** --- Screen touch event.
- **SCREEN_DRAG** = **7** --- Screen drag event.
- **ACTION** = **8** --- Pre-defined action event (see :ref:`InputMap<class_inputmap>`).
Description
-----------
Input event type for mouse motion events that extends the global :ref:`InputEvent<class_inputevent>` type.
Member Function Description
---------------------------
@@ -74,24 +79,36 @@ Member Function Description
- :ref:`bool<class_bool>` **is_action** **(** :ref:`String<class_string>` action **)**
Return if this input event matches a pre-defined action.
.. _class_InputEventMouseMotion_is_action_pressed:
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` is_action_pressed **)**
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
Return whether the given action is being pressed. Not relevant for MOUSE_MOTION events, always false.
.. _class_InputEventMouseMotion_is_action_released:
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` is_action_released **)**
- :ref:`bool<class_bool>` **is_action_released** **(** :ref:`String<class_string>` action **)**
Return whether the given action is released (i.e. not pressed). Not relevant for MOUSE_MOTION events, can be true or false depending on whether :ref:`is_action<class_InputEventMouseMotion_is_action>` is true.
.. _class_InputEventMouseMotion_is_echo:
- :ref:`bool<class_bool>` **is_echo** **(** **)**
Return if this input event is an echo event (only for events of type KEY, i.e. always false for this type).
.. _class_InputEventMouseMotion_is_pressed:
- :ref:`bool<class_bool>` **is_pressed** **(** **)**
Return if this input event is pressed. Not relevant for MOUSE_MOTION events, always false.
.. _class_InputEventMouseMotion_set_as_action:
- void **set_as_action** **(** :ref:`String<class_string>` action, :ref:`bool<class_bool>` pressed **)**
Change the input event to an action event of the given name with the (irrelevant for this type) pressed status passed as argument.