This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz eLoggingEvent"

From BZFlagWiki
Jump to: navigation, search
(Created Documentation for this API Event.)
 
(Uses: Linked BZFS_Command_Line_Options page.)
 
Line 31: Line 31:
  
 
==Uses==
 
==Uses==
If for some reason you do not want to enable the debug options in BZFS or want to watch debug within the game, you could use this event.
+
If for some reason you do not want to enable the [[BZFS_Command_Line_Options|debug options in BZFS]] or want to watch debug within the game, you could use this event.
  
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Events]]
 
[[Category:BZFS_API_Events]]

Latest revision as of 18:20, 15 October 2011

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_eLoggingEvent is an API event called whenever a debug message is outputted. These can normally be seen with the -d verbose options.

Data[edit]

bz_eLoggingEvent returns the bz_LoggingEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eLoggingEvent
level int The debug level that this debug message is being triggered at. -d corresponds to level 1, -dd to level 2, etc.
message bz_ApiString The debug message that is being outputted.
eventTime double The server time the event occurred (in seconds.)

Uses[edit]

If for some reason you do not want to enable the debug options in BZFS or want to watch debug within the game, you could use this event.