godot/doc/classes/InputEventKey.xml

83 lines
2.3 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0-alpha">
<brief_description>
Input event type for keyboard events.
</brief_description>
<description>
2017-10-15 22:07:13 +00:00
Stores key presses on the keyboard. Supports key presses, key releases and [member echo] events.
</description>
<tutorials>
2017-10-15 22:07:13 +00:00
http://docs.godotengine.org/en/stable/learning/features/inputs/inputevent.html
</tutorials>
<demos>
</demos>
<methods>
<method name="get_scancode" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_scancode_with_modifiers" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_unicode" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="set_echo">
<return type="void">
</return>
<argument index="0" name="echo" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_pressed">
<return type="void">
</return>
<argument index="0" name="pressed" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_scancode">
<return type="void">
</return>
<argument index="0" name="scancode" type="int">
</argument>
<description>
</description>
</method>
<method name="set_unicode">
<return type="void">
</return>
<argument index="0" name="unicode" type="int">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="echo" type="bool" setter="set_echo" getter="is_echo">
2017-10-15 22:07:13 +00:00
If [code]true[/code] the key was already pressed before this event. It means the user is holding the key down.
</member>
<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
2017-10-15 22:07:13 +00:00
If [code]true[/code] the key's state is pressed. If [code]false[/code] the key's state is released.
</member>
<member name="scancode" type="int" setter="set_scancode" getter="get_scancode">
2017-10-15 22:07:13 +00:00
Key scancode, one of the [code]KEY_*[/code] constants in [@global Scope].
</member>
<member name="unicode" type="int" setter="set_unicode" getter="get_unicode">
2017-10-15 22:07:13 +00:00
Key unicode identifier when relevant.
</member>
</members>
<constants>
</constants>
</class>