This wiki is archived and useful information is being migrated to the main bzflag.org website
bz eMsgDebugEvent
From BZFlagWiki
Revision as of 01:25, 23 December 2013 by Allejo (Talk | contribs) (added description to receive boolean)
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
The bz_eMsgDebugEvent is an API event called every time packets are sent to the server.
Data
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. |
time | double | The current server time |
Uses
Used mostly by developers to watch for packet data. Not particularly useful for plugin developers.