diff options
Diffstat (limited to 'doc/classes/Shortcut.xml')
| -rw-r--r-- | doc/classes/Shortcut.xml | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml new file mode 100644 index 0000000000..d9f7f98888 --- /dev/null +++ b/doc/classes/Shortcut.xml @@ -0,0 +1,41 @@ +<?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 an [InputEvent] (also known as hotkeys). + </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="has_valid_event" qualifiers="const"> + <return type="bool" /> + <description> + Returns whether the shortcut has a valid [member event] assigned to it. + </description> + </method> + <method name="matches_event" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="event" type="InputEvent" /> + <description> + Returns whether the shortcut's [member event] matches [code]event[/code]. + </description> + </method> + </methods> + <members> + <member name="event" type="InputEvent" setter="set_event" getter="get_event"> + The shortcut's [InputEvent]. + Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent], including an [InputEventAction]. + </member> + </members> + <constants> + </constants> +</class> |