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

Difference between revisions of "Bz removePlayerFlag"

From BZFlagWiki
Jump to: navigation, search
(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 ...)
 
(rewording to not call a player "it", but "who")
 
Line 11: Line 11:
 
   |playerId  
 
   |playerId  
 
   |int  
 
   |int  
   |the player that is to have it's flag removed
+
   |the player whose flag is to be removed
 
   |}
 
   |}
  
 
==Description==
 
==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.
 
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.

Latest revision as of 03:02, 28 January 2013

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_removePlayerFlag ( int playerID );

Parameters[edit]

name type value description
playerId int the player whose flag is to be removed

Description[edit]

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.