This wiki is archived and useful information is being migrated to the main bzflag.org website
bz removePlayerFlag
From BZFlagWiki
Revision as of 03:50, 14 August 2007 by 71.109.219.226 (Talk) (New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_removePlayerFlag ( int playerID ); ==Parameters== {| border="1" cellpadding="20" cellspacing="0" !name !type !value ...)
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_removePlayerFlag ( int playerID );
Parameters
name | type | value description |
---|---|---|
playerId | int | the player that is to have it's flag removed |
Description
This API function forces the specified player to drop the flag that is currently carried. The flag will be reset following the standard flag spawn logic.