Skip to content

function getServerDescription

This function will get the description of the server.
Original: getServerDescription

Declaration

async def getServerDescription() -> str

Returns

str: Server description.

Source code in src/pyg2o/functions/game.py
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
async def getServerDescription() -> str:
    """
    This function will get the description of the server.
    Original: [getServerDescription](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/getServerDescription/)

    ## Declaration
    ```python
    async def getServerDescription() -> str
    ```
    ## Returns
    `str`: Server description.
    """
    data = f'return {get_call_repr()}'

    server = await PythonWebsocketServer.get_server()
    result = await server.make_request(data)
    return result