Sigonasr2: Meh, forgot to update the description.

2011-10-19T10:43:30Z

Meh, forgot to update the description.

← Older revision		Revision as of 10:43, 19 October 2011
Line 3:		Line 3:
	\| returns = A string containing the public address of the server.		\| returns = A string containing the public address of the server.
	\| returntype = [[bz_ApiString]]		\| returntype = [[bz_ApiString]]
	\| description = ~~Pauses~~ the ~~countdown~~ that is ~~currently running~~.		\| description = Returns the string that was specified with the BZFS option '''-publicaddr''' or the default address that is used when starting up a public server.
	}}		}}

Sigonasr2: Create API Function Page. Include Example.

2011-10-19T10:41:59Z

Create API Function Page. Include Example.

New page

{{apicall
| name = bz_getPublicAddr
| returns = A string containing the public address of the server.
| returntype = [[bz_ApiString]]
| description = Pauses the countdown that is currently running.
}}

===Example===
A simple greeting that tells the player what server and port they are on. This may be useful to remove the hassle of modifying greetings for a server that hosts many ports.
case bz_ePlayerJoinEvent: {
if (bz_getPublic()) {
bz_sendTextMessagef(BZ_SERVER,((bz_PlayerJoinPartEventData_V1*)eventData)->playerID,"Welcome!");
bz_sendTextMessagef(BZ_SERVER,((bz_PlayerJoinPartEventData_V1*)eventData)->playerID,
"You are playing on %s",bz_getPublicDescription().c_str());
bz_sendTextMessagef(BZ_SERVER,((bz_PlayerJoinPartEventData_V1*)eventData)->playerID,
" @ %s:%d",bz_getPublicAddr().c_str(),bz_getPublicPort());
}
}break;

Bz getPublicAddr - Revision history

Sigonasr2: Meh, forgot to update the description.

Sigonasr2: Create API Function Page. Include Example.