Difference between revisions of "Bz pauseCountdown"

From BZFlagWiki
Jump to: navigation, search
m (Added new function with int param)
m (Fix spacing and make use of "removed" parameter)
 
(One intermediate revision by the same user not shown)
Line 9: Line 9:
 
| param1desc  = 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.
 
| param1desc  = 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.
 
}}
 
}}
 
 
{{apicall
 
{{apicall
 
| name          = bz_pauseCountdown
 
| name          = bz_pauseCountdown
 +
| deprecated  = 2.4.3
 +
| removed = 2.5.0
 
| returns      =  
 
| returns      =  
 
| returntype    = void
 
| returntype    = void
Line 19: Line 20:
 
| param1desc  = 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.
 
| param1desc  = 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===
 
===Example===
 
Pause the countdown if a player pauses, saying the player that paused decided to pause the countdown also.
 
Pause the countdown if a player pauses, saying the player that paused decided to pause the countdown also.

Latest revision as of 08:44, 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
Removed API Version: 2.5.0

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[edit]

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;