bz getFlagPosition

From BZFlagWiki
Revision as of 03:43, 14 August 2007 by 71.109.219.226 (Talk) (New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_getFlagPosition ( int flag, float* pos ); ==Parameters== {| border="1" cellpadding="20" cellspacing="0" !name !type ...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

BZF_API bool bz_getFlagPosition ( int flag, float* pos );

Parameters

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

Description

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.