This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz givePlayerFlag"
From BZFlagWiki
(Clarify what flagType ACTUALLY returns.) |
|||
Line 15: | Line 15: | ||
|flagType | |flagType | ||
|const char* | |const char* | ||
− | |The flag code of the flag to give to the player | + | |The flag code of the flag to give to the player. |
− | + | ||
− | + | ||
|- | |- | ||
|force | |force |
Revision as of 05:56, 4 July 2011
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
BZF_API bool bz_givePlayerFlag ( int playerID, const char* flagType, bool force );
Parameters
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
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 paramater is false, and the player has a flag, no action will be taken.