diff options
| author | Eric M <itsjusteza@gmail.com> | 2021-06-21 11:34:50 +1000 |
|---|---|---|
| committer | Eric M <itsjusteza@gmail.com> | 2021-10-01 18:04:28 +1000 |
| commit | ad30b0a8dd793efa2ca60b424f3dc1e25975de68 (patch) | |
| tree | 87ace060f385d9ac8c8d6b1d6cc11520ef807296 /doc/classes | |
| parent | 4baddc112647edf658692a484a481666a77e41b2 (diff) | |
Allow shortcuts to have any number of bindings. Updated UI as required.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Control.xml | 6 | ||||
| -rw-r--r-- | doc/classes/Shortcut.xml | 14 |
2 files changed, 10 insertions, 10 deletions
diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index c9a2de66a8..b00bf1c250 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -742,10 +742,10 @@ </method> <method name="set_drag_forwarding"> <return type="void" /> - <argument index="0" name="target" type="Control" /> + <argument index="0" name="target" type="Node" /> <description> - Forwards the handling of this control's drag and drop to [code]target[/code] control. - Forwarding can be implemented in the target control similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: + Forwards the handling of this control's drag and drop to [code]target[/code] node. + Forwarding can be implemented in the target node similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences: 1. The function name must be suffixed with [b]_fw[/b] 2. The function must take an extra argument that is the control doing the forwarding [codeblocks] diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 9fbe91f38b..f95d069069 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -4,8 +4,8 @@ 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). + One shortcut can contain multiple [InputEvent]'s, allowing the possibility of triggering one action with multiple different inputs. </description> <tutorials> </tutorials> @@ -13,27 +13,27 @@ <method name="get_as_text" qualifiers="const"> <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="has_valid_event" qualifiers="const"> <return type="bool" /> <description> - Returns whether the shortcut has a valid [member event] assigned to it. + Returns whether [member events] contains an [InputEvent] which is valid. </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]. + Returns whether any [InputEvent] in [member events] equals [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 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> </class> |