asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #11107 from hpvb/document-inputevent

Browse source 
Correct InputEvent documentation
This commit is contained in:
Poommetee Ketson 2017-09-12 05:50:23 +07:00 committed by GitHub
commit adc8215e9c
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

@ -23274,6 +23274,7 @@
</class> </class>
<class name="InputEvent" inherits="Resource" category="Core"> <class name="InputEvent" inherits="Resource" category="Core">
<brief_description> <brief_description>
Generic input event
</brief_description> </brief_description>
<description> <description>
</description> </description>
@ -23284,24 +23285,28 @@
<argument index="0" name="event" type="InputEvent"> <argument index="0" name="event" type="InputEvent">
</argument> </argument>
<description> <description>
Returns true if this input event matches the event passed.
</description> </description>
</method> </method>
<method name="as_text" qualifiers="const"> <method name="as_text" qualifiers="const">
<return type="String"> <return type="String">
</return> </return>
<description> <description>
Returns a [String] representation of the event.
</description> </description>
</method> </method>
<method name="get_device" qualifiers="const"> <method name="get_device" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Returns the id of the device that generated the event.
</description> </description>
</method> </method>
<method name="get_id" qualifiers="const"> <method name="get_id" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Returns the id of the event.
</description> </description>
</method> </method>
<method name="is_action" qualifiers="const"> <method name="is_action" qualifiers="const">
@ -23310,7 +23315,7 @@
<argument index="0" name="action" type="String"> <argument index="0" name="action" type="String">
</argument> </argument>
<description> <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> </description>
</method> </method>
<method name="is_action_pressed" qualifiers="const"> <method name="is_action_pressed" qualifiers="const">
@ -23319,7 +23324,7 @@
<argument index="0" name="action" type="String"> <argument index="0" name="action" type="String">
</argument> </argument>
<description> <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> </description>
</method> </method>
<method name="is_action_released" qualifiers="const"> <method name="is_action_released" qualifiers="const">
@ -23328,7 +23333,7 @@
<argument index="0" name="action" type="String"> <argument index="0" name="action" type="String">
</argument> </argument>
<description> <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> </description>
</method> </method>
<method name="is_action_type" qualifiers="const"> <method name="is_action_type" qualifiers="const">
@ -23341,14 +23346,14 @@
<return type="bool"> <return type="bool">
</return> </return>
<description> <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> </description>
</method> </method>
<method name="is_pressed" qualifiers="const"> <method name="is_pressed" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
<description> <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> </description>
</method> </method>
<method name="set_device"> <method name="set_device">