bz getPlayerFlagID

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

Parameters[edit]

name type value description
playerID int the player ID to of whom to get the flag ID for

Description[edit]

This API function returns the flag ID for the flag a player is carrying. If the player does not exist or does not have a flag, it will return -1.