Skip to content

function getPlayersCount

This function will get the max number of slots available on the server.
Original: getPlayersCount

Declaration

async def getPlayersCount() -> int

Returns

int: Number of players on the server.

Usage

import g2o

@g2o.event('onInit')
def evtInit(**kwargs):
    print('Players online:', g2o.getPlayersCount())
Source code in src/pyg2o/functions/game.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
async def getPlayersCount() -> int:
    """
    This function will get the max number of slots available on the server.
    Original: [getPlayersCount](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/game/getPlayersCount/)

    ## Declaration
    ```python
    async def getPlayersCount() -> int
    ```
    ## Returns
    `int`: Number of players on the server.

    ## Usage
    ```python
    import g2o

    @g2o.event('onInit')
    def evtInit(**kwargs):
        print('Players online:', g2o.getPlayersCount())
    ```
    """
    data = f'return {get_call_repr()}'

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