Difference between revisions of "Commandlet"

Latest revision as of 14:57, 26 November 2012

Direct subclass:

HelloWorldCommandlet

This class in other games:

RTNP, U1, UT, UE2Runtime, UT2003, U2, U2XMP, 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]

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.

BatchImportCommandlet^{UE1?, 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]

TestCompressionCommandlet^UE3

TestTextureCompressionCommandlet^UE3

TestWordWrapCommandlet^UE3

ExamineOutersCommandlet^UE3

PerformMapCheckCommandlet^UE3

CheckSounds^UT2004

CheckEmitters^UT2004

CheckStaticMeshes^UT2004

CheckTextures^UT2004

CheckLightMapUVsCommandlet^UE3

CheckSumCommandlet

ChecksumPackageCommandlet

CheckUnicodeCommandlet

Listers[edit]

ListCorruptedComponentsCommandlet^UE3

ListCustomMaterialExpressionsCommandlet^UE3

ListDistanceCrossFadeNodesCommandlet^UE3

ListEmittersUsingModuleCommandlet^UE3

ListExports^{UE2, UE3?}

ListLoopingEmittersCommandlet^UE3

ListPackagesReferencingCommandlet^UE3

ListPSysFixedBoundSettingCommandlet^UE3

ListScriptReferencedContentCommandlet^UE3

ListSoundNodeWavesCommandlet^UE3

Finders[edit]

FindCinematicTexturesCommandlet^UE3

FindTexturesWithMissingPhysicalMaterialsCommandlet^UE3

FindQuestionableTexturesCommandlet^UE3

FindSoundCuesWithMissingGroupsCommandlet^UE3

FindDuplicateKismetObjectsCommandlet^UE3

FindStaticMeshEmptySectionsCommandlet^UE3

FindStaticMeshCanBecomeDynamicCommandlet^UE3

FindAssetReferencersCommandlet^UE3

FindEmitterModuleLODErrorsCommandlet^UE3

FindDarkDiffuseTexturesCommandlet^UE3

FindNeverStreamTexturesCommandlet^UE3

FindDuplicateTexturesCommandlet^UE3

FindEmitterMismatchedLODsCommandlet^UE3

FindEmitterModifiedLODsCommandlet^UE3

FindUniqueSpecularTextureMaterialsCommandlet^UE3

Fixers[edit]

FixAdditiveReferencesCommandlet^UE3

FixAmbiguousMaterialParametersCommandlet^UE3

FixupEmittersCommandlet^UE3

FixupRedirectsCommandlet^UE3

FixupSourceUVsCommandlet^UE3

Analyzers[edit]

AnalyzeBuildCommandlet^UE2

AnalyzeContentCommandlet^UE3

AnalyzeCookedContentCommandlet^UE3

AnalyzeCookedTextureDXT5UsageCommandlet^UE3

AnalyzeCookedTextureSingleUsageCommandlet^UE3

AnalyzeCookedTextureUsageCommandlet^UE3

AnalyzeDVDSpaceCommandlet^UE3

AnalyzeFallbackMaterialsCommandlet^UE3

AnalyzeKismetCommandlet^UE3

AnalyzePackageCommandlet^UE2

AnalyzeParticleSystemsCommandlet^UE3

AnalyzeShaderCachesCommandlet^UE3

AnalyzeScriptCommandlet^UE3

Other commandlets[edit]

DataRipCommandlet

MasterServerCommandlet

MergeDXTCommandlet

PackageFlagCommandlet

PS2ConvertCommandlet

UpdateServerCommandlet

UpdateUModCommandlet

BatchingSummary

ClassFlagCommandlet

DXTConvertCommandlet

GroupRepairCommandlet

MapKillZ

ObjectRenameCommandlet

SetNormalLODCommandlet

StaticMeshConvert

StreamCommandlet

SurfaceTypeCommandlet

ConvertMaterialCommandlet^UE2

DumpIntCommandlet^UE2 

Dumps all variable names and values marked with the flag localized into an .int file.

 ucc.exe Editor.DumpIntCommandlet PACKAGENAME.u [-mod=MODNAME]

MasterMD5Commandlet^UE2

UTVCommandlet^UE2

CompareIntCommandlet^UE2

CutDownContentCommandlet^UE2

CutDownPackagesCommandlet

StripSourceCommandlet^UT2004

DumpConfigCommandlet^UT2004

ExportCacheCommandlet^UT2004

GroupRepairCommandlet^UT2004

MapConvertCommandlet^UT2004

MergeIntCommandlet^UT2004

RearrangeIntCommandlet^UT2004

RebuildCommandlet^UT2004

TextureInfoCommandlet^UT2004

TextureLODCommandlet^UT2004

TextureStripCommandlet^UT2004

UModUnpackCommandlet^UT2004

ReimportTexturesCommandlet

CompressTextures^UT2004

ConvertTexturesCommandlet

ContentAuditCommandlet^UE3

ContentComparisonCommandlet^UE3

SoundCueAuditCommandlet^UE3

OutputAuditSummaryCommandlet^UE3

ConvertMapToNavMesh^UE3

DiffPackagesCommandlet^UE3

ExportLocCommandlet^UE3

 ?.exe ExportLocCommandlet [PACKAGENAME.EXT] [-full]

CompareLocCommandlet^UE3

 ?.exe CompareLocCommandlet LANGUAGEXTENSION

PatchScriptCommandlet^UE3

PrecompileShadersCommandlet^UE3

DumpShadersCommandlet^UE3

SetMaterialUsageCommandlet^UE3

ParticleSystemAuditCommandlet^UE3

LensFlareAuditCommandlet^UE3

MaterialAuditCommandlet^UE3

PMapForceObjectCheckCommandlet^UE3

UpdateKismetCommandlet^UE3

SetTextureLODGroupCommandlet^UE3

CompressAnimationsCommandlet^UE3

WrangleContentCommandlet^UE3

SetMaterialUsageCommandlet^UE3

SetPackageFlagsCommandlet^UE3

PIEToNormalCommandlet^UE3

UT3MapStatsCommandlet^{UE3, UT3}

OutputAuditSummaryCommandlet^UE3

DumpLightmapInfoCommandlet^UE3

PerformTerrainMaterialDumpCommandlet^UE3

MineCookedPackagesCommandlet^UE3

LoadPackage^{UT2004, UE3?}

ConvertEmittersCommandlet^UE3

DumpEmittersCommandlet^UE3

ConvertUberEmittersCommandlet^UE3

ReplaceActorCommandlet^UE3

CheckpointGameAssetDatabaseCommandlet^UE3

LocSoundInfoCommandlet^UE3

DumpPropertiesCommandlet^UE3

ContentAuditCommandlet^UE3

ContentComparisonCommandlet^UE3

SoundClassInfoCommandlet^UE3

WriteGameStatsReportCommandlet^UE3

TagCookedReferencedAssetsCommandlet^UE3

TagReferencedAssetsCommandlet^UE3

ShowTaggedPropsCommandlet^UE3

ShowPropertyFlagsCommandlet^UE3

ShowObjectCountCommandlet^UE3

ShowStylesCommandlet^UE3

CreateDefaultStyleCommandlet^UE3

CreateStreamingWorldCommandlet^UE3

PkgInfoCommandlet^UE3

ResavePackagesCommandlet^UE3

ScaleAudioVolumeCommandlet^UE3

CookPackagesCommandlet^UE3

CookPackagesXenonCommandlet

MergePackagesCommandlet^UE3