UnrealExecutable

Full path: schola.core.simulators.unreal.executable.UnrealExecutable

schola.core.simulators.unreal.executable.UnrealExecutable

UnrealExecutable

UnrealExecutable(
    executable_path,
    headless_mode=False,
    map=None,
    display_logs=True,
    set_fps=None,
    disable_script=True,
)

Bases: BaseUnrealSimulator

A standalone client that launches an Unreal Engine instance when started.

Parameters

url (str) : The URL to connect to

ue_path (str) : The path to the Unreal Engine executable

headless_mode (bool) : Whether to run in headless mode

map (str, optional) : The map to load. Defaults to the default map in the Unreal Engine project

display_logs (bool, default=True) : Whether to display logs

set_fps (int, optional) : Use a fixed fps while running, if None, no fixed timestep is used

disable_script (bool, default=False) : Whether to disable the autolaunch script setting in the Unreal Engine Schola Plugin

executable_path (str | Path)

executable_path

executable_path

The path to the Unreal Engine executable

Type

• str

---

headless_mode

headless_mode

Whether to run in headless mode

Type

• bool, default=False

---

display_logs

display_logs

Whether to display logs

Type

• bool

---

set_fps

set_fps

Use a fixed fps while running, if None, no fixed timestep is used

Type

• int, optional

---

env_process

env_process

The process running the Unreal Engine. None if the process is not running

Type

• subprocess.Popen, optional

---

disable_script

disable_script

Whether to disable the autolaunch script setting in the Unreal Engine Schola Plugin

Type

• bool

---

map

map

The map to load. Defaults to the default map in the Unreal Engine project

Type

• str, optional

---

Methods

Item	Description
init	—
make_args	Make the arguments supplied to the Unreal Engine Executable.
start	Start the Unreal Engine process.
stop	Close the connection to the Unreal Engine.

Attributes

Item	Description
supported_protocols	Get the protocols supported by this simulator.

init

__init__(
    executable_path,
    headless_mode=False,
    map=None,
    display_logs=True,
    set_fps=None,
    disable_script=True,
)

Parameters

executable_path (str | Path)

headless_mode (bool)

map (str)

display_logs (bool)

set_fps (int | None)

disable_script (bool)

---

make_args

make_args()

Make the arguments supplied to the Unreal Engine Executable.

Returns

The arguments to be supplied to the Unreal Engine Executable

Return type: List[str]

---

start

start(protocol_properties)

Start the Unreal Engine process.

Raises

• Exception - If the subprocess is already running

Parameters

protocol_properties (Dict[str, Any])

Returns

None

---

stop

stop()

Close the connection to the Unreal Engine. Kills the Unreal Engine process if it is running.

Returns

None

---