There is no spoon

UE3:Commandlet (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Commandlet
Package: 
Core
Direct subclasses:
ConvertMapToNavMesh, HelpCommandlet, TagSuboptimalTexturesCommandlet, FindUnreferencedFunctionsCommandlet
This class in other games:
RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UT3

UnrealScript 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.MakeCommandlet

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" UnrealScript environment, in which the game isn't loaded, the client code isn't loaded, no levels are loaded, and no actors exist.

Properties[edit]

HelpDescription[edit]

Type: string

Modifiers: localized

Description of the commandlet's purpose

HelpParamDescriptions[edit]

Type: array<string>

Modifiers: localized

The description of the parameter

HelpParamNames[edit]

Type: array<string>

Modifiers: localized

The name of the parameter the commandlet takes

HelpUsage[edit]

Type: string

Modifiers: localized

Usage template to show for "ucc help"

HelpWebLink[edit]

Type: string

Modifiers: localized

Hyperlink for more info

IsClient[edit]

Type: bool

Whether to load objects required in server, client, and editor context. If IsEditor is set to false, then a UGameEngine (or whatever the value of Engine.Engine.GameEngine is) will be created for the commandlet instead of a UEditorEngine (or Engine.Engine.EditorEngine), unless the commandlet overrides the CreateCustomEngine method.

Default value: True

IsEditor[edit]

Type: bool

Whether to load objects required in server, client, and editor context. If IsEditor is set to false, then a UGameEngine (or whatever the value of Engine.Engine.GameEngine is) will be created for the commandlet instead of a UEditorEngine (or Engine.Engine.EditorEngine), unless the commandlet overrides the CreateCustomEngine method.

Default value: True

IsServer[edit]

Type: bool

Whether to load objects required in server, client, and editor context. If IsEditor is set to false, then a UGameEngine (or whatever the value of Engine.Engine.GameEngine is) will be created for the commandlet instead of a UEditorEngine (or Engine.Engine.EditorEngine), unless the commandlet overrides the CreateCustomEngine method.

Default value: True

LogToConsole[edit]

Type: bool

Whether to redirect standard log to the console

ShowErrorCount[edit]

Type: bool

Whether to show standard error and warning count on exit

Default value: True

Native functions[edit]

Main[edit]

native event int Main (string Params)

Entry point for your commandlet

Parameters:

  • Params - the string containing the parameters for the commandlet