Skip to content

BaseProtocol

Full path: schola.core.protocols.base_protocol.BaseProtocol

Base class for all communication protocols with Schola.

BaseProtocol

Methods

close

close()

Close the protocol connection.

Returns

Return type: None


get_definition

get_definition(*args, **kwargs)

Get the environment definition from Unreal Engine.

Parameters

  • *args - Variable length argument list.

  • **kwargs - Arbitrary keyword arguments.


send_startup_msg

send_startup_msg(*args, **kwargs)

Send the initial startup message to Unreal Engine.

Parameters

  • *args - Variable length argument list.

  • **kwargs - Arbitrary keyword arguments.


start

start()

Start the protocol connection.

Returns

Return type: None

Attributes

properties

properties

Get protocol-specific properties.