Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Commandlets/Commandlet.h |
Include |
#include "Commandlets/Commandlet.h" |
class UCommandlet : public UObject
Commandlet (command-line applet) class.
Commandlets are executed from the ucc.exe command line utility, using the following syntax: yourgame.exe package_name.commandlet_class_name [parm=value]...
for example: yourgame.exe Core.HelloWorldCommandlet yourgame.exe UnrealEd.CookCommandlet
As a convenience, if a user tries to run a commandlet and the exact name he types isn't found, then ucc.exe appends the text "commandlet" onto the name and tries again. Therefore, the following shortcuts perform identically to the above: yourgame.exe Core.HelloWorld yourgame.exe UnrealEd.Make
Commandlets are executed in a "raw" environment, in which the game isn't loaded, the client code isn't loaded, no levels are loaded, and no actors exist.
To disable shader compiling during the run of the commandlet add "-NoShaderCompile" to the commandline. This would be added as data member setting except that the shader compiler is initialized before a commandlet is created so it cannot be queried soon enough.
Name | Description | ||
---|---|---|---|
|
HelpDescription |
Description of the commandlet's purpose |
|
|
HelpParamDescriptions |
The description of the parameter |
|
|
HelpParamNames |
The name of the parameter the commandlet takes |
|
|
HelpUsage |
Usage template to show for "ucc help" |
|
|
HelpWebLink |
Hyperlink for more info |
|
|
uint32: 1 |
IsClient |
|
|
uint32: 1 |
IsEditor |
|
|
uint32: 1 |
IsServer |
Whether to load objects required in server, client, and editor context. |
|
uint32: 1 |
LogToConsole |
Whether to redirect standard log to the console |
|
uint32: 1 |
ShowErrorCount |
Whether to show standard error and warning count on exit |
|
uint32: 1 |
ShowProgress |
Whether to show cooking progress on tick |
Name | Description | |
---|---|---|
|
UCommandlet ( |
Name | Description | ||
---|---|---|---|
|
CreateCustomEngine ( |
Allows commandlets to override the default behavior and create a custom engine class for the commandlet. |
|
|
Main ( |
Entry point for your commandlet |
|
|
ParseCommandLine |
Parses a string into tokens, separating switches (beginning with - or /) from other parameters |
|
|
ParseCommandLine |
Parses a string into tokens, separating switches (beginning with - or /) from other parameters |