Commandlet.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Commandlet.generated.h"
 
UCLASS(abstract, transient, MinimalAPI)
class UCommandlet : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY()
    FString HelpDescription;
 
    UPROPERTY()
    FString HelpUsage;
 
    UPROPERTY()
    FString HelpWebLink;
 
    UPROPERTY()
    TArray<FString> HelpParamNames;
 
    UPROPERTY()
    TArray<FString> HelpParamDescriptions;
 
    UPROPERTY()
    uint32 IsServer:1;
 
    UPROPERTY()
    uint32 IsClient:1;
 
    UPROPERTY()
    uint32 IsEditor:1;
 
    UPROPERTY()
    uint32 LogToConsole:1;
 
    UPROPERTY()
    uint32 ShowErrorCount:1;
  
    UPROPERTY()
    uint32 ShowProgress:1;
 
    UPROPERTY()
    uint32 FastExit:1;
 
    UPROPERTY()
    uint32 UseCommandletResultAsExitCode: 1;
 
    virtual int32 Main(const FString& Params) { return 0; }
 
    static void ParseCommandLine( const TCHAR* CmdLine, TArray<FString>& Tokens, TArray<FString>& Switches )
    {
        FString NextToken;
        while ( FParse::Token(CmdLine, NextToken, false) )
        {
            if ( **NextToken == TCHAR('-') )
            {
                Switches.Add(NextToken.Mid(1));
            }
            else
            {
                Tokens.Add(MoveTemp(NextToken));
            }
        }
    }
 
    static void ParseCommandLine( const TCHAR* CmdLine, TArray<FString>& Tokens, TArray<FString>& Switches, TMap<FString, FString>& Params )
    {
        // Turn -foo -bar=1 into [Foo, Bar=1]
        ParseCommandLine(CmdLine, Tokens, Switches);
 
        for (int32 SwitchIdx = Switches.Num() - 1; SwitchIdx >= 0; --SwitchIdx)
        {
            FString& Switch = Switches[SwitchIdx];
            TArray<FString> SplitSwitch;
 
            // Remove Bar=1 from the switch list and put it in params as {Bar,1}.
            // Note: Handle nested equality such as Bar="Key=Value"
            int32 AssignmentIndex = 0;
            if (Switch.FindChar(TEXT('='), AssignmentIndex))
            {
                Params.Add(Switch.Left(AssignmentIndex), Switch.RightChop(AssignmentIndex+1).TrimQuotes());
                Switches.RemoveAt(SwitchIdx);
            }
        }
    }
 
#if WITH_EDITOR
    static ENGINE_API bool ApplyCommandLineSwitches( UObject* Object, const TArray<FString>& Switches );
#endif //  WITH_EDITOR
 
    virtual void CreateCustomEngine(const FString& Params) {}
};
 
namespace CommandletHelpers
{
    ENGINE_API void TickEngine(class UWorld* InWorld = nullptr, double InDeltaTime = 0.0);
}