The CLI parser module, provides a CLI parser using the UntitledCLIParser library.

Enabling the module

To enable the module, update your uvproj.yaml so that the cli_parser key under enabled-modules is set to true like this:

name: "MyProject"
version: "1.0.0.0"
engine-version: "1.0.0.0"
enabled-modules:
  cli_parser: true

Then, regenerate the modules cache by running the following command:

user $ https://madladsquad.com/UVKBuildTool --generate <project directory>

After that, refresh your CMake project with cmake ..!

Next, in your source file, include the Modules.hpp header:

#include <Modules/Modules.hpp>

Event safety

The entire module is flagged as event safe at Any time. It is recommended that you use the module during the Startup event.

Using the module

For documentation, head to the project's GitHub repository. Remember that CLI arguments are stored as argv and argc in the Instance(this is easier to use than the std::vector<FString> arguments member that is also provided).

Checking for the module

To check for the module at compile time, use the UIMGUI_CLI_PARSER_MODULE_ENABLED macro.

Runtime checking can be done using the cli_parser member of the ModuleSettings struct. More info can be found here.

C API

More info on the UntitledCLIParser's C API can be found here.