Skip to content

schola.core.unreal_connections.UnrealEditorConnection

Class Definition

class schola.core.unreal_connections.UnrealEditorConnection(url, port)

Bases: UnrealConnection

A connection to a running Unreal Editor instance.

Raises: AssertionError – If the port is not supplied

Parameters

url

Type: str
The URL to connect to.

port

Type: int
The port on that URL to connect to.

Properties

address

Returns the address of the connection.

is_active

Returns whether the connection is active or not.

Methods

__init__

__init__(url, port)

Parameters:

  • url (str)
  • port (int)

close

close()

Close the Unreal Connection.

connect_stubs

connect_stubs(*stubs)

Connects the gRPC stubs to the Unreal Engine channel.

get_open_port

get_open_port(url)

Get an open port on the given URL.

start

start()

Open the Connection to Unreal Engine.