maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #40521 from Xrayez/doc-cmdline-parsing

Browse source 
Document the process of parsing command-line arguments
This commit is contained in:
Rémi Verschelde 2020-07-20 13:55:30 +02:00 committed by GitHub
parent 84fe3d7df5 df80e259cd
commit fe1ec3beab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/classes/OS.xml
View file

@ -112,7 +112,18 @@
<return type="PackedStringArray">
</return>
<description>
Returns the command line arguments passed to the engine.
Returns the command-line arguments passed to the engine.
Command-line arguments can be written in any form, including both [code]--key value[/code] and [code]--key=value[/code] forms so they can be properly parsed, as long as custom command-line arguments do not conflict with engine arguments.
You can also incorporate environment variables using the [method get_environment] method.
You can set [code]editor/main_run_args[/code] in the Project Settings to define command-line arguments to be passed by the editor when running the project.
Here's a minimal example on how to parse command-line arguments into a dictionary using the [code]--key=value[/code] form for arguments:
[codeblock]
var arguments = {}
for argument in OS.get_cmdline_args():
if argument.find("=") > -1:
var key_value = argument.split("=")
arguments[key_value[0].lstrip("--")] = key_value[1]
[/codeblock]
</description>
</method>
<method name="get_connected_midi_inputs">