diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-12-29 16:55:16 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-12-29 16:56:22 +0100 |
| commit | d441a6aefadda78bb0bb02552716cbede38fe662 (patch) | |
| tree | b04181eef061d7829c02f7850e19d1bc5ea34ab2 /doc | |
| parent | 12482bf8840ce2fa84d6eea7999628be426cba8d (diff) | |
Print a warning message if `OS.exit_code` is set to a non-portable value
This also improves the related documentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/OS.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 54b4f3df64..265e87eba3 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -905,7 +905,7 @@ The current screen index (starting from 0). </member> <member name="exit_code" type="int" setter="set_exit_code" getter="get_exit_code" default="0"> - The exit code passed to the OS when the main loop exits. + The exit code passed to the OS when the main loop exits. 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). </member> <member name="keep_screen_on" type="bool" setter="set_keep_screen_on" getter="is_keep_screen_on" default="true"> If [code]true[/code], the engine tries to keep the screen on while the game is running. Useful on mobile. |