OnlinePlayers

class corkus.objects.OnlinePlayers

List all running servers and players that are online on them.

property servers

List all running servers.

Return type:

List[Server]

property players

List all online players.

Return type:

List[PartialOnlinePlayer]

property regular_players

List all online players that are playing on regular servers.

Return type:

List[PartialOnlinePlayer]

get_player_server(player)

Get the server that player is currently playing on. Returns None if player is offline.

Parameters:

player (Union[str, Player, PartialPlayer, PartialOnlinePlayer, Member]) – Player username or player object to check for.

Return type:

Optional[Server]

is_player_online(player)

Check if player is online.

Parameters:

player (Union[str, Player, PartialPlayer, PartialOnlinePlayer, Member]) – Player username or player object to check for.

Return type:

bool