diff options
Diffstat (limited to 'doc/classes/Shortcut.xml')
| -rw-r--r-- | doc/classes/Shortcut.xml | 34 |
1 files changed, 14 insertions, 20 deletions
diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 55bbb083c9..f95d069069 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -4,42 +4,36 @@ 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]. + Shortcuts are commonly used for interacting with a [Control] element from an [InputEvent] (also known as hotkeys). + One shortcut can contain multiple [InputEvent]'s, allowing the possibility of triggering one action with multiple different inputs. </description> <tutorials> </tutorials> <methods> <method name="get_as_text" qualifiers="const"> - <return type="String"> - </return> + <return type="String" /> <description> - Returns the shortcut's [InputEvent] as a [String]. + Returns the shortcut's first valid [InputEvent] as a [String]. </description> </method> - <method name="is_shortcut" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="event" type="InputEvent"> - </argument> + <method name="has_valid_event" qualifiers="const"> + <return type="bool" /> <description> - Returns [code]true[/code] if the shortcut's [InputEvent] equals [code]event[/code]. + Returns whether [member events] contains an [InputEvent] which is valid. </description> </method> - <method name="is_valid" qualifiers="const"> - <return type="bool"> - </return> + <method name="matches_event" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="event" type="InputEvent" /> <description> - If [code]true[/code], this shortcut is valid. + Returns whether any [InputEvent] in [member events] equals [code]event[/code]. </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 name="events" type="Array" setter="set_events" getter="get_events" default="[]"> + The shortcut's [InputEvent] array. + Generally the [InputEvent] used is an [InputEventKey], though it can be any [InputEvent], including an [InputEventAction]. </member> </members> - <constants> - </constants> </class> |