-
-
Notifications
You must be signed in to change notification settings - Fork 4
CLI Parser module
The CLI parser module, provides a CLI parser using the UntitledCLIParser library.
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 $ ./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>
The entire module is flagged as event safe at Any time
. It is recommended that you use the module during the
Startup
event.
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).
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.
This project is supported by all the people who joined our discord server and became beta testers. If you want to join the discord you can click here.
- Home
- Beginner content
- Advanced content
- Loading dynamic libraries at runtime
- Understanding the library layout
- Compilation mode modifiers
- Adding plugin support to your application
- Production export and deployment
- Targeting WASM
- Developer and contributor resources
- Misc