godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Correct InputEvent documentation

This commit is contained in:
Hein-Pieter van Braam 2017-09-09 17:05:05 +02:00
parent d1cb73b47a
commit 13fe1a344e
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/base/classes.xml
View File

@ -23249,6 +23249,7 @@
</class>
<class name="InputEvent" inherits="Resource" category="Core">
<brief_description>
Generic input event
</brief_description>
<description>
</description>
@ -23259,24 +23260,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">
@ -23285,7 +23290,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">
@ -23294,7 +23299,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">
@ -23303,7 +23308,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">
@ -23316,14 +23321,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">