Core.Commandlet

Extends

Object

Modifiers

abstract transient noexport native

UnrealScript Commandlet (command-line applet) class.

Commandlets are executed from the ucc.exe command line utility, using the
following syntax:

UCC.exe package_name.commandlet_class_name [parm=value]...

for example:

UCC.exe Core.HelloWorldCommandlet
UCC.exe Editor.MakeCommandlet

In addition, if you list your commandlet in the public section of your
package's .int file (see Engine.int for example), then your commandlet
can be executed without requiring a fully qualified name, for example:

UCC.exe 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:

UCC.exe Core.HelloWorld
UCC.exe Editor.Make
UCC.exe Make

It is also perfectly valid to call the Main method of a
commandlet class directly, for example from within the body
of another commandlet.

Commandlets are executed in a "raw" UnrealScript environment, in which
the game isn't loaded, the client code isn't loaded, no levels are

Core.Object
|   
+-- Core.Commandlet

Direct Known Subclasses:

StreamCommandlet, xAdminCommandlet, xWebAdminCommandLet

Functions Summary
	int	Main (string Parms)

HelpCmd Source code

// Command name to show for "ucc help".

HelpDesc[16] Source code

HelpOneLiner Source code

// Command description to show for "ucc help".

HelpParm[16] Source code

// Parameters and descriptions for "ucc help ".

HelpUsage Source code

// Usage template to show for "ucc help".

HelpWebLink Source code

// Hyperlink for more info.

IsClient Source code

// Whether to load objects required in server, client, and editor context.

IsEditor Source code

// Whether to load objects required in server, client, and editor context.

IsServer Source code

// Whether to load objects required in server, client, and editor context.

LazyLoad Source code

// Whether to load objects immediately, or only on demand.

LogToStdout Source code

// Whether to redirect log output to console stdout.

ShowBanner Source code

// Whether to show Unreal banner on startup.

ShowErrorCount Source code

// Whether to show standard error and warning count on exit.

Main Source code

// Entry point.

defaultproperties
{
	LogToStdout=true
	IsServer=true
	IsClient=true
	IsEditor=true
	LazyLoad=true
	ShowErrorCount=false
	ShowBanner=true
}