bz getFlagPosition

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_getFlagPosition ( int flag, float* pos );

Parameters[edit]

name type value description
playerId int the flag to return
pos float [3] an array of floats to fill in with the position.

Description[edit]

This API function fill out the pos parameter with the position of the specified flag and return true. If the specified flag ID is invalid, the function will return false.