Classes

class GpgNetClientProtocol

Expand source code

class GpgNetClientProtocol(metaclass=ABCMeta):
    def send_GameState(self, arguments: list[Union[int, str, bool]]) -> None:
        """
        Sent by the client when the state of LobbyComm changes
        """
        self.send_gpgnet_message("GameState", arguments)

    @abstractmethod
    def send_gpgnet_message(self, command_id, arguments: list[Union[int, str, bool]]) -> None:
        pass  # pragma: no cover

Methods

def send_GameState(self, arguments: list[int | str | bool]) ‑> None

Expand source code

def send_GameState(self, arguments: list[Union[int, str, bool]]) -> None:
    """
    Sent by the client when the state of LobbyComm changes
    """
    self.send_gpgnet_message("GameState", arguments)

Sent by the client when the state of LobbyComm changes

def send_gpgnet_message(self, command_id, arguments: list[int | str | bool]) ‑> None

Expand source code

@abstractmethod
def send_gpgnet_message(self, command_id, arguments: list[Union[int, str, bool]]) -> None:
    pass  # pragma: no cover

class GpgNetServerProtocol

Expand source code

class GpgNetServerProtocol(metaclass=ABCMeta):
    """
    Defines an interface for the server side GPGNet protocol
    """
    async def send_ConnectToPeer(self, player_name: str, player_uid: int, offer: bool):
        """
        Tells a client that has a listening LobbyComm instance to connect to the
        given peer

        # Params
        - `player_name`: Remote player name
        - `player_uid`: Remote player identifier
        """
        await self.send_gpgnet_message("ConnectToPeer", [player_name, player_uid, offer])

    async def send_JoinGame(self, remote_player_name: str, remote_player_uid: int):
        """
        Tells the game to join the given peer by ID
        """
        await self.send_gpgnet_message("JoinGame", [remote_player_name, remote_player_uid])

    async def send_HostGame(self, map_path: str):
        """
        Tells the game to start listening for incoming connections as a host

        # Params
        - `map_path`: Which scenario to use
        """
        await self.send_gpgnet_message("HostGame", [str(map_path)])

    async def send_DisconnectFromPeer(self, id: int):
        """
        Instructs the game to disconnect from the peer given by id
        """
        await self.send_gpgnet_message("DisconnectFromPeer", [id])

    async def send_gpgnet_message(self, command_id: str, arguments: list[Union[int, str, bool]]):
        message = {"command": command_id, "args": arguments}
        await self.send(message)

    @abstractmethod
    async def send(self, message):
        pass  # pragma: no cover

Defines an interface for the server side GPGNet protocol

Subclasses

• GameConnection

Methods

async def send(self, message)

Expand source code

@abstractmethod
async def send(self, message):
    pass  # pragma: no cover

async def send_ConnectToPeer(self, player_name: str, player_uid: int, offer: bool)

Expand source code

async def send_ConnectToPeer(self, player_name: str, player_uid: int, offer: bool):
    """
    Tells a client that has a listening LobbyComm instance to connect to the
    given peer

    # Params
    - `player_name`: Remote player name
    - `player_uid`: Remote player identifier
    """
    await self.send_gpgnet_message("ConnectToPeer", [player_name, player_uid, offer])

Tells a client that has a listening LobbyComm instance to connect to the given peer

Params

• player_name: Remote player name
• player_uid: Remote player identifier

async def send_DisconnectFromPeer(self, id: int)

Expand source code

async def send_DisconnectFromPeer(self, id: int):
    """
    Instructs the game to disconnect from the peer given by id
    """
    await self.send_gpgnet_message("DisconnectFromPeer", [id])

Instructs the game to disconnect from the peer given by id

async def send_HostGame(self, map_path: str)

Expand source code

async def send_HostGame(self, map_path: str):
    """
    Tells the game to start listening for incoming connections as a host

    # Params
    - `map_path`: Which scenario to use
    """
    await self.send_gpgnet_message("HostGame", [str(map_path)])

Tells the game to start listening for incoming connections as a host

Params

• map_path: Which scenario to use

async def send_JoinGame(self, remote_player_name: str, remote_player_uid: int)

Expand source code

async def send_JoinGame(self, remote_player_name: str, remote_player_uid: int):
    """
    Tells the game to join the given peer by ID
    """
    await self.send_gpgnet_message("JoinGame", [remote_player_name, remote_player_uid])

Tells the game to join the given peer by ID

async def send_gpgnet_message(self, command_id: str, arguments: list[int | str | bool])

Expand source code

async def send_gpgnet_message(self, command_id: str, arguments: list[Union[int, str, bool]]):
    message = {"command": command_id, "args": arguments}
    await self.send(message)