This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz getCountdownRemaining"
From BZFlagWiki
m (Allejo moved page Bz getCountdownProgress to Bz getCountdownRemaining: Renamed function) |
(Update return type and function name) |
||
Line 1: | Line 1: | ||
{{apicall | {{apicall | ||
− | | name = | + | | name = bz_getCountdownRemaining |
| returns = The amount of time remaining in a match in seconds, or <code>-1</code> if a match is not currently in progress. | | returns = The amount of time remaining in a match in seconds, or <code>-1</code> if a match is not currently in progress. | ||
− | | returntype = | + | | returntype = float |
| description = Retrieves the time remaining in a running countdown. | | description = Retrieves the time remaining in a running countdown. | ||
}} | }} | ||
Line 12: | Line 12: | ||
if (bz_isCountDownActive()) { | if (bz_isCountDownActive()) { | ||
bz_sendTextMessagef(BZ_SERVER, player, | bz_sendTextMessagef(BZ_SERVER, player, | ||
− | "Welcome! The current match will finish in % | + | "Welcome! The current match will finish in %.0f seconds!", bz_getCountdownRemaining()); |
} else { | } else { | ||
bz_sendTextMessage(BZ_SERVER, player, | bz_sendTextMessage(BZ_SERVER, player, |
Latest revision as of 21:10, 25 September 2015
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;