Sigonasr2: Create API Function Page. Include Example.

2011-10-19T09:43:37Z

Create API Function Page. Include Example.

New page

{{apicall
| name = bz_startCountdown
| returns =
| returntype = void
| description = Begins the starting countdown process as if a player were to type '''/countdown'''.
| param1 = delay
| param1type = int
| param1desc = How many seconds to countdown before the real countdown timer for the match starts.
| param2 = limit
| param2type = float
| param2desc = How many seconds to set the countdown timer to? (Basically, setting the match length.)
| param3 = byWho
| param3type = const char*
| param3desc = The name of the player starting the countdown. Note that the name displayed does not have to be a player in the server, it can be any string.
}}

===Example===
Once 4 players have joined, the countdown will automatically begin by SERVER using the default time limit set by the server with a 10 second starting delay.
case bz_ePlayerJoinEvent: {
if (bz_getTeamCount(eBlueTeam)+
bz_getTeamCount(eRedTeam)+
bz_getTeamCount(eRogueTeam)+
bz_getTeamCount(eGreenTeam)+
bz_getTeamCount(ePurpleTeam)>=4 &&
(!bz_isCountDownActive() || !bz_isCountDownInProgress)) {
bz_sendTextMessage(BZ_SERVER,BZ_ALLUSERS,"Enough players have joined, starting countdown.");
bz_startCountdown(10,bz_getTimeLimit(),"SERVER");
}
}break;

Bz startCountdown - Revision history

Sigonasr2: Create API Function Page. Include Example.