This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

Bz pauseCountdown: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
Allejo (talk | contribs)
m Added new function with int param
Allejo (talk | contribs)
Added deprecation version
Line 12: Line 12:
{{apicall
{{apicall
| name          = bz_pauseCountdown
| name          = bz_pauseCountdown
| deprecated  = 2.4.3
| returns      =  
| returns      =  
| returntype    = void
| returntype    = void

Revision as of 08:37, 22 August 2015

void bz_pauseCountdown (int playerID)


Minimum API Version: 2.4.3
Pauses the countdown that is currently running.

Parameters:
playerID  -  The id of the player stopping the countdown. Note that this value does not have to be a callsign of a player in the server, it can be any string.


void bz_pauseCountdown (const char* pausedBy)

Deprecated API Version: 2.4.3


Pauses the countdown that is currently running.

Parameters:
pausedBy  -  The name of the player stopping the countdown. Note that this value does not have to be a callsign of a player in the server, it can be any string.


Example

Pause the countdown if a player pauses, saying the player that paused decided to pause the countdown also.

case bz_ePlayerPausedEvent:
{
   if (bz_isCountDownActive() && ((bz_PlayerPausedEventData_V1*)eventData)->pause) {
       bz_pauseCountdown(bz_getPlayerCallsign(((bz_PlayerPausedEventData_V1*)eventData)->playerID));
   }
}
break;