This repository was archived by the owner on Dec 13, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
VRage.Game.ModAPI.Ingame.Utilities.MyCommandLine
Malware edited this page Dec 21, 2018
·
43 revisions
← Index
Namespace: VRage.Game.ModAPI.Ingame.Utilities
Assembly: VRage.Game.dll
A utility class to parse arguments from a command line string. Switches are defined with hyphen (-switch). Quotes can be placed around an argument to parse verbatim.
| [`ItemCollection Items`](VRage.Game.ModAPI.Ingame.Utilities.Items) | Contains all items, both arguments and switches |
| [`SwitchCollection Switches`](VRage.Game.ModAPI.Ingame.Utilities.Switches) | Contains a list of all detected switches |
| [`int ArgumentCount`](VRage.Game.ModAPI.Ingame.Utilities.ArgumentCount) | Returns the number of non-switch arguments |
| [`bool TryParse(string argument)`](VRage.Game.ModAPI.Ingame.Utilities.TryParse) | Attempts to parse the given string as a command line |
| [`string Argument(int index)`](VRage.Game.ModAPI.Ingame.Utilities.Argument) | Returns the argument at the given index. Switches are not counted. |
| [`bool Switch(string name)`](VRage.Game.ModAPI.Ingame.Utilities.Switch) | Determines whether the given switch is set. Switches are specified without their prefixed hyphen. |
| [`string Switch(string name, int relativeArgument)`](VRage.Game.ModAPI.Ingame.Utilities.Switch) | Gets an argument of a switch. For example, using`Switch("key", 0)`on the command line`someOtherArgument -key value`will return`value`. |
| [`void Clear()`](VRage.Game.ModAPI.Ingame.Utilities.Clear) | Clears all arguments |
Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!