Skip to content

schola.core.unreal_connections.StandaloneUnrealConnection

class schola.core.unreal_connections.StandaloneUnrealConnection(url, executable_path, headless_mode, port=None, map=None, display_logs=True, set_fps=None, disable_script=False) : Bases: UnrealConnection

A standalone connection 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
  • port (int, optional) – The port to connect to, if None, an open port will be found
  • 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)

executable_path : The path to the Unreal Engine executable

Type: : str

headless_mode : Whether to run in headless mode

Type: : bool

display_logs : Whether to display logs

Type: : bool

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

Type: : int

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

Type: : subprocess.Popen, optional

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

Type: : bool

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

Type: : str

tcp_socket : A socket object bound to the open port. None if the port is supplied, and we don’t need to open a new port

Type: : socket.socket, optional

Methods

__init__(url, executable_path, headless_mode)
close()Close the connection to the Unreal Engine.
connect_stubs(*stubs)Connects the gRPC stubs to the Unreal Engine channel
get_open_port(url)Get an open port on the given URL
make_args()Make the arguments supplied to the Unreal Engine Executable.
start()Start the Unreal Engine process.

Attributes

addressReturns the address of the connection
is_activeReturns whether the connection is active or not

__init__(url, executable_path, headless_mode, port=None, map=None, display_logs=True, set_fps=None, disable_script=False) : Parameters: : - url (str)

  • executable_path (str)
  • headless_mode (bool)
  • port (int | None)
  • map (str | None)
  • display_logs (bool)
  • set_fps (int | None)
  • disable_script (bool)

close() : Close the connection to the Unreal Engine. Kills the Unreal Engine process if it is running.

Return type: : None

property is_active*: bool* : Returns whether the connection is active or not

Returns: : Whether the connection is active or not

Return type: : bool

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 the Unreal Engine process.

Raises: : Exception – If the subprocess is already running

Return type: : None