This wiki is archived and useful information is being migrated to the main bzflag.org website

bz givePlayerFlag

From BZFlagWiki
Revision as of 03:35, 14 August 2007 by 71.109.219.226 (Talk) (New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_givePlayerFlag ( int playerID, const char* flagType, bool force ); ==Parameters== {| border="1" cellpadding="20" cellspaci...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

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.