Event Reference

All events dispatched by AsyncRCONClient are documented here. To listen for one of the following events, use the add_listener() method or the listen() decorator.

on_raw_event(packet: ServerPacket)

Fired for every parsable packet received by the server.

Parameters:

packet (ServerPacket) – The packet that was received. This will be one of the three subclasses of ServerPacket.

on_login()

Fired after a successful login to the server.

on_command(response: str)

Fired after receiving any command response from the server. This should only be used for debugging purposes as the send_command() method already returns the server’s response.

Parameters:

response (str) – The response received by the server.

on_message(response: str)

Fired for messages sent by the server, e.g. player connections. More specific events such as on_admin_login() are dispatched from this event.

Parameters:

response (str) – The message that was sent by the server.

on_admin_login(admin_id: int, addr: str)

Fired when a RCON admin logs into the server. The first message received will be our client logging in.

Note

This event has no logout equivalent as the server does not send messages for admins logging out.

Parameters:

• admin_id (int) – The ID of the admin that logged into the server.

• addr (str) – The admin’s IP and port.

on_player_connect(player: Player)

Fired when a player connects to a server.

Note

The player’s guid will most likely be an empty string since the server sends the GUID in a separate message briefly afterwards. To wait for the GUID to be provided, see the on_player_guid() event.

Parameters:

player (Player) – The player that connected to the server.

on_player_guid(player: Player)

Fired when receiving the BattlEye GUID for a connecting player. The given player object will have the updated GUID.

Parameters:

player (Player) – The player whose GUID was updated.

on_player_verify_guid(player: Player)

Fired when the server has verified the BattlEye GUID for a connecting player.

Parameters:

player (Player) – The player whose GUID was verified.

on_player_disconnect(player: Player)

Fired when a player manually disconnects from the server.

The players list will no longer contain the player provided here.

This event does not fire when BattlEye kicks the player; for that, see the following event on_player_kick().

Parameters:

player (Player) – The player that disconnected.

on_player_kick(player: Player, reason: str)

Fired when BattlEye kicks a player either automatically (e.g. "Client not responding") or by an admin (i.e. "Admin Kick").

The players list will no longer contain the player provided here.

Parameters:

• player (Player) – The player that was kicked.

• reason (str) – The reason for the player being kicked.

on_admin_message(admin_id: int, channel: str, message: str)

Fired when an RCON admin sends a message.

If the channel is "Global", the on_admin_announcement() event is dispatched alongside this event.

If the channel starts with "To ", the on_admin_whisper() event is also dispatched.

Parameters:

• admin_id (int) – The ID of the admin that sent the message.

• channel (str) – The name of the channel the message was sent to.

• message (str) – The message that was sent by the admin.

on_admin_announcement(admin_id: int, message: str)

Fired when an RCON admin sends a global message.

Parameters:

• admin_id (int) – The ID of the admin that sent the message.

• message (str) – The message that was sent by the admin.

on_admin_whisper(player: Player, admin_id: int, message: str)

Fired when an RCON admin sends a message to a specific player.

Note

This event may potentially not get dispatched if the player’s name could not be found in the client’s cache.

Parameters:

• player (Player) – The player that the message was directed towards.

• admin_id (int) – The ID of the admin that sent the message.

• message (str) – The message that was sent by the admin.

on_player_message(player: Player, channel: str, message: str)

Fired when a player sends a message.

Parameters:

• player (Player) – The player that the message was directed towards.

• channel (str) – The name of the channel the message was sent to.

• message (str) – The message that was sent by the admin.