7adf4cc9b5
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
41 lines
1.2 KiB
XML
41 lines
1.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="Shortcut" inherits="Resource" version="4.0">
|
|
<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>
|
|
<methods>
|
|
<method name="get_as_text" qualifiers="const">
|
|
<return type="String" />
|
|
<description>
|
|
Returns the shortcut's [InputEvent] as a [String].
|
|
</description>
|
|
</method>
|
|
<method name="is_shortcut" qualifiers="const">
|
|
<return type="bool" />
|
|
<argument index="0" name="event" type="InputEvent" />
|
|
<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" />
|
|
<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>
|