From 4f4fd1a05ccef55a9f9c3a6b5ad67e5c495921cc Mon Sep 17 00:00:00 2001
From: skyler <35615419+SkylerGoh-dev@users.noreply.github.com>
Date: Tue, 17 Sep 2024 03:20:36 -0700
Subject: [PATCH] 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
---
doc/classes/InputEvent.xml | 1 +
doc/classes/Shortcut.xml | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml
index a970f63c6eb..6cf490accbc 100644
--- a/doc/classes/InputEvent.xml
+++ b/doc/classes/InputEvent.xml
@@ -91,6 +91,7 @@
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].
diff --git a/doc/classes/Shortcut.xml b/doc/classes/Shortcut.xml
index 4343a789fd8..b1e931aef8d 100644
--- a/doc/classes/Shortcut.xml
+++ b/doc/classes/Shortcut.xml
@@ -26,7 +26,7 @@
- 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.