This wiki is archived and useful information is being migrated to the main bzflag.org website
bz moveFlag
From BZFlagWiki
Revision as of 03:48, 14 August 2007 by 71.109.219.226 (Talk) (New page: {{BZFS_API_Doc}} {{BZFS_API_Funcs}} ==Prototype== BZF_API bool bz_moveFlag( int flag, float pos[3], bool reset = true ); ==Parameters== {| border="1" cellpadding="20" cellspacing="0" !na...)
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. |
Contents
Prototype
BZF_API bool bz_moveFlag( int flag, float pos[3], bool reset = true );
Parameters
name | type | value description |
---|---|---|
flag | int | the flag to move |
pos | float [3] | the position to move the flag to. |
reset | bool | cause the flag to be "zaped" to the new location. |
Description
This API function moves the specified flag. If the flag is carried, it will be drooped. If reset is true, the flag is also "zapped" to the new location ( ring graphical effect).
Notes
Prior to BZFlag Version 2.1 this function did not have the reset paramater, and always behaved as if it was true.