gRPCProtocolArgs

Full path: schola.scripts.common.gRPCProtocolArgs

schola.scripts.common.gRPCProtocolArgs

gRPCProtocolArgs

gRPCProtocolArgs(port=None, url="localhost", environment_start_timeout=45)

Bases: object

Settings for the gRPC protocol in Schola.

Methods

Item	Description
init	—
make	Create a gRPCProtocol instance with the specified settings.

Attributes

Item	Description
environment_start_timeout	Timeout for waiting to see if the environment is ready before assuming it crashed, in seconds.
port	Port to connect to the Unreal Engine process, if None an open port will be automatically selected when running standalone.
url	URL to connect to the Unreal Engine process.

Parameters

port (int | None)

url (str)

environment_start_timeout (int | None)

init

__init__(port=None, url="localhost", environment_start_timeout=45)

Parameters

port (int | None)

url (str)

environment_start_timeout (int | None)

Returns

None

---

environment_start_timeout

= 45 environment_start_timeout: int | None

Timeout for waiting to see if the environment is ready before assuming it crashed, in seconds.

---

make

make()

Create a gRPCProtocol instance with the specified settings.

Returns

A configured gRPCProtocol instance for communication with Unreal Engine.

Return type: gRPCProtocol

---

port

= None port: int | None

Port to connect to the Unreal Engine process, if None an open port will be automatically selected when running standalone. Port is required if connecting to an existing Unreal Engine process.

---

url

= 'localhost' url: str

URL to connect to the Unreal Engine process.

---