function setPlayerName

Note

The name string can't be longer than 18 characters, and must be unique for each player.

This function will set the player unique nickname for all players.
Original: setPlayerName

Declaration

async def setPlayerName(id : int, name : str)

Parameters

int id: the player id.
str instance: the new unique player name.

Returns

bool: true when unique player name was set, otherwise false.

Source code in src/pyg2o/functions/player.py

async def setPlayerName(id : int, name : str) -> bool:
    """
    !!! note
        The name string can't be longer than 18 characters, and must be unique for each player.
    This function will set the player unique nickname for all players.
    Original: [setPlayerName](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/player/setPlayerName/)

    ## Declaration
    ```python
    async def setPlayerName(id : int, name : str)
    ```
    ## Parameters
    `int` **id**: the player id.
    `str` **instance**: the new unique player name.
    ## Returns
    `bool`: `true` when unique player name was set, otherwise `false`.
    """
    data = f'return {get_call_repr()}'

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