This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Teamflagreset"

From BZFlagWiki
Jump to: navigation, search
(New page: ==Description== The teamflagreset plugin will look at the team flags and see if they have been held by a player and dropped - if so, it will start timing to a limit. If the flag is not p...)
 
Line 1: Line 1:
 +
{{DoDoc|cleanup the article according to the standards, and other plug-in articles}}
 +
 
==Description==
 
==Description==
  

Revision as of 02:01, 27 August 2007

Plywood hammer100x101.gif There is still documentation to be done here!! If you feel up to the task, please have a go at it. Specifically what needs to be added is:
cleanup the article according to the standards, and other plug-in articles


Description

The teamflagreset plugin will look at the team flags and see if they have been held by a player and dropped - if so, it will start timing to a limit. If the flag is not picked up again within that time limit the team flag will reset with a message saying which team flag sat idle too long. It will also automatically disable itself for teams with no players and for only 1 team in the match (no opposing teams).


Usage

The plugin will allow the time limit to be passed to it through the -loadplugin command line with bzfs. The format is as follows:

"-loadplugin <path>teamflagreset,m" where m is the timer value (in minutes) for timed ctf. For example, "-loadplugin plugins/teamflagreset,2" would start the plugin with the timer set for 2 minutes. The minimum is 1 minute and the maximum is 120 minutes. If no time is specified, the plugin defaults to 5 minutes.


Server Commands

There are 5 administrator commands available with the plugin:

"tfrtime <iii>" this will set timer interval for checking idle flags to <iii> minutes (1-120).
"tfroff" this will disable the timer.
"tfron" this will enable the timer.
"tfrstatus" this will return the status of the timer (enabled or disabled and time interval).