Core.Commandlet

Extends

Object

Modifiers

abstract transient native

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved. 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 Editor.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 Editor.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.

Core.Object
|   
+-- Core.Commandlet

Direct Known Subclasses:

HelpCommandlet, TestCommandlet, TestCommandletBase

Functions Summary
	int	Main (string Params)

HelpDescription Source code

Description of the commandlet's purpose

HelpParamDescriptions Source code

The description of the parameter

HelpParamNames Source code

The name of the parameter the commandlet takes

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

IsEditor Source code

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.

IsServer Source code

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.

LogToConsole Source code

Whether to redirect standard log to the console

ShowErrorCount Source code

Whether to show standard error and warning count on exit

Main Source code

Entry point for your commandlet
@param Params the string containing the parameters for the commandlet

defaultproperties
{
   IsServer=True
   IsClient=True
   IsEditor=True
   ShowErrorCount=True
   Name="Default__Commandlet"
   ObjectArchetype=Object'Core.Default__Object'
}