This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz moveFlag"
From BZFlagWiki
(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...) |
(→Description: typo) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
{{BZFS_API_Funcs}} | {{BZFS_API_Funcs}} | ||
==Prototype== | ==Prototype== | ||
| − | BZF_API bool bz_moveFlag( int flag, float pos[3] | + | BZF_API bool bz_moveFlag( int flag, float pos[3] ); |
==Parameters== | ==Parameters== | ||
{| border="1" cellpadding="20" cellspacing="0" | {| border="1" cellpadding="20" cellspacing="0" | ||
| Line 16: | Line 16: | ||
|float [3] | |float [3] | ||
|the position to move the flag to. | |the position to move the flag to. | ||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
==Description== | ==Description== | ||
| − | This API function moves the specified flag. If the flag is carried, it will be | + | 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 | + | 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. |
Contents
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.
