Difference between revisions of "Bz moveFlag"

From BZFlagWiki
Jump to: navigation, search
m (Removed reset argument from bz_moveFlag())
(Description: typo)
 
Line 19: Line 19:
  
 
==Description==
 
==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).  
+
This API function moves the specified flag. If the flag is carried, it will be dropped. If reset is true, the flag is also "zapped" to the new location ( ring graphical effect).
  
 
==Notes==
 
==Notes==
 
Prior to BZFlag Version 3.0 this function did not have the '''reset''' paramater, and always behaved as if it was true.
 
Prior to BZFlag Version 3.0 this function did not have the '''reset''' paramater, and always behaved as if it was true.

Latest revision as of 23:27, 25 November 2016

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_moveFlag( int flag, float pos[3] );

Parameters[edit]

name type value description
flag int the flag to move
pos float [3] the position to move the flag to.

Description[edit]

This API function moves the specified flag. If the flag is carried, it will be dropped. If reset is true, the flag is also "zapped" to the new location ( ring graphical effect).

Notes[edit]

Prior to BZFlag Version 3.0 this function did not have the reset paramater, and always behaved as if it was true.