2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-02-27 13:40:43 +01:00
<class name= "InputEvent" inherits= "Resource" category= "Core" version= "3.1" >
2017-09-12 22:42:36 +02:00
<brief_description >
Generic input event
</brief_description>
<description >
2017-10-16 00:07:13 +02:00
Base class of all sort of input event. See [method Node._input].
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2018-11-05 08:46:27 +01:00
<link > https://docs.godotengine.org/en/latest/tutorials/inputs/inputevent.html</link>
<link > https://docs.godotengine.org/en/latest/tutorials/2d/2d_transforms.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
2019-03-07 10:54:42 +01:00
<method name= "accumulate" >
<return type= "bool" >
</return>
<argument index= "0" name= "with_event" type= "InputEvent" >
</argument>
<description >
</description>
</method>
2018-05-12 09:38:00 +02:00
<method name= "as_text" qualifiers= "const" >
<return type= "String" >
2017-09-12 22:42:36 +02:00
</return>
<description >
2018-05-12 09:38:00 +02:00
Returns a [String] representation of the event.
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-05-12 09:38:00 +02:00
<method name= "get_action_strength" qualifiers= "const" >
<return type= "float" >
2017-09-12 22:42:36 +02:00
</return>
2018-05-12 09:38:00 +02:00
<argument index= "0" name= "action" type= "String" >
</argument>
2017-09-12 22:42:36 +02:00
<description >
</description>
</method>
<method name= "is_action" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "action" type= "String" >
</argument>
<description >
2017-10-16 00:07:13 +02:00
Returns [code]true[/code] if this input event matches a pre-defined action of any type.
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 >
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].
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 >
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].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "is_action_type" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "is_echo" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
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).
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "is_pressed" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
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].
2017-09-12 22:42:36 +02:00
</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 >
2017-09-13 08:49:40 +02:00
<member name= "device" type= "int" setter= "set_device" getter= "get_device" >
2017-10-16 00:07:13 +02:00
The event's device ID.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
</constants>
</class>