virtualx-engine/doc/classes/ShortCut.xml
Rémi Verschelde d516aab8fa doc: Sync with current source
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00

47 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ShortCut" inherits="Resource" category="Core" version="3.0-stable">
<brief_description>
A shortcut for binding input.
</brief_description>
<description>
A shortcut for binding input.
Shortcuts are commonly used for interacting with a [Control] element from a [InputEvent].
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_as_text" qualifiers="const">
<return type="String">
</return>
<description>
Returns the Shortcut's [InputEvent] as a [String].
</description>
</method>
<method name="is_shortcut" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="event" type="InputEvent">
</argument>
<description>
Returns [code]true[/code] if the Shortcut's [InputEvent] equals [code]event[/code].
</description>
</method>
<method name="is_valid" qualifiers="const">
<return type="bool">
</return>
<description>
If [code]true[/code] this Shortcut is valid.
</description>
</method>
</methods>
<members>
<member name="shortcut" type="InputEvent" setter="set_shortcut" getter="get_shortcut">
The Shortcut's [InputEvent].
Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent].
</member>
</members>
<constants>
</constants>
</class>