summaryrefslogtreecommitdiff
path: root/doc/classes/InputEvent.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/InputEvent.xml')
-rw-r--r--doc/classes/InputEvent.xml12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml
index 934597d0c6..f2c00908f6 100644
--- a/doc/classes/InputEvent.xml
+++ b/doc/classes/InputEvent.xml
@@ -49,7 +49,7 @@
<argument index="0" name="action" type="String">
</argument>
<description>
- Returns [code]true[/code] if the given action is being pressed (and is not an echo event for KEY events). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code].
+ Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
</description>
</method>
<method name="is_action_released" qualifiers="const">
@@ -58,28 +58,28 @@
<argument index="0" name="action" type="String">
</argument>
<description>
- Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code].
+ Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
</description>
</method>
<method name="is_action_type" qualifiers="const">
<return type="bool">
</return>
<description>
- Returns [code]true[/code] if this input event's type is one of the [InputEvent] constants.
+ Returns [code]true[/code] if this input event's type is one that can be assigned to an input action.
</description>
</method>
<method name="is_echo" qualifiers="const">
<return type="bool">
</return>
<description>
- Returns [code]true[/code] if this input event is an echo event (only for events of type KEY).
+ Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]).
</description>
</method>
<method name="is_pressed" qualifiers="const">
<return type="bool">
</return>
<description>
- Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code].
+ Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
</description>
</method>
<method name="shortcut_match" qualifiers="const">
@@ -102,7 +102,7 @@
</method>
</methods>
<members>
- <member name="device" type="int" setter="set_device" getter="get_device">
+ <member name="device" type="int" setter="set_device" getter="get_device" default="0">
The event's device ID.
</member>
</members>