This wiki is archived and useful information is being migrated to the main bzflag.org website

bz_getCountdownRemaining

From BZFlagWiki
Revision as of 21:10, 25 September 2015 by Allejo (Talk | contribs) (Update return type and function name)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

float bz_getCountdownRemaining ()


Retrieves the time remaining in a running countdown.

Returns:
The amount of time remaining in a match in seconds, or -1 if a match is not currently in progress.


Example[edit]

Display the remaining time to a user upon joining.

case bz_ePlayerJoinEvent: {
	int player = (bz_PlayerJoinPartEventData_V1*)eventData)->playerID;
	if (bz_isCountDownActive()) {
	 	bz_sendTextMessagef(BZ_SERVER, player,
	 		"Welcome! The current match will finish in %.0f seconds!", bz_getCountdownRemaining());
	} else {
	 	bz_sendTextMessage(BZ_SERVER, player,
	 		"Welcome! No match is currently running.");
	}
}break;