Difference between revisions of "Bz eTickEvent"

From BZFlagWiki
Jump to: navigation, search
(Data)
(Data)
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
==Overview==
 
==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.
+
The '''bz_eTickevent''' is an API event that is called once for each [[BZFS]] main loop. The wait time between tick calls can vary greatly 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 17: Line 17:
 
   |bz_eTickEvent
 
   |bz_eTickEvent
 
   |-
 
   |-
   |time
+
   |eventTime
 
   |double
 
   |double
   |Local Server time of the event
+
   |Local Server time of the event (in seconds)
 
   |}
 
   |}

Latest revision as of 02:52, 6 April 2013

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_eTickevent is an API event that is called once for each BZFS main loop. The wait time between tick calls can vary greatly 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[edit]

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 (in seconds)