diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-08-05 15:52:20 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-05 15:52:20 +0200 |
| commit | 4cf12d789529052a2c5afdc2d1e4d398c0c57751 (patch) | |
| tree | 6fe5b3b1213c11e6a404a539686658787745121f /doc | |
| parent | 342a0d45cfa0c9cabb76bb6616b0fc2d704766e7 (diff) | |
| parent | de2c2be19bed9f78be627045fb671367b2b93122 (diff) | |
Merge pull request #51215 from akien-mga/shortcut-rename-property-to-event
Shortcut: Rename `shortcut` property to `event`
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Shortcut.xml | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml index 04955103dc..d9f7f98888 100644 --- a/doc/classes/Shortcut.xml +++ b/doc/classes/Shortcut.xml @@ -5,7 +5,7 @@ </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). </description> <tutorials> </tutorials> @@ -16,24 +16,24 @@ Returns the shortcut's [InputEvent] as a [String]. </description> </method> - <method name="is_shortcut" qualifiers="const"> + <method name="has_valid_event" 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]. + Returns whether the shortcut has a valid [member event] assigned to it. </description> </method> - <method name="is_valid" qualifiers="const"> + <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 the shortcut's [member event] matches [code]event[/code]. </description> </method> </methods> <members> - <member name="shortcut" type="InputEvent" setter="set_shortcut" getter="get_shortcut"> + <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]. + Generally the [InputEvent] is a keyboard key, though it can be any [InputEvent], including an [InputEventAction]. </member> </members> <constants> |