FScriptSettingsBase

Base class for all script settings (Training, Imitation, etc).

Contains common functionality for Python environment management and script launching that is shared across different script types.

Subclassed by FImitationScriptSettings, FTrainingScriptSettings

struct FScriptSettingsBase

Methods

GetLaunchableScript

FLaunchableScript GetLaunchableScript() const

Get a configured launchable script ready to execute.

---

GetBuiltInPythonPath

FString GetBuiltInPythonPath() const

Get the path to the built-in Unreal Engine Python interpreter.

---

EnsureScholaIsInstalled

void EnsureScholaIsInstalled() const

Verify that Schola is installed in the Python environment.

---

GetScriptPath

inline virtual FString GetScriptPath() const

Get the file system path to the script to run.

---

GetArgs

inline virtual void GetArgs(FScriptArgBuilder &InArgBuilder) const

Get the arguments for the script to run.

Parameters

• InArgBuilder (FScriptArgBuilder)

---

GetArgs

FString GetArgs() const

Get the arguments for the script to run.

---

FScriptSettingsBase

virtual ~FScriptSettingsBase()

Virtual destructor.

Attributes

ScriptType

EScriptType ScriptType = EScriptType::Python

The type of the script to run (e.g.

---

EnvType

EPythonEnvironmentType EnvType = EPythonEnvironmentType::BuiltIn

The Python environment to use when running a python script.

---

CondaEnvName

FString CondaEnvName

The name of the conda environment to run the python script in.

---

CustomPythonPath

FFilePath CustomPythonPath

The path to a python executable if using a non-default executable.

Source: Source/ScholaTraining/Public/TrainingSettings/ScriptSettingsBase.h