Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Core.Commandlet

Extends
Object
Modifiers
abstract transient native

Copyright 1998-2008 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
Constants Summary
Inherited Contants from Core.Object
DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg

Variables Summary
stringHelpDescription
array<string>HelpParamDescriptions
array<string>HelpParamNames
stringHelpUsage
stringHelpWebLink
boolIsClient
boolIsEditor
boolIsServer
boolLogToConsole
boolShowErrorCount
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
Inherited Enumerations from Core.Object
EAxis, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
Inherited Structures from Core.Object
Box, BoxSphereBounds, Color, Cylinder, double, DynamicMap_Mirror, Guid, IndirectArray_Mirror, InterpCurveFloat, InterpCurvePointFloat, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, Rotator, TextureMipBulkData_Mirror, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
eventint Main (string Params)
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClassIsChildOf, ClearConfig, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, Exp, FClamp, FCubicInterp, FindDeltaAngle, FindObject, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetDotDistance, GetEnum, GetFuncName, GetHeadingAngle, GetNetFuncName, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetSpecialValue, GetStateName, GetUnAxes, GotoState, InStr, IsA, IsChildState, IsInState, IsNetScript, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, OrthoRotation, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointInBox, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RandRange, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, SaveConfig, SClampRotAxis, ScriptTrace, SetSpecialValue, SetUTracing, Sin, Split, Sqrt, Square, StaticClearConfig, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=

Variables Detail

HelpDescription Source code

var localized string HelpDescription;
Description of the commandlet's purpose

HelpParamDescriptions Source code

var localized array<string> HelpParamDescriptions;
The description of the parameter

HelpParamNames Source code

var localized array<string> HelpParamNames;
The name of the parameter the commandlet takes

HelpUsage Source code

var localized string HelpUsage;
Usage template to show for "ucc help"

HelpWebLink Source code

var localized string HelpWebLink;
Hyperlink for more info

IsClient Source code

var bool IsClient;
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

var bool IsEditor;
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

var bool IsServer;
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

var bool LogToConsole;
Whether to redirect standard log to the console

ShowErrorCount Source code

var bool ShowErrorCount;
Whether to show standard error and warning count on exit

Functions Detail

Main Source code

native event int Main ( string Params )
Entry point for your commandlet
@param Params the string containing the parameters for the commandlet

Defaultproperties 

defaultproperties
{
   IsServer=True
   IsClient=True
   IsEditor=True
   ShowErrorCount=True
   Name="Default__Commandlet"
   ObjectArchetype=Object'Core.Default__Object'
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:35.512 - Created with UnCodeX