This wiki was in read-only mode for many years, but can now be edited again. A lot of information will need to be updated.

Bz getPlayerFlagID: Difference between revisions

From BZFlagWiki
Jump to navigation Jump to search
Allejo (talk | contribs)
Create documentation for bz_getPlayerFlagID()
 
(No difference)

Latest revision as of 08:43, 8 January 2014

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

Parameters

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

Description

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.