diff options
author | Rémi Verschelde <remi@verschelde.fr> | 2021-06-20 00:29:42 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-06-20 00:29:42 +0200 |
commit | 4effadc0ba45abd72f8893f0137822e6d3b3f1c4 (patch) | |
tree | dcaef42f26868cee15e63d092c930f5d2d64f52b /doc/classes | |
parent | d88be9b70cfecb0ec525216c1bb6267c9d1aa17d (diff) | |
parent | 7104229a85acbc30bf5dcc9c8a0ada8571910456 (diff) |
Merge pull request #48696 from madmiraal/fix-48692
Fix `InputMap.action_erase_event()` failing to erase events correctly.
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/InputEvent.xml | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 0c8db0de73..c28c4c4282 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -90,20 +90,23 @@ Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]). </description> </method> - <method name="is_pressed" qualifiers="const"> + <method name="is_match" qualifiers="const"> <return type="bool"> </return> + <argument index="0" name="event" type="InputEvent"> + </argument> + <argument index="1" name="exact_match" type="bool" default="true"> + </argument> <description> - Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. + Returns [code]true[/code] if the specified [code]event[/code] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events. + If [code]exact_match[/code] is [code]false[/code], it ignores the input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events. </description> </method> - <method name="shortcut_match" qualifiers="const"> + <method name="is_pressed" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="event" type="InputEvent"> - </argument> <description> - Returns [code]true[/code] if the given input event is checking for the same key ([InputEventKey]), button ([InputEventJoypadButton]) or action ([InputEventAction]). + Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. </description> </method> <method name="xformed_by" qualifiers="const"> |