From 354c622aa7bd6368d94c5e5d251339d47bede80d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 9 Nov 2023 16:38:55 +0100 Subject: [PATCH] doc: Clarify that `DisplayServer.window_set_*_callback` aren't supported on Window nodes --- doc/classes/DisplayServer.xml | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 3c7d66a67be..7f7dc1d288c 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -1403,6 +1403,7 @@ Sets the [param callback] that should be called when files are dropped from the operating system's file manager to the window specified by [param window_id]. + [b]Warning:[/b] Advanced users only! Adding such a callback to a [Window] node will override its default implementation, which can introduce bugs. [b]Note:[/b] This method is implemented on Windows, macOS, Linux (X11) and Web. @@ -1447,6 +1448,7 @@ Sets the [param callback] that should be called when any [InputEvent] is sent to the window specified by [param window_id]. + [b]Warning:[/b] Advanced users only! Adding such a callback to a [Window] node will override its default implementation, which can introduce bugs. @@ -1455,6 +1457,7 @@ Sets the [param callback] that should be called when text is entered using the virtual keyboard to the window specified by [param window_id]. + [b]Warning:[/b] Advanced users only! Adding such a callback to a [Window] node will override its default implementation, which can introduce bugs. @@ -1552,6 +1555,7 @@ Sets the [param callback] that will be called when the window specified by [param window_id] is moved or resized. + [b]Warning:[/b] Advanced users only! Adding such a callback to a [Window] node will override its default implementation, which can introduce bugs. @@ -1609,6 +1613,7 @@ Sets the [param callback] that will be called when an event occurs in the window specified by [param window_id]. + [b]Warning:[/b] Advanced users only! Adding such a callback to a [Window] node will override its default implementation, which can introduce bugs. @@ -1882,30 +1887,30 @@ Max value of the [enum WindowFlags]. - Sent when the mouse pointer enters the window, see [method window_set_window_event_callback]. + Sent when the mouse pointer enters the window. - Sent when the mouse pointer exits the window, see [method window_set_window_event_callback]. + Sent when the mouse pointer exits the window. - Sent when the window grabs focus, see [method window_set_window_event_callback]. + Sent when the window grabs focus. - Sent when the window loses focus, see [method window_set_window_event_callback]. + Sent when the window loses focus. - Sent when the user has attempted to close the window (e.g. close button is pressed), see [method window_set_window_event_callback]. + Sent when the user has attempted to close the window (e.g. close button is pressed). - Sent when the device "Back" button is pressed, see [method window_set_window_event_callback]. + Sent when the device "Back" button is pressed. [b]Note:[/b] This event is implemented only on Android. - Sent when the window is moved to the display with different DPI, or display DPI is changed, see [method window_set_window_event_callback]. + Sent when the window is moved to the display with different DPI, or display DPI is changed. [b]Note:[/b] This flag is implemented only on macOS. - Sent when the window title bar decoration is changed (e.g. [constant WINDOW_FLAG_EXTEND_TO_TITLE] is set or window entered/exited full screen mode), see [method window_set_window_event_callback]. + Sent when the window title bar decoration is changed (e.g. [constant WINDOW_FLAG_EXTEND_TO_TITLE] is set or window entered/exited full screen mode). [b]Note:[/b] This flag is implemented only on macOS.