virtualx-engine/doc/classes/InputEventKey.xml
2018-02-24 18:59:38 +01:00

38 lines
1.4 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0.1">
<brief_description>
Input event type for keyboard events.
</brief_description>
<description>
Stores key presses on the keyboard. Supports key presses, key releases and [member echo] events.
</description>
<tutorials>
http://docs.godotengine.org/en/3.0/tutorials/inputs/inputevent.html
</tutorials>
<demos>
</demos>
<methods>
<method name="get_scancode_with_modifiers" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="echo" type="bool" setter="set_echo" getter="is_echo">
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">
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">
Key scancode, one of the [code]KEY_*[/code] constants in [@global Scope].
</member>
<member name="unicode" type="int" setter="set_unicode" getter="get_unicode">
Key unicode identifier when relevant.
</member>
</members>
<constants>
</constants>
</class>