Difference between revisions of "Bz flagPlayer"

From BZFlagWiki
Jump to: navigation, search
(Undo revision 3331 by 218.58.136.4 (Talk))
m (grammar)
 
Line 15: Line 15:
  
 
==Description==
 
==Description==
This API function return the playerID of the player that is carrying the specified flag. If the flag is on the ground, it will return -1
+
This API function returns the ID of the player that is carrying the specified flag. If the flag is on the ground, it will return -1.

Latest revision as of 08:44, 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[edit]

BZF_API int bz_flagPlayer ( int flag );

Parameters[edit]

name type value description
flag int the flag ID to search for

Description[edit]

This API function returns the ID of the player that is carrying the specified flag. If the flag is on the ground, it will return -1.