diff options
| author | Poommetee Ketson <poommetee@protonmail.com> | 2017-09-12 05:50:23 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-12 05:50:23 +0700 |
| commit | adc8215e9cbbfb4b84a0a975b5f3de6200311adc (patch) | |
| tree | cb459e34c758ae6d22500cc64aa377ae6a35ec56 | |
| parent | 5665bdea1b948fdfcc8b4f6b9eee68c62e19fa69 (diff) | |
| parent | 13fe1a344ef79dc23c6931b9b4b6a686383261d8 (diff) | |
Merge pull request #11107 from hpvb/document-inputevent
Correct InputEvent documentation
| -rw-r--r-- | doc/base/classes.xml | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 7f4b65ca9f..73a38c98a9 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -23274,6 +23274,7 @@ </class> <class name="InputEvent" inherits="Resource" category="Core"> <brief_description> + Generic input event </brief_description> <description> </description> @@ -23284,24 +23285,28 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> + Returns true if this input event matches the event passed. </description> </method> <method name="as_text" qualifiers="const"> <return type="String"> </return> <description> + Returns a [String] representation of the event. </description> </method> <method name="get_device" qualifiers="const"> <return type="int"> </return> <description> + Returns the id of the device that generated the event. </description> </method> <method name="get_id" qualifiers="const"> <return type="int"> </return> <description> + Returns the id of the event. </description> </method> <method name="is_action" qualifiers="const"> @@ -23310,7 +23315,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return if this input event matches a pre-defined action, no matter the type. + Returns true if this input event matches a pre-defined action, no matter the type. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -23319,7 +23324,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return whether the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns true if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> <method name="is_action_released" qualifiers="const"> @@ -23328,7 +23333,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Return whether the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns true if the given action is released (i.e. not pressed). Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> <method name="is_action_type" qualifiers="const"> @@ -23341,14 +23346,14 @@ <return type="bool"> </return> <description> - Return if this input event is an echo event (only for events of type KEY, it will return false for other types). + Returns true if this input event is an echo event (only for events of type KEY, it will return false for other types). </description> </method> <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> <description> - Return if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. + Returns true if this input event is pressed. Not relevant for the event types MOUSE_MOTION, SCREEN_DRAG and NONE. </description> </method> <method name="set_device"> |