This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz getAdmin"
From BZFlagWiki
(Added return value. Updated description to reflect what the function checks for, not what it returns.) |
m (clarified what an administrator is) |
||
(One intermediate revision by one other user not shown) | |||
Line 3: | Line 3: | ||
| returns = true if player is an administrator, false otherwise. | | returns = true if player is an administrator, false otherwise. | ||
| returntype = bool | | returntype = bool | ||
− | | description = Checks to see if the specified player is an administrator. | + | | description = Checks to see if the specified player is an administrator (has the ability to ban). |
| param1 = playerID | | param1 = playerID | ||
| param1type = int | | param1type = int | ||
Line 10: | Line 10: | ||
| returns = True if the player specified is an administrator; false otherwise | | returns = True if the player specified is an administrator; false otherwise | ||
}} | }} | ||
+ | ===Example=== | ||
+ | Displays a custom message if the player joins and is identified as an administrator. | ||
+ | if (bz_getAdmin(((bz_PlayerJoinPartEventData_V1*)eventData)->playerID)) { | ||
+ | bz_sendTextMessage(BZ_SERVER,((bz_PlayerJoinPartEventData_V1*)eventData)->playerID,"Welcome! Do not forget to check up on admin news with /adminnews!"); | ||
+ | } |
Latest revision as of 21:06, 17 January 2013
bool bz_getAdmin (int playerID)
Checks to see if the specified player is an administrator (has the ability to ban).
Parameters:
playerID - The id of the player to check for admin status
Returns:
True if the player specified is an administrator; false otherwise
Example[edit]
Displays a custom message if the player joins and is identified as an administrator.
if (bz_getAdmin(((bz_PlayerJoinPartEventData_V1*)eventData)->playerID)) { bz_sendTextMessage(BZ_SERVER,((bz_PlayerJoinPartEventData_V1*)eventData)->playerID,"Welcome! Do not forget to check up on admin news with /adminnews!"); }