virtualx-engine/doc/classes/InputEventKey.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventKey" inherits="InputEventWithModifiers" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Input event type for keyboard events.
	</brief_description>
	<description>
	</description>
	<tutorials>
	</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">
			Echo state of the key, i.e. whether it's a repeat event or not.
		</member>
		<member name="pressed" type="bool" setter="set_pressed" getter="is_pressed">
			Pressed state of the key.
		</member>
		<member name="scancode" type="int" setter="set_scancode" getter="get_scancode">
			Scancode of the key, one of the KEY_* constants in [@Global Scope].
		</member>
		<member name="unicode" type="int" setter="set_unicode" getter="get_unicode">
			Unicode identifier of the key (when relevant).
		</member>
	</members>
	<constants>
	</constants>
</class>