Difference between revisions of "Bz eTickEvent"

From BZFlagWiki
Jump to: navigation, search
(New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eTickevent''' is an API event that is called each time a tick has occurred . ==Data== '''bz_eTickEvent''' returns the '''bz_Ti...)
 
Line 3: Line 3:
  
 
==Overview==
 
==Overview==
The '''bz_eTickevent''' is an API event that is called each time a tick has occurred .
+
The '''bz_eTickevent''' is an API event that is called once for each [[BZFS]] main loop. The wait time between tick calls can vary grealy depending on server load network conditions. Plug-ins that wish to enforce a maximum wait time between ticks should call [[bz_setMaxWaitTime]] with the longest wait time that is acceptable.
  
 
==Data==
 
==Data==
Line 19: Line 19:
 
   |eventTime
 
   |eventTime
 
   |double
 
   |double
   |Time of the event
+
   |Local Server time of the event
 
   |}
 
   |}
 
==Uses==
 
This event is a notification only event, none of the data returned can be changed.
 
 
[[Category:BZFS_API_Docs]]
 
[[Category:BZFS_API_Events]]
 

Revision as of 20:57, 30 November 2007

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_eTickevent is an API event that is called once for each BZFS main loop. The wait time between tick calls can vary grealy depending on server load network conditions. Plug-ins that wish to enforce a maximum wait time between ticks should call bz_setMaxWaitTime with the longest wait time that is acceptable.

Data

bz_eTickEvent returns the bz_TickEventData_V1 data class.

name type value description
eventType bz_eEventType bz_eTickEvent
eventTime double Local Server time of the event