UnrealExecutableSimulatorArgs

Full path: schola.scripts.common.UnrealExecutableSimulatorArgs

schola.scripts.common.UnrealExecutableSimulatorArgs

UnrealExecutableSimulatorArgs(
    executable_path,
    disable_script=True,
    headless=False,
    map=None,
    fps=None,
    display_logs=True,
)

Bases: object

Arguments for the Unreal Engine executable simulator in Schola.

This dataclass is used when you want to create a standalone Unreal Engine environment controlled by the Schola Python API.

Item	Description
init	—
make	Create an UnrealExecutable simulator instance with the specified settings.

Item	Description
disable_script	Flag indicating if the autolaunch script setting in the Unreal Engine Schola Plugin should be disabled.
display_logs	Whether to render logs in a standalone window.
fps	Fixed FPS to use when running standalone, if None no fixed timestep is used
headless	Flag indicating if the standalone Unreal Engine process should run in headless mode
map	Map to load when launching a standalone Unreal Engine process
executable_path	Path to the standalone executable, when launching a standalone Environment must exist and be a file

executable_path (Annotated[Path, Parameter(validator=(Path(exists=True, file_okay=True, dir_okay=False, ext=()),))])

disable_script (bool)

headless (bool)

map (str | None)

fps (int | None)

display_logs (bool)

__init__(
    executable_path,
    disable_script=True,
    headless=False,
    map=None,
    fps=None,
    display_logs=True,
)

executable_path (Annotated[Path, Parameter(validator=(Path(exists=True, file_okay=True, dir_okay=False, ext=()),))])

disable_script (bool)

headless (bool)

map (str | None)

fps (int | None)

display_logs (bool)

None

= True disable_script: bool

Flag indicating if the autolaunch script setting in the Unreal Engine Schola Plugin should be disabled. Useful for testing.

= True display_logs: bool

Whether to render logs in a standalone window.

executable_path: Annotated[
    Path, Parameter(validator=Path(exists=True, file_okay=True, dir_okay=False, ext=()))
]

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

= None fps: int | None

Fixed FPS to use when running standalone, if None no fixed timestep is used

= False headless: bool

Flag indicating if the standalone Unreal Engine process should run in headless mode

make()

Create an UnrealExecutable simulator instance with the specified settings.

A configured UnrealExecutable simulator instance.

Return type: UnrealExecutable

= None map: str | None

Map to load when launching a standalone Unreal Engine process