Bz pauseCountdown - Revision history

Allejo: Fix spacing and make use of "removed" parameter

2015-08-22T08:44:46Z

Fix spacing and make use of "removed" parameter

← Older revision		Revision as of 08:44, 22 August 2015
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		\| deprecated = 2.4.3
			\| removed = 2.5.0
	\| returns =		\| returns =
	\| returntype = void		\| returntype = void
Line 20:		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.

Allejo: Added deprecation version

2015-08-22T08:37:56Z

Added deprecation version

← Older revision		Revision as of 08:37, 22 August 2015
Line 12:		Line 12:
	{{apicall		{{apicall
	\| name = bz_pauseCountdown		\| name = bz_pauseCountdown
			\| deprecated = 2.4.3
	\| returns =		\| returns =
	\| returntype = void		\| returntype = void

Allejo: Added new function with int param

2015-08-22T08:34:24Z

Added new function with int param

← Older revision		Revision as of 08:34, 22 August 2015
Line 1:		Line 1:
			{{apicall
			\| name = bz_pauseCountdown
			\| version = 2.4.3
			\| returns =
			\| returntype = void
			\| description = Pauses the countdown that is currently running.
			\| param1 = playerID
			\| param1type = int
			\| 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
Line 11:		Line 22:
	===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.
	case bz_ePlayerPausedEvent:{		case bz_ePlayerPausedEvent:
	if (bz_isCountDownActive() && ((bz_PlayerPausedEventData_V1*)eventData)->pause) {		{
	bz_pauseCountdown(bz_getPlayerCallsign(((bz_PlayerPausedEventData_V1*)eventData)->playerID));		if (bz_isCountDownActive() && ((bz_PlayerPausedEventData_V1*)eventData)->pause) {
	}		bz_pauseCountdown(bz_getPlayerCallsign(((bz_PlayerPausedEventData_V1*)eventData)->playerID));
	}break;		}
			}
			break;

Sigonasr2: Create API Function Page. Include Example.

2011-10-19T09:34:52Z

Create API Function Page. Include Example.

New page

{{apicall
| name = bz_pauseCountdown
| returns =
| returntype = void
| description = Pauses the countdown that is currently running.
| param1 = pausedBy
| param1type = const char*
| 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===
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;