Skip to Content

bz_eGamePauseEvent

This event is triggered when a timed game is paused

Data Object Type

2.4.4 bz_GamePauseResumeEventData_V2

Deprecated Types

These data object types have been deprecated in favor of more recent versions, which contain more or corrected information.

  • 2.4.4 bz_GamePauseResumeEventData_V1

Parameters

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

Data Type Name Description
bz_ApiString actionBy

The callsign of whoever triggered the event. By default, it's "SERVER".

int playerID

The ID of the player who triggered this action. By default, it's 253. (available since V2 of the event)

double eventTime

The server time the event occurred (in seconds).

Plug-in Usage

There are no plug-ins in the official distribution that make use of this event. Browse the Plug-in Releases forum for plug-ins which may make use of this event.

Plug-in Example

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

bz_GamePauseResumeEventData_V2* dataObject = (bz_GamePauseResumeEventData_V2*)eventData;

// Data
// ---
// (bz_ApiString) actionBy - The callsign of whoever triggered the event. By default, it's "SERVER".
// (int)          playerID - The ID of the player who triggered this action. By default, it's 253.
// (double)       eventTime - The server time the event occurred (in seconds).

Other Countdown Timer Events

Back to bzfs API Events

This content is maintained on GitHub. We welcome any feedback and improvements!

Give us Feedback Edit this Page