|
|
| Line 1: |
Line 1: |
| {{apicall
| | #REDIRECT [[Category:BZFS API Docs]] |
| | name = bz_getPublicDescription
| |
| | returns = A string containing the public title / description of the server.
| |
| | returntype = [[bz_ApiString]]
| |
| | description = Retrieves the string with the title of the server, generally displayed on the list server when players are finding a game to join. This is what one would specify with the '''-publictitle''' BZFS option.
| |
| }}
| |
| | |
| ===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;
| |