Skip to content

UnrealExecutableCommandLinePlaceholder

Full path: schola.scripts.common.UnrealExecutableCommandLinePlaceholder

schola.scripts.common.UnrealExecutableCommandLinePlaceholder

UnrealExecutableCommandLinePlaceholder

UnrealExecutableCommandLinePlaceholder

Bases: UnrealExecutableSimulatorArgs

A placeholder for the UnrealExecutableSimulatorArgs to allow for a default instantiation. All attempts to use the object will raise a RuntimeError.

Methods

ItemDescription
init
makeCreate an UnrealExecutable simulator instance with the specified settings.

Attributes

ItemDescription
disable_scriptFlag indicating if the autolaunch script setting in the Unreal Engine Schola Plugin should be disabled.
display_logsWhether to render logs in a standalone window.
executable_pathPath to the standalone executable, when launching a standalone Environment must exist and be a file
fpsFixed FPS to use when running standalone, if None no fixed timestep is used
headlessFlag indicating if the standalone Unreal Engine process should run in headless mode
mapMap to load when launching a standalone Unreal Engine process

init

__init__()

executable_path

= None executable_path: Path | None

Path to the standalone executable, when launching a standalone Environment must exist and be a file


make

make()

Create an UnrealExecutable simulator instance with the specified settings.

Returns

A configured UnrealExecutable simulator instance.

Return type: UnrealExecutable