Struct FScriptSettings

Struct FScriptSettings

• Defined in File ScriptSettings.h

struct FScriptSettings

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Dependencies: FCustomTrainingSettings, FLaunchableScript, FRLlibTrainingSettings, FSB3TrainingSettings, FScriptArgBuilder

All settings for autolaunching a script when starting the game.

---

Public Functions

Symbol	Details
GetTrainingArgs	Generate training arguments using the provided argument builder.
GetTrainingArgs	Generate training arguments with a default argument builder.
GetScriptPath	Get the file system path to the script to run.
GetLaunchableScript	Get a configured launchable script ready to execute.
GetBuiltInPythonPath	Get the path to the built-in Unreal Engine Python interpreter.
EnsureScholaIsInstalled	Verify that Schola is installed in the Python environment.
~FScriptSettings	Virtual destructor.

GetTrainingArgs

FString GetTrainingArgs(FScriptArgBuilder &InArgBuilder) const

Generate training arguments using the provided argument builder.

Parameters

InArgBuilder – [inout] The argument builder to populate.

Returns:

The generated argument string.

#	Direction	Name	Type	Description
1	—	InArgBuilder	FScriptArgBuilder &	The argument builder to populate.

Attributes: const

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/ScriptSettings.cpp

GetTrainingArgs

FString GetTrainingArgs() const

Generate training arguments with a default argument builder.

Returns:

The generated argument string.

#	Direction	Name	Type	Description
1	—	InArgBuilder	FScriptArgBuilder &	The argument builder to populate.

Attributes: const

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/ScriptSettings.cpp

GetScriptPath

FString GetScriptPath() const

Get the file system path to the script to run.

Returns:

The path to the script executable/file.

Attributes: const

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/ScriptSettings.cpp

GetLaunchableScript

FLaunchableScript GetLaunchableScript() const

Get a configured launchable script ready to execute.

Returns:

A launchable script struct with path and arguments set.

Attributes: const

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/ScriptSettings.cpp

GetBuiltInPythonPath

FString GetBuiltInPythonPath() const

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

Returns:

Path to the Python executable.

Attributes: const

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/ScriptSettings.cpp

EnsureScholaIsInstalled

void EnsureScholaIsInstalled() const

Verify that Schola is installed in the Python environment.

Logs warnings if Schola is not found.

Attributes: const

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/ScriptSettings.cpp

---

~FScriptSettings

virtual ~FScriptSettings()

Virtual destructor.

Attributes: virtual

Source: Source/Schola/Training/Public/TrainingSettings/ScriptSettings.h

Implementation: Source/Schola/Training/Private/TrainingSettings/ScriptSettings.cpp

---

Public Members

Symbol	Details
ScriptType	The type of the script to run (e.g.
EnvType	The Python environment to use when running a python script.
CondaEnvName	The name of the conda environment to run the python script in.
CustomPythonPath	The path to a python executable if using a non-default executable.
PythonScriptType	The type of python script to run, options are scripts builtin to Schola, or a user provided script.
CustomPythonScriptSettings	Settings to use when running a custom python script.
CustomScriptSettings	Settings to use when running a custom script.
SB3Settings	Settings to use when running the builtin SB3 script.
RLlibSettings	Settings to use when running the builtin RLlib script.

---

ScriptType

EScriptType ScriptType = EScriptType::Python

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

Python, or Other CLI script)

---

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.

---

PythonScriptType

EPythonScript PythonScriptType = EPythonScript::SB3

The type of python script to run, options are scripts builtin to Schola, or a user provided script.

---

CustomPythonScriptSettings

FCustomTrainingSettings CustomPythonScriptSettings

Settings to use when running a custom python script.

---

CustomScriptSettings

FCustomTrainingSettings CustomScriptSettings

Settings to use when running a custom script.

---

SB3Settings

FSB3TrainingSettings SB3Settings

Settings to use when running the builtin SB3 script.

---

RLlibSettings

FRLlibTrainingSettings RLlibSettings

Settings to use when running the builtin RLlib script.