summaryrefslogtreecommitdiffstats
path: root/doc/classes/OS.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2022-11-11 18:05:39 +0100
committerHugo Locurcio <hugo.locurcio@hugo.pro>2022-11-11 23:23:58 +0100
commit914d3e1b1db58731b72be57cde46158720e73cb9 (patch)
treef16c12dd8d32191cff071582b4650116c217f677 /doc/classes/OS.xml
parent340fb33e543fb5775e36a7d49d605b4e3a33e5d6 (diff)
downloadredot-engine-914d3e1b1db58731b72be57cde46158720e73cb9.tar.gz
Allow `++` as an alternative separator to `--` for user CLI arguments
This is required when using `startx` to start a Godot project, as `--` is used by `startx` for its own arguments (and there is no way to escape it).
Diffstat (limited to 'doc/classes/OS.xml')
-rw-r--r--doc/classes/OS.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index f4a5288481..bc5af5bfa7 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -182,10 +182,12 @@
<method name="get_cmdline_user_args">
<return type="PackedStringArray" />
<description>
- Similar to [method get_cmdline_args], but this returns the user arguments (any argument passed after the double dash [code]--[/code] argument). These are left untouched by Godot for the user.
+ Similar to [method get_cmdline_args], but this returns the user arguments (any argument passed after the double dash [code]--[/code] or double plus [code]++[/code] argument). These are left untouched by Godot for the user. [code]++[/code] can be used in situations where [code]--[/code] is intercepted by another program (such as [code]startx[/code]).
For example, in the command line below, [code]--fullscreen[/code] will not be returned in [method get_cmdline_user_args] and [code]--level 1[/code] will only be returned in [method get_cmdline_user_args]:
[codeblock]
godot --fullscreen -- --level 1
+ # Or:
+ godot --fullscreen ++ --level 1
[/codeblock]
</description>
</method>