summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-06-07 09:26:49 +0200
committerGitHub <noreply@github.com>2021-06-07 09:26:49 +0200
commit9ddc19d8bd55a192bf0daa6f8cd479d569b86373 (patch)
treed168d1c11dda0f7d4438941a11c18e64f4c75f14
parent553d4a8ba64dbd217a2ae4a656cd7c47c6c759df (diff)
parentc63af17a31b562f4355de6d715d00a3646e552c7 (diff)
Merge pull request #49349 from SirQuartz/patch-5
Amend the quit() method description in `SceneTree` to include an exception for iOS
-rw-r--r--doc/classes/SceneTree.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml
index 06800082cb..7a15153fc2 100644
--- a/doc/classes/SceneTree.xml
+++ b/doc/classes/SceneTree.xml
@@ -207,6 +207,7 @@
Quits the application at the end of the current iteration. Argument [code]exit_code[/code] can optionally be given (defaulting to 0) to customize the exit status code.
By convention, an exit code of [code]0[/code] indicates success whereas a non-zero exit code indicates an error.
For portability reasons, the exit code should be set between 0 and 125 (inclusive).
+ [b]Note:[/b] On iOS this method doesn't work. Instead, as recommended by the iOS Human Interface Guidelines, the user is expected to close apps via the Home button.
</description>
</method>
<method name="reload_current_scene">