bz removePlayerFlag

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_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.