Cogito, ergo sum

Commandlet

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
Object >> Commandlet
Direct subclass:
HelloWorldCommandlet
This class in other games:
RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UDK, UT3

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

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

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" to the name and tries again. Additionally, typically used commandlets do not need their package name specified. This allows users to just type ucc server ... instead of ucc Engine.ServerCommandlet .... Games that do not come with ucc.exe (e.g. very early Unreal Engine 1 games and any Unreal Engine 3 games) can execute commandlets via the main executable of the game. Unreal Engine 3 may require the parameter run for non-native commandlets, e.g.:

UT3.exe run package_name.commandlet_class_name [parm=value]...

Any param=value options on the commandline are parsed and values for parameters matching variable names of the commandlet class are assigned to those variables.

Native functions[edit]

Main[edit]

native event int Main (string Params)

Entry point for your commandlet. Override this function without calling Super.Main()! The default implementation of this function calls the native C++ Main() function with the specified parameter string, which in turn calls this UnrealScript Main() function by default, resulting in an infinite recursion.

One might expect the return value becomes the exit value of the UCC process, but it is actually discarded. UCC always exits with code 0 (no error), unless any errors (not warnings) were logged, which causes UCC to exit with code 1. An exception to this is the UDK, which correctly returns the given value.

Parameters:

  • Params - the string containing the parameters for the commandlet

Important commandlets[edit]

BatchExportCommandlet 
Exports resources from Unreal packages.
BatchImportCommandletUE1?, UE2 
Import resources into Unreal packages. (Must prefix with Editor.)
HelpCommandlet 
Displays help for other commandlets. (ucc help commandletname)
MakeCommandlet 
Compiles UnrealScript code.
MasterCommandlet 
Creates UMOD files.
PkgCommandlet 
A tool for editing Unreal packages from the commandline.
ServerCommandlet 
Runs a dedicated game server.
ConformCommandlet 
Makes Unreal packages network-compatible.
CompressCommandlet 
Compresses Unreal packages for redirected downloads.
UncompressCommandlet 
Decompresses files created by the CompressCommandlet.

Testers[edit]

TestCompressionCommandletUE3
TestTextureCompressionCommandletUE3
TestWordWrapCommandletUE3
ExamineOutersCommandletUE3
PerformMapCheckCommandletUE3
CheckSoundsUT2004
CheckEmittersUT2004
CheckStaticMeshesUT2004
CheckTexturesUT2004
CheckLightMapUVsCommandletUE3
CheckSumCommandlet
ChecksumPackageCommandlet
CheckUnicodeCommandlet

Listers[edit]

ListCorruptedComponentsCommandletUE3
ListCustomMaterialExpressionsCommandletUE3
ListDistanceCrossFadeNodesCommandletUE3
ListEmittersUsingModuleCommandletUE3
ListExportsUE2, UE3?
ListLoopingEmittersCommandletUE3
ListPackagesReferencingCommandletUE3
ListPSysFixedBoundSettingCommandletUE3
ListScriptReferencedContentCommandletUE3
ListSoundNodeWavesCommandletUE3

Finders[edit]

FindCinematicTexturesCommandletUE3
FindTexturesWithMissingPhysicalMaterialsCommandletUE3
FindQuestionableTexturesCommandletUE3
FindSoundCuesWithMissingGroupsCommandletUE3
FindDuplicateKismetObjectsCommandletUE3
FindStaticMeshEmptySectionsCommandletUE3
FindStaticMeshCanBecomeDynamicCommandletUE3
FindAssetReferencersCommandletUE3
FindEmitterModuleLODErrorsCommandletUE3
FindDarkDiffuseTexturesCommandletUE3
FindNeverStreamTexturesCommandletUE3
FindDuplicateTexturesCommandletUE3
FindEmitterMismatchedLODsCommandletUE3
FindEmitterModifiedLODsCommandletUE3
FindUniqueSpecularTextureMaterialsCommandletUE3

Fixers[edit]

FixAdditiveReferencesCommandletUE3
FixAmbiguousMaterialParametersCommandletUE3
FixupEmittersCommandletUE3
FixupRedirectsCommandletUE3
FixupSourceUVsCommandletUE3

Analyzers[edit]

AnalyzeBuildCommandletUE2
AnalyzeContentCommandletUE3
AnalyzeCookedContentCommandletUE3
AnalyzeCookedTextureDXT5UsageCommandletUE3
AnalyzeCookedTextureSingleUsageCommandletUE3
AnalyzeCookedTextureUsageCommandletUE3
AnalyzeDVDSpaceCommandletUE3
AnalyzeFallbackMaterialsCommandletUE3
AnalyzeKismetCommandletUE3
AnalyzePackageCommandletUE2
AnalyzeParticleSystemsCommandletUE3
AnalyzeShaderCachesCommandletUE3
AnalyzeScriptCommandletUE3

Other commandlets[edit]

DataRipCommandlet
MasterServerCommandlet
MergeDXTCommandlet
PackageFlagCommandlet
PS2ConvertCommandlet
UpdateServerCommandlet
UpdateUModCommandlet
BatchingSummary
ClassFlagCommandlet
DXTConvertCommandlet
GroupRepairCommandlet
MapKillZ
ObjectRenameCommandlet
SetNormalLODCommandlet
StaticMeshConvert
StreamCommandlet
SurfaceTypeCommandlet
ConvertMaterialCommandletUE2
DumpIntCommandletUE2 
Dumps all variable names and values marked with the flag localized into an .int file.
 ucc.exe Editor.DumpIntCommandlet PACKAGENAME.u [-mod=MODNAME]
MasterMD5CommandletUE2
UTVCommandletUE2
CompareIntCommandletUE2
CutDownContentCommandletUE2
CutDownPackagesCommandlet
StripSourceCommandletUT2004
DumpConfigCommandletUT2004
ExportCacheCommandletUT2004
GroupRepairCommandletUT2004
MapConvertCommandletUT2004
MergeIntCommandletUT2004
RearrangeIntCommandletUT2004
RebuildCommandletUT2004
TextureInfoCommandletUT2004
TextureLODCommandletUT2004
TextureStripCommandletUT2004
UModUnpackCommandletUT2004
ReimportTexturesCommandlet
CompressTexturesUT2004
ConvertTexturesCommandlet
ContentAuditCommandletUE3
ContentComparisonCommandletUE3
SoundCueAuditCommandletUE3
OutputAuditSummaryCommandletUE3
ConvertMapToNavMeshUE3
DiffPackagesCommandletUE3
ExportLocCommandletUE3
 ?.exe ExportLocCommandlet [PACKAGENAME.EXT] [-full]
CompareLocCommandletUE3
 ?.exe CompareLocCommandlet LANGUAGEXTENSION
PatchScriptCommandletUE3
PrecompileShadersCommandletUE3
DumpShadersCommandletUE3
SetMaterialUsageCommandletUE3
ParticleSystemAuditCommandletUE3
LensFlareAuditCommandletUE3
MaterialAuditCommandletUE3
PMapForceObjectCheckCommandletUE3
UpdateKismetCommandletUE3
SetTextureLODGroupCommandletUE3
CompressAnimationsCommandletUE3
WrangleContentCommandletUE3
SetMaterialUsageCommandletUE3
SetPackageFlagsCommandletUE3
PIEToNormalCommandletUE3
UT3MapStatsCommandletUE3, UT3
OutputAuditSummaryCommandletUE3
DumpLightmapInfoCommandletUE3
PerformTerrainMaterialDumpCommandletUE3
MineCookedPackagesCommandletUE3
LoadPackageUT2004, UE3?
ConvertEmittersCommandletUE3
DumpEmittersCommandletUE3
ConvertUberEmittersCommandletUE3
ReplaceActorCommandletUE3
CheckpointGameAssetDatabaseCommandletUE3
LocSoundInfoCommandletUE3
DumpPropertiesCommandletUE3
ContentAuditCommandletUE3
ContentComparisonCommandletUE3
SoundClassInfoCommandletUE3
WriteGameStatsReportCommandletUE3
TagCookedReferencedAssetsCommandletUE3
TagReferencedAssetsCommandletUE3
ShowTaggedPropsCommandletUE3
ShowPropertyFlagsCommandletUE3
ShowObjectCountCommandletUE3
ShowStylesCommandletUE3
CreateDefaultStyleCommandletUE3
CreateStreamingWorldCommandletUE3
PkgInfoCommandletUE3
ResavePackagesCommandletUE3
ScaleAudioVolumeCommandletUE3
CookPackagesCommandletUE3
CookPackagesXenonCommandlet
MergePackagesCommandletUE3