FScriptArgBuilder

struct FScriptArgBuilder

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

Dependencies: FScriptArgBuilder

Public Interface

Public Functions:

AddStringArg

FScriptArgBuilder & AddStringArg(FString ArgName, FString ArgValue)

Add a string argument to the command line.

Parameters:

• ArgName (FString) – [in] The name of the argument
• ArgValue (FString) – [in] The value of the argument

Returns: FScriptArgBuilder &

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 22, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 7-11)

AddFloatArg

FScriptArgBuilder & AddFloatArg(FString ArgName, float ArgValue)

Add a float argument to the command line.

Parameters:

• ArgName (FString) – [in] The name of the argument
• ArgValue (float) – [in] The value of the argument. Will be converted to a string

Returns: FScriptArgBuilder &

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 29, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 13-16)

AddIntArg

FScriptArgBuilder & AddIntArg(FString ArgName, int ArgValue)

Add an integer argument to the command line.

Parameters:

• ArgName (FString) – [in] The name of the argument
• ArgValue (int) – [in] The value of the argument. Will be converted to a string

Returns: FScriptArgBuilder &

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 36, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 18-21)

AddFlag

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

Add a flag to the command line.

Parameters:

• FlagName (FString) – [in] The name of the flag
• bCondition (bool) – [in] Whether the flag should be added. Useful programmatically setting conditional flags.

Returns: FScriptArgBuilder &

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 43, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 23-30)

AddConditionalStringArg

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

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

Parameters:

• ArgName (FString) – [in] The name of the argument
• ArgValue (FString) – [in] The value of the argument
• bCondition (bool) – [in] Whether the argument should be added. Useful programmatically setting conditional arguments.

Returns: FScriptArgBuilder &

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 51, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 32-39)

AddIntArrayArg

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 (FString) – [in] The name of the argument
• ArgValue (const TArray<int> &) – [in] The value of the argument

Returns: FScriptArgBuilder &

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 59, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 40-49)

AddPositionalArgument

FScriptArgBuilder & AddPositionalArgument(FString Arg)

Add a positional argument (i.e.

does not append - infront of the name)

Parameters:

• Arg (FString) – [in] The argument to add

Returns: FScriptArgBuilder &

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 65, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 51-54)

Build

FString Build()

Construct the command line string from the added arguments.

Returns: The command line string

Returns: FString

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 71, column 9)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ArgBuilder.cpp (lines 56-65)

Public Members:

TArray<FString> Args

TArray<FString> Args

The arguments to be passed to the commnand line script.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 15, column 8)

Used By

This type is used by:

• FCustomTrainingSettings
• FRLlibAPPOSettings
• FRLlibCheckpointSettings
• FRLlibIMPALASettings
• FRLlibLoggingSettings
• FRLlibNetworkArchSettings
• FRLlibPPOSettings
• FRLlibResourceSettings
• FRLlibResumeSettings
• FRLlibTrainingSettings
• FSB3CheckpointSettings
• FSB3LoggingSettings
• FSB3NetworkArchSettings
• FSB3PPOSettings
• FSB3ResumeSettings
• FSB3SACSettings
• FSB3TrainingSettings
• FScriptArgBuilder
• FTrainingSettings

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ArgBuilder.h (line 10, column 1)