Struct FScriptArgBuilder

struct FScriptArgBuilder

A class to build arguments and flags for a CLI script.

Public Functions

FScriptArgBuilder &AddStringArg(FString ArgName, FString ArgValue)

Add a string argument to the command line.

Parameters:

• ArgName – [in] The name of the argument

• ArgValue – [in] The value of the argument

FScriptArgBuilder &AddFloatArg(FString ArgName, float ArgValue)

Add a float argument to the command line.

Parameters:

• ArgName – [in] The name of the argument

• ArgValue – [in] The value of the argument. Will be converted to a string

FScriptArgBuilder &AddIntArg(FString ArgName, int ArgValue)

Add an integer argument to the command line.

Parameters:

• ArgName – [in] The name of the argument

• ArgValue – [in] The value of the argument. Will be converted to a string

FScriptArgBuilder &AddFlag(FString FlagName, bool bCondition = true)

Add a flag to the command line.

Parameters:

• FlagName – [in] The name of the flag

• bCondition – [in] Whether the flag should be added. Useful programmatically setting conditional flags.

FScriptArgBuilder &AddConditionalStringArg(FString ArgName, FString ArgValue, bool bCondition)

Add a string argument to the command line if a condition is met.

Parameters:

• ArgName – [in] The name of the argument

• ArgValue – [in] The value of the argument

• bCondition – [in] Whether the argument should be added. Useful programmatically setting conditional arguments.

FScriptArgBuilder &AddIntArrayArg(FString ArgName, const TArray<int> &ArgValue)

Add an integer array argument to the command line.

Note

The array will be converted to a string by converting to a string array and putting spaces between each value

Parameters:

• ArgName – [in] The name of the argument

• ArgValue – [in] The value of the argument

FScriptArgBuilder &AddPositionalArgument(FString Arg)

Add a positional argument (i.e.

does not append – infront of the name)

Parameters:

Arg – [in] The argument to add

FString Build()

Construct the command line string from the added arguments.

Returns:

The command line string

Public Members

TArray<FString> Args

The arguments to be passed to the commnad line script.