diff options
Diffstat (limited to 'doc/classes/Shortcut.xml')
| -rw-r--r-- | doc/classes/Shortcut.xml | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml new file mode 100644 index 0000000000..55bbb083c9 --- /dev/null +++ b/doc/classes/Shortcut.xml @@ -0,0 +1,45 @@ +<?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"> + </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> |