bz_isTimeManualStart

From BZFlagWiki
Revision as of 09:18, 19 October 2011 by Sigonasr2 (Talk | contribs) (Create API Function Page. Include Example.)

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

bool bz_isTimeManualStart ()


Retrieves whether or not the time limit has to be started via a player issuing the /countdown command. The -timemanual BZFS option would make this return value true.

Returns:
True if the time limit requires manual startup or false if it is automatically running from the start.


Example[edit]

If a player joins and the timer requires manual starting, tell the user that.

case bz_ePlayerJoinEvent: {
	if (bz_isTimeManualStart()) {
	bz_sendTextMessage(BZ_SERVER,((bz_PlayerJoinPartEventData_V1*)eventData)->playerID,
		"Welcome! You can start the timer with /countdown at any time.");}
}break;