Clarify behavior of InputEvent.is_match and Shortcut.matches_event
- Shortcut: Clarifies how matches_event() method compares events - InputEvent: Clarifies is_match() method does not consider event states
This commit is contained in:
parent
02b16d2f54
commit
4f4fd1a05c
|
@ -91,6 +91,7 @@
|
|||
<description>
|
||||
Returns [code]true[/code] if the specified [param event] matches this event. Only valid for action events i.e key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion] or action ([InputEventAction]) events.
|
||||
If [param exact_match] is [code]false[/code], it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
|
||||
[b]Note:[/b] Only considers the event configuration (such as the keyboard key or joypad axis), not state information like [method is_pressed], [method is_released], [method is_echo], or [method is_canceled].
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_pressed" qualifiers="const">
|
||||
|
|
|
@ -26,7 +26,7 @@
|
|||
<return type="bool" />
|
||||
<param index="0" name="event" type="InputEvent" />
|
||||
<description>
|
||||
Returns whether any [InputEvent] in [member events] equals [param event].
|
||||
Returns whether any [InputEvent] in [member events] equals [param event]. This uses [method InputEvent.is_match] to compare events.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
|
Loading…
Reference in New Issue