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

Editing Koth

Jump to: navigation, search

Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.

The administrator who locked it offered this explanation: Archived wiki

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
The plugin will create a [[Game Modes#King of the Hill|King of the Hill]] game mode in which a team (or player) can occupy a defined volume ("Hill") for a defined amount of time and kill all other teams (or players) if occupied long enough.
+
The plugin will create a King of the Hill game mode in which a team (or player) can occupy a defined volume ("Hill") for a defined amount of time and kill all other teams (or players) if occupied long enough.
  
 
=Description=
 
=Description=
Line 19: Line 19:
  
 
* When Hill is initially occupied and when hill is taken, standard team audio alerts take place.
 
* When Hill is initially occupied and when hill is taken, standard team audio alerts take place.
 +
  
 
=Usage=
 
=Usage=
Line 28: Line 29:
  
 
The parameters of the King of the Hill (koth) map definition are follows:
 
The parameters of the King of the Hill (koth) map definition are follows:
{|{{Prettytable}}
+
 
|-
+
* '''bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>'''
| {{Hl3}} |'''Parameter'''
+
* '''cylinder <X> <Y> <Zmin> <Zmax> <radius>'''
| {{Hl3}} |'''Description'''
+
Required. These define the volume on the map to be occupied for the King of the Hill.
|-
+
 
| '''position <x> <y> <z>''' || Required. This determines the location of the "hill"
+
* '''teamplay'''
|-
+
 
| '''size <x> <y> <z>''' || Required for rectangular hills. This determines the size of the rectangular zone.
+
Optional.  This will enable the teamplay mode of King of the Hill (see above).  If not included, teamplay is disabled and it becomes as basic free for all King of the Hill mode.
|-
+
 
| '''rotation <degrees>''' || Optional. Only for rectangular zones, you can set the rotation as any other object.
+
* '''holdtime <seconds>'''
|-
+
 
| '''radius <radius>''' || Required for cylindrical hills. The radius of the cylindrical hill.
+
Optional.  This defines the time (in seconds) required to occupy the King of the Hill volume before a player is declared King of the Hill and other teams/players are zapped.  If not included, the default setting is 60 seconds (1 minute).  The limits of this setting are
|-
+
controlled to a minimum of 1 second and a maximum of 7200 seconds.
| '''height <units>''' || Required for cylindrical hills. The height of the hill; the z-axis.
+
 
|-
+
* '''autotime <multiplier> <minimum multiplier>'''
| '''teamplay''' || Optional.  This will enable the teamplay mode of King of the Hill (see above).  If not included, teamplay is disabled and it becomes as basic free for all King of the Hill mode.
+
 
|-
+
Optional.  This will enable the automatic time reduction feature of the plugin that will reduce the time to hold the hill, based on the number of players in the game (see description above). The multiplier field will set the hold time reduction percentage per new player.  The
| '''holdtime <seconds>''' || Optional.  This defines the time (in seconds) required to occupy the King of the Hill volume before a player is declared King of the Hill and other teams/players are zapped.  If not included, the default setting is 60 seconds (1 minute).  The limits of this setting are controlled to a minimum of 1 second and a maximum of 7200 seconds.
+
minimum multiplier field will set the minimum hold time reduction percentage. If these fields are left blank, the default multiplier = 3% and the default minimum multiplier = 50%.  The multiplier fields should be between 1 and 99 (percent).
|-
+
 
| '''autotime <multiplier> <minimum multiplier>''' || Optional.  This will enable the automatic time reduction feature of the plugin that will reduce the time to hold the hill, based on the number of players in the game (see description above). The multiplier field will set the hold time reduction percentage per new player.  The minimum multiplier field will set the minimum hold time reduction percentage. If these fields are left blank, the default multiplier = 3% and the default minimum multiplier = 50%.  The multiplier fields should be between 1 and 99 (percent).
+
* '''nosound'''
|-
+
 
| '''nosound''' || Optional.  This will disable sounds associated with Keep Away plugin (some clients seem to have issues with this feature).
+
Optional.  This will disable sounds associated with Keep Away plugin (some clients seem to have issues with this feature).
|}
+
 
  
 
=Examples=
 
=Examples=
Line 57: Line 58:
  
 
  koth
 
  koth
   position 0 0 25
+
   bbox -30 30 -30 30 10 40
  size 60 60 30
+
 
   teamplay
 
   teamplay
 
   holdtime 60
 
   holdtime 60
 
  end
 
  end
  
This would set up a King of the Hill volume 60 x 60 x 30, at position 0 0 25.  Teamplay would be enabled and the required time to occupy the "Hill" would be 60 seconds (1 minute).  Time to hold would not automatically adjust downward with new players.
+
This would set up a King of the Hill volume 60 x 60 x 30, centered at 0 0 25.  Teamplay would be enabled and the required time to occupy the "Hill" would be 60 seconds (1 minute).  Time to hold would not automatically adjust downward with new players.
  
 
  koth
 
  koth
   position 0 0 20
+
   cylinder 0 0 20 40 15
  height 20
+
  radius 15
+
 
   holdtime 100
 
   holdtime 100
 
   teamplay
 
   teamplay
Line 75: Line 73:
 
  end
 
  end
  
This would set up a King of the Hill cylindrical volume 30 x 30 x 20, at position 0 0 20.  Teamplay would be enabled and the required time to occupy the "Hill" would be 100 seconds.  The time to occupy the hill would adjust downward with an increasing number of players (see autotime description above).  Each new player after 2 will reduce the hold time by 5% to a minimum of 25% of the hold time (25 seconds).  The sounds associated with the plugin would be disabled.
+
This would set up a King of the Hill cylindrical volume 30 x 30 x 20, centered at 0 0 30.  Teamplay would be enabled and the required time to occupy the "Hill" would be 100 seconds.  The time to occupy the hill would adjust downward with an increasing number of players (see autotime description above).  Each new player after 2 will reduce the hold time by 5% to a minimum of 25% of the hold time (25 seconds).  The sounds associated with the plugin would be disabled.
 
    
 
    
The plugin must be loaded at startup or else the server it will not recognize these map parameters.
+
Obviously, the plugin must be loaded to the server at startup, or it will not recoginize these map parameters.
 +
 
  
 
=Server Commands=
 
=Server Commands=
Line 86: Line 85:
  
 
There are several administrator commands available with the plugin:
 
There are several administrator commands available with the plugin:
{|{{Prettytable}}
 
|-
 
| {{Hl3}} |'''Command'''
 
| {{Hl3}} |'''Description'''
 
|-
 
| /kothon || this will turn King of the Hill mode on, if turned off previously.
 
|-
 
| /kothoff || this will turn King of the Hill mode off for normal gameplay.
 
|-
 
| /kothtimemult || this will set auto time multiplier (per new player).
 
|-
 
| /kothtimemultmin || this will set minimum auto time multiplier.
 
|-
 
| /kothautotimeon || this will enable the autotime function.
 
|-
 
| /kothsoundon || this will enable the plugin's sounds.
 
|-
 
| /kothsoundoff || this will disable the plugin's sounds.
 
|-
 
| /kothautotimeoff || this will disable the autotime funtion.
 
|-
 
| /kothtime <seconds> || this will change King of the Hill hold time 1 -> 7200 seconds.
 
|-
 
| /kothstatus || this will return the status of the plugin modes, times, etc.
 
|}
 
 
=Deprecation=
 
 
* '''bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>'''
 
* '''cylinder <X> <Y> <Zmin> <Zmax> <radius>'''
 
  
Support for the '''bbox''' and '''cylinder''' parameters in a Koth zone has been deprecated and will be removed in the future.
+
/kothon            - this will turn King of the Hill mode on, if turned off previously.
 +
/kothoff            - this will turn King of the Hill mode off for normal gameplay.
 +
/kothtimemult      - this will set auto time multiplier (per new player).
 +
/kothtimemultmin    - this will set minimum auto time multiplier.
 +
/kothautotimeon    - this will enable the autotime function.
 +
/kothsoundon        - this will enable the plugin's sounds.
 +
/kothsoundoff      - this will disable the plugin's sounds.
 +
/kothautotimeoff    - this will disable the autotime funtion.
 +
/kothtime <seconds> - this will change King of the Hill hold time 1 -> 7200 seconds.
 +
/kothstatus        - this will return the status of the plugin modes, times, etc.
  
 
=External Links=
 
=External Links=

Please note that all contributions to BZFlagWiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BZFlagWiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://wiki.bzflag.org/Koth"