godot/doc/classes/InputEvent.xml

112 lines
3.6 KiB
XML
Raw Normal View History

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