mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-03 05:48:42 +03:00
74b79a439b
Hey first edit here, Here's a quick edit for something I just stumbled upon learning Godot 4, basically the notification MainLoop.NOTIFICATION_WM_QUIT_REQUEST changed to NOTIFICATION_WM_CLOSE_REQUEST. Would spare some people quite a bit of confusion I basically had to search through the source's commits since it not only moved but changed name. It *is* already correctly listed in the Node page though. I'm not really sure about the C# code examples though but I doubt it would be more complicated than this.
82 lines
2.4 KiB
ReStructuredText
82 lines
2.4 KiB
ReStructuredText
.. _doc_handling_quit_requests:
|
|
|
|
Handling quit requests
|
|
======================
|
|
|
|
Quitting
|
|
--------
|
|
|
|
Most platforms have the option to request the application to quit. On
|
|
desktops, this is usually done with the "x" icon on the window title bar.
|
|
On Android, the back button is used to quit when on the main screen (and
|
|
to go back otherwise).
|
|
|
|
Handling the notification
|
|
-------------------------
|
|
|
|
On desktop and web platforms, :ref:`Node <class_Node>`
|
|
receives a special ``NOTIFICATION_WM_CLOSE_REQUEST`` notification when quitting is requested.
|
|
|
|
On Android, ``MainLoop.NOTIFICATION_WM_GO_BACK_REQUEST`` is sent instead.
|
|
Pressing the Back button will exit the application if
|
|
**Application > Config > Quit On Go Back** is checked in the Project Settings
|
|
(which is the default).
|
|
|
|
.. note::
|
|
|
|
``MainLoop.NOTIFICATION_WM_GO_BACK_REQUEST`` isn't supported on iOS, as
|
|
iOS devices don't have a physical Back button.
|
|
|
|
Handling the notification is done as follows (on any node):
|
|
|
|
.. tabs::
|
|
.. code-tab:: gdscript GDScript
|
|
|
|
func _notification(what):
|
|
if what == NOTIFICATION_WM_CLOSE_REQUEST:
|
|
get_tree().quit() # default behavior
|
|
|
|
.. code-tab:: csharp
|
|
|
|
public override void _Notification(int what)
|
|
{
|
|
if (what == NotificationWmCloseRequest)
|
|
GetTree().Quit(); // default behavior
|
|
}
|
|
|
|
When developing mobile apps, quitting is not desired unless the user is
|
|
on the main screen, so the behavior can be changed.
|
|
|
|
It is important to note that by default, Godot apps have the built-in
|
|
behavior to quit when quit is requested, this can be changed:
|
|
|
|
.. tabs::
|
|
.. code-tab:: gdscript GDScript
|
|
|
|
get_tree().set_auto_accept_quit(false)
|
|
|
|
.. code-tab:: csharp
|
|
|
|
GetTree().SetAutoAcceptQuit(false);
|
|
|
|
Sending your own quit notification
|
|
----------------------------------
|
|
|
|
While forcing the application to close can be done by calling :ref:`SceneTree.quit <class_SceneTree_method_quit>`,
|
|
doing so will not send the quit *notification*. This means the function
|
|
described above won't be called. Quitting by calling
|
|
:ref:`SceneTree.quit <class_SceneTree_method_quit>` will not allow custom actions
|
|
to complete (such as saving, confirming the quit, or debugging), even if you try
|
|
to delay the line that forces the quit.
|
|
|
|
Instead, you should send a quit request:
|
|
|
|
.. tabs::
|
|
.. code-tab:: gdscript GDScript
|
|
|
|
get_tree().notification(NOTIFICATION_WM_CLOSE_REQUEST)
|
|
|
|
.. code-tab:: csharp
|
|
|
|
GetTree().Notification(NotificationWmCloseRequest)
|