bz eMsgDebugEvent

From BZFlagWiki
Jump to: navigation, search
BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.

BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.


Overview[edit]

The bz_eMsgDebugEvent is an API event called every time packets are sent to the server.

Data[edit]

bz_eMsgDebugEvent returns the bz_MsgDebugEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eMsgDebugEvent
code char[2] A 2-byte message code to identify what the data is.
len size_t The size of the incoming message.
msg char* The actual message telling the server what the data contains, based on the code data.
receive bool Whether or not to receive the packets
playerID int The player that sent the data.
eventTime double The server time at which the event occurred (in seconds).

Uses[edit]

Used mostly by developers to watch for packet data. Not particularly useful for plugin developers.