asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/InputEvent.xml

136 lines
4 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Remove revision.module_config from version string It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-11-15 18:37:54 +01:00
<class name="InputEvent" inherits="Resource" category="Core" version="3.0-alpha">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Generic input event
</brief_description>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
Base class of all sort of input event. See [method Node._input].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</tutorials>
<demos>
</demos>
<methods>
<method name="action_match" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
Fix the class docs for the rst-syntax errors. - Generate a correkt rst-syntax for the [/code] inline markup. (http://www.sphinx-doc.org/en/1.6.5/rest.html#inline-markup) - Fix xml souce bugs for the sphinx's rst syntax werrors: class_area.rst:319: WARNING: Inline literal start-string without end-string. class_area2d.rst:287: WARNING: Inline literal start-string without end-string. class_audioserver.rst:287: WARNING: Inline literal start-string without end-string. class_control.rst:509: WARNING: Inline literal start-string without end-string. class_image.rst:422: WARNING: Inline literal start-string without end-string. class_image.rst:434: WARNING: Inline literal start-string without end-string. class_inputevent.rst:74: WARNING: Inline literal start-string without end-string. class_inputeventaction.rst:45: WARNING: Inline literal start-string without end-string. class_inputmap.rst:47: WARNING: Inline literal start-string without end-string. class_kinematicbody.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string. class_kinematicbody2d.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string. class_line2d.rst:182: WARNING: Inline literal start-string without end-string. class_thread.rst:51: WARNING: Inline literal start-string without end-string. class_treeitem.rst:160: WARNING: Inline literal start-string without end-string.
2017-11-18 01:29:32 +01:00
Returns [code]true[/code] if this event matches [code]event[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</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>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
Returns the device's id that generated the event.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_id" qualifiers="const">
<return type="int">
</return>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
Returns the event's ID.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="is_action" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
Returns [code]true[/code] if this input event matches a pre-defined action of any type.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="is_action_pressed" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="is_action_released" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="action" type="String">
</argument>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="is_action_type" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
Returns [code]true[/code] if this input event's type is one of the [code]InputEvent[/code] constants.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="is_echo" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
Returns [code]true[/code] if this input event is an echo event (only for events of type KEY).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="is_pressed" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
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].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="set_device">
<return type="void">
</return>
<argument index="0" name="device" type="int">
</argument>
<description>
</description>
</method>
<method name="set_id">
<return type="void">
</return>
<argument index="0" name="id" type="int">
</argument>
<description>
</description>
</method>
<method name="shortcut_match" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
</description>
</method>
<method name="xformed_by" qualifiers="const">
<return type="InputEvent">
</return>
<argument index="0" name="xform" type="Transform2D">
</argument>
<argument index="1" name="local_ofs" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
</description>
</method>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 08:49:40 +02:00
<member name="device" type="int" setter="set_device" getter="get_device">
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
The event's device ID.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink