bz_eTickEvent

This event is called once for each BZFS main loop. The main loop does not run at a consistent interval so do not assume the time between ticks. The time between ticks can be up to three seconds but can also be a short as possible (meaning, no delay other than the processing time of other code).

The typical way this event is used involves tracking the last eventTime that some action was triggered and waiting until a specified amount of time has elapsed before triggering that same action. Avoid triggering an action on every tick as this will have an adverse effect on performance.

Data Object Type

2.4.0 bz_TickEventData_V1

Parameters

These are the values accessible in the bz_EventData variable that's made available in the Event method.

Data Type	Name	Description
double	eventTime	Local Server time of the event (in seconds)

Plug-in Usage

Here's a list of plug-ins part of the official distribution that makes use of this event:

• autoFlagReset
• bzfscron
• fairCTF
• nagware
• rabbitTimer
• rabidRabbit
• serverControl
• serverSidePlayerSample
• teamflagreset
• timedctf
• wwzones

Plug-in Example

This block of code can be used to get started when implementing the Event() function of your plug-in.

bz_TickEventData_V1* dataObject = (bz_TickEventData_V1*)eventData;

// Data
// ---
// (double)       eventTime - Local Server time of the event (in seconds)

Other Other Events

• bz_eListServerUpdateEvent
• bz_eNewNonPlayerConnection

Back to bzfs API Events