BaseProtocol

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

schola.core.protocols.base.BaseProtocol

BaseProtocol

Bases: object

Base class for all communication protocols with Schola.

This abstract class defines the basic interface for communication protocols used to connect Python environments with simulations.

Item	Description
`__init__`()	—
close	Close the protocol connection.
get_definition	Get the environment definition from Unreal Engine.
send_startup_msg	Send the initial startup message to Unreal Engine.
start	Start the protocol connection.

Item	Description
properties	Get protocol-specific properties.

close()

Close the protocol connection.

This method should be safe to call multiple times.

None

get_definition(*args, **kwargs)

Get the environment definition from Unreal Engine.

*args : Variable length argument list.

**kwargs : Arbitrary keyword arguments.

The environment definition containing information about agents, observation spaces, and action spaces.

Return type: Any

properties: Dict[str, Any]

Get protocol-specific properties.

send_startup_msg(*args, **kwargs)

Send the initial startup message to Unreal Engine.

*args : Variable length argument list.

**kwargs : Arbitrary keyword arguments.

start()

Start the protocol connection.

Initializes and opens the connection to the Unreal Engine.

None