FScriptSettings

struct FScriptSettings

All settings for autolaunching a script when starting the game.

Dependencies

This type depends on:

• FCustomTrainingSettings
• FLaunchableScript
• FRLlibTrainingSettings
• FSB3TrainingSettings

Public Interface

Destructor:

~FScriptSettings

virtual ~FScriptSettings()

Attributes: virtual

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 117, column 9)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ScriptSettings.cpp (lines 122-124)

Public Functions:

GetTrainingArgs

FString GetTrainingArgs(int Port) const const

Parameters:

Name	Type	Default
Port	int	“

Returns: FString

Attributes: const

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 103, column 9)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ScriptSettings.cpp (lines 11-36)

GetScriptPath

FFilePath GetScriptPath() const const

Get the path to the script to run.

Returns: The path to the script to run

Returns: FFilePath

Attributes: const

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 109, column 11)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ScriptSettings.cpp (lines 38-58)

GetLaunchableScript

FLaunchableScript GetLaunchableScript() const const

Returns: FLaunchableScript

Attributes: const

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 111, column 19)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ScriptSettings.cpp (lines 60-84)

GetBuiltInPythonPath

FString GetBuiltInPythonPath() const const

Returns: FString

Attributes: const

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 113, column 9)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ScriptSettings.cpp (lines 86-98)

EnsureScholaIsInstalled

void EnsureScholaIsInstalled() const const

Attributes: const

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 115, column 6)

Implementation: Schola/Source/Schola/Private/Subsystem/SubsystemSettings/ScriptSettings.cpp (lines 100-120)

Public Members:

EScriptType ScriptType

EScriptType ScriptType = = EScriptType::Python

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

Python, or Other CLI script)

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 69, column 13)

EPythonEnvironmentType EnvType

EPythonEnvironmentType EnvType = = EPythonEnvironmentType::BuiltIn

The Python environment to use when running a python script.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 73, column 24)

FString CondaEnvName

FString CondaEnvName

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

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 77, column 9)

FFilePath CustomPythonPath

FFilePath CustomPythonPath

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

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 81, column 11)

EPythonScript PythonScriptType

EPythonScript PythonScriptType = = EPythonScript::SB3

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

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 85, column 15)

FCustomTrainingSettings CustomPythonScriptSettings

FCustomTrainingSettings CustomPythonScriptSettings

Settings to use when running a custom python script.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 89, column 25)

FCustomTrainingSettings CustomScriptSettings

FCustomTrainingSettings CustomScriptSettings

Settings to use when running a custom script.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 93, column 25)

FSB3TrainingSettings SB3Settings

FSB3TrainingSettings SB3Settings

Settings to use when running the builtin SB3 script.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 97, column 22)

FRLlibTrainingSettings RLlibSettings

FRLlibTrainingSettings RLlibSettings

Settings to use when running the builtin RLlib script.

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 101, column 24)

Used By: UScholaManagerSubsystemSettings

Source: Schola/Source/Schola/Public/Subsystem/SubsystemSettings/ScriptSettings.h (line 61, column 1)