bz givePlayerFlag

From BZFlagWiki
Jump to: navigation, search
BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.
BZFS API Function. This page documents a BZFS_API Function, that is provided by the BZFS game server for plug-ins to call.

Prototype[edit]

BZF_API bool bz_givePlayerFlag ( int playerID, const char* flagType, bool force );

Parameters[edit]

name type value desription
playerId int the player that is to get the flag.
flagType const char* The flag code of the flag to give to the player.
force bool replace the existing flag if it exists

Description[edit]

This API function will give the specified player the specified flag. If the player has no flag, they will get a flag. If they have a flag and the force parameter is true the new flag code will replace the old flag code. If the force parameter is false, and the player has a flag, no action will be taken.