Bz moveFlag

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.

Contents

[edit] Prototype

BZF_API bool bz_moveFlag( int flag, float pos[3], bool reset = true );

[edit] 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.

[edit] 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).

[edit] Notes

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

Personal tools