Skip to content

Overhaul ArgumentParser argument parsing #731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Spartan322 merged 1 commit into from
Jul 19, 2026
+235 −87
Merged

Overhaul ArgumentParser argument parsing #731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions extension/doc_classes/ArgumentOption.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
<member name="aliases" type="PackedStringArray" setter="" getter="get_aliases" default="PackedStringArray()">
The alternative names the option can be known by.
</member>
<member name="conflict_type" type="int" setter="" getter="get_conflict_type" enum="ArgumentOption.ArgumentConflictType" is_bitfield="true" default="0">
</member>
<member name="default_value" type="Variant" setter="" getter="get_default_value" default="null">
The default value the option returns if not set.
</member>
Expand All @@ -46,4 +48,14 @@
The expected type of option.
</member>
</members>
<constants>
<constant name="ARGUMENT_CONFLICT_NONE" value="0" enum="ArgumentConflictType" is_bitfield="true">
</constant>
<constant name="ARGUMENT_CONFLICT_SHORTHAND" value="1" enum="ArgumentConflictType" is_bitfield="true">
</constant>
<constant name="ARGUMENT_CONFLICT_LONG" value="2" enum="ArgumentConflictType" is_bitfield="true">
</constant>
<constant name="ARGUMENT_CONFLICT_ALIASES" value="4" enum="ArgumentConflictType" is_bitfield="true">
</constant>
</constants>
</class>
1 change: 1 addition & 0 deletions extension/doc_classes/ArgumentParser.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<return type="int" enum="Error" />
<param index="0" name="args" type="PackedStringArray" />
<param index="1" name="error_unknown" type="bool" default="true" />
<param index="2" name="skip_conflict_args" type="bool" default="false" />
<description>
Parses the arguments for the commandline into the [ArgumentParser]. This is run before game initialization for [method OS.get_cmdline_args] and [method OS.get_cmdline_user_args].
Prints errors for unknown arguments when [param error_unknown] is true.
Expand Down
Loading
Loading