BZDB Variables
BZFlag Database Variables (BZDB variables) are a way to configure the behavior tanks experience on a given map, whether it's the tank speed, the shot speed, the amount of gravity, and even the sky color!
Agility Flag
-
_agilityAdVel since 2.4.0
float • default:
2.25The
_tankSpeedmultiplier used for acceleration speed for tanks holding the Agility flag. -
_agilityTimeWindow since 2.4.0
float • default:
1.0The amount of time (in seconds) that the
_agilityAdVelspeed will remain in effect after acceleration for tanks holding the Agility flag. -
_agilityVelDelta since 2.4.0
float • default:
0.3The duration of time (in seconds) that a tank holding the Agility flag will accelerate from stationary to
_agilityAdVel.
Burrow Flag
-
_burrowAngularAd since 2.4.0
float • default:
0.55The
_tankAngVelmultiplier for how fast tanks can turn while burrowed with the Burrow flag. -
_burrowDepth since 2.4.0
float • default:
-1.32The Z-axis height in World Units (wu) of how far underground a burrowed tank will be.
-
_burrowSpeedAd since 2.4.0
float • default:
0.80Thw
_tankSpeedmultiplier for a tank's speed while burrowed with the Burrow flag.
Collisions
-
_coldetDepth since 2.4.0
int • default:
6 -
_coldetElements since 2.4.0
int • default:
4
Flag Settings
-
_flagAltitude since 2.4.0
float • default:
11.0The visual Z-axis height in World Units (wu), relative to a tank's position, that flags will fly up relative to its first clearance when dropped and the height at which flags will spawn (and subsequently fall).
-
_flagEffectTime since 2.4.0
float • default:
0.64The amount of time (in seconds) for a flag to go into effect after being grabbed. Additionally, this value is used as the duration between a tank spawning at its miniature size to its full size.
-
_flagHeight since 2.4.0
float • default:
10.0The Z-axis height in World Units (wu), relative to a tank's position, that a flag will be able to fly upwards before looking for a new clearance.
-
_flagPoleSize since 2.4.0
float • default:
0.8The height of flag poles in World Units (wu).
-
_flagPoleWidth since 2.4.0
float • default:
0.025The diameter in World Units (wu) of the flag's pole.
-
_flagRadius since 2.4.0
float • default:
2.5The radius distance in World Units (wu) a tank must be from a flag to pick it up.
-
_forbidMarkers since 2.4.0
boolean • default:
0A true boolean value will remove the large flag markers that indicate the location of your team flag(s).
-
_hideFlagsOnRadar since 2.4.0
boolean • default:
0A boolean value to hide super flags on the radar; this setting does not affect team flags.
-
_hideTeamFlagsOnRadar since 2.4.0
boolean • default:
0A boolean value to hide team flags on the radar; this setting does not affect super flags.
-
_maxFlagGrabs since 2.4.0
integer • default:
4.0When a flag spawns, it is assigned a random number between 1 and
_maxFlagGrabsknown as "grab count." Each time a flag is grabbed, the grab count for the flag is reduced by one until it reaches zero. When zero is reached, the flag will respawn after it is dropped. -
_pauseDropTime since 2.4.0
integer • default:
15.0The amount of time in seconds a player must be paused before they automatically drop the flag they are carrying.
Gameplay
-
_explodeTime since 2.4.0
float • default:
5.0The amount of time (in seconds) a player is unable to spawn after getting killed.
-
_forbidHunting since 2.4.0
boolean • default:
0A true boolean value will prevent players from hunting each other.
-
_radarLimit since 2.4.0
float • default:
_worldSizeThe maximum width in World Units (wu) of the map that can be displayed on the radar when it's not rotated.
Guided Missile Flag
-
_gmActivationTime since 2.4.0
float • default:
0.5The amount of time (in seconds) it takes for a Guided Missile to become active after it is fired. Any contact under this time will not result in detonation; setting it too low could cause its owner to run into their own GM and be blown up!
-
_gmAdLife since 2.4.0
float • default:
0.95The
_shotRangemultiplier that determines the distance guided missiles will go. -
_gmSize since 2.4.0
float • default:
1.5The size in World Units (wu) of the Guided Missiles shown to players with high graphic settings.
-
_gmTurnAngle since 2.4.0
float • default:
0.628319The angle in radians at which a Guided Missile will turn to follow its target.
-
_lockOnAngle since 2.4.0
float • default:
0.15The angle, in radians, from a tank's heading (positive and negative) that will determine the scope of which tanks can be locked on for Guided Missiles.
HTTP API
-
_HTTPIndexResourceDir since 2.4.0
string • default:
Filesystem folder path to a directory containing resources that will be accessible via BZFS's built-in HTTP server.
Handicaps
-
_handicapAngAd since 2.4.0
float • default:
1.5The
_angularAdmultiplier for when a player is receiving a handicap. -
_handicapScoreDiff since 2.4.0
float • default:
50.0The difference in score a player must have compared to the average of all players' scores to receive a handicap.
-
_handicapShotAd since 2.4.0
float • default:
1.75The
_shotSpeedmultiplier for when a player is receiving a handicap. -
_handicapVelAd since 2.4.0
float • default:
2.0The
_tankSpeedmultiplier for when a player is receiving a handicap.
High Speed Flag
-
_velocityAd since 2.4.0
float • default:
1.5The multiplier for
_tankSpeedto determine a tank's speed while carrying the High Speed (V) flag.
Identify Flag
-
_identifyRange since 2.4.0
float • default:
50.0The radius distance in World Units (wu) that a tank must be within in order for the Identify flag to work.
Laser Flag
-
_laserAdLife since 2.4.0
float • default:
0.1The amount of seconds a laser remains on the field after being fired.
-
_laserAdRate since 2.4.0
float • default:
0.5The
_rFireAdRatemultiplier to determine the firing rate for lasers. -
_laserAdVel since 2.4.0
float • default:
1000.0The maximum length in World Units (wu) a laser can travel; they're not actually "infinite."
Machine Gun Flag
-
_mGunAdLife since 2.4.0
float • default:
1.0 / _mGunAdRateThe
_shotRangemultiplier to determine the distance Machine Gun bullets go. -
_mGunAdRate since 2.4.0
float • default:
10.0The divisor of
_reloadTime, which results in how long Machine Gun bullets take to reload. -
_mGunAdVel since 2.4.0
float • default:
1.5The speed of Machine Gun bullets.
Map Generation
-
_avenueSize since 2.4.0
float • default:
2.0 * _boxBaseOn randomly generated maps, the amount of space to leave between boxes.
-
_baseSize since 2.4.0
float • default:
60.0On randomly generated CTF maps, the width and depth of square bases; the height of bases are constant.
-
_boxBase since 2.4.0
float • default:
30.0On randomly generated maps, the smallest width and depth sizes for boxes.
-
_boxHeight since 2.4.0
float • default:
6.0 * _muzzleHeightOn randomly generated maps, the height of boxes in World Units (wu). When the "Random Heights" (i.e. the BZFS
-hflag) is enabled, this is the starting value that is then used with random multipliers for each generated box. -
_pyrBase since 2.4.0
float • default:
4.0 * _tankHeightThe size in World Units (wu) of bases for pyramids that are added in randomly generated worlds.
-
_pyrHeight since 2.4.0
float • default:
5.0 * _tankHeightThe size in World Units (wu) of heights of pyramids that are added in randomly generated worlds.
Momentum Flag
-
_momentumAngAcc since 2.4.0
float • default:
1.0The extra momentum added to a tank holding the Momentum flag while turning.
-
_momentumFriction since 2.4.0
float • default:
0The
_frictionapplied to a tank holding the Momentum flag. -
_momentumLinAcc since 2.4.0
float • default:
1.0The extra momentum added to a tank holding the Momentum flag while moving forward and backwards.
Movement
-
_friction since 2.4.0
float • default:
0When set to zero, tanks have normal friction. When set to a non-zero number, the closer the number is to zero (decimal values are valid), the longer it will take for a tank to accelerate and the more a tank will "slide" around after attempting to stop. The higher the number, the closer it is to "normal friction."
-
_gravity since 2.4.0
float • default:
-9.8The World Units (wu) a tank will fall or be kept from jumping measured in seconds squared; i.e.
<wu> / seconds ^ 2. -
_jumpVelocity since 2.4.0
float • default:
19.0The speed at which a tank moves vertically while jumping meausred in World Units per second.
-
_maxBumpHeight since 2.4.0
float • default:
0.33The maximum allowed height difference in World Units (wu) between two uneven surfaces that will allow a tank to drive up to the object without being stopped by it.
-
_noClimb since 2.4.0
boolean • default:
1A boolean value that determines whether tanks can climb up slopes by jumping forward; a false value disallows tanks from climbing up slopes.
Obesity Flag
-
_obeseFactor since 2.4.0
float • default:
2.5The
_tankWidthmultiplier used for tanks holding the Obesity flag.
Quick Turn Flag
-
_angularAd since 2.4.0
float • default:
1.5The
_tankAngVelmultiplier for how fast tanks can turn while holding the Quick Turn flag.
Rain
-
_rainBaseColor since 2.4.0
ColorLiteral • default:
noneWhen
_rainTypeis set torain, the color of the bottom half of raindrops. -
_rainDensity since 2.4.0
integer • default:
noneThe amount of drops that will exist in the space defined by
_rainSpread. -
_rainEndZ since 2.4.0
float • default:
noneThe height above the ground where rain will end and form puddles.
-
_rainMaxPuddleTime since 2.4.0
float • default:
noneThe amount of seconds a rain puddle should exist before disappearing.
-
_rainPuddleColor since 2.4.0
ColorLiteral • default:
noneThe color of rain puddles. A value of
nonemeans no puddles will be formed. -
_rainPuddleSpeed since 2.4.0
float • default:
noneThe amount of seconds it will take for a rain puddle to spread out.
-
_rainPuddleTexture since 2.4.0
string • default:
noneThe texture used for drawing rain puddles.
-
_rainRoofs since 2.4.0
boolean • default:
1Valid values are
0,1, and2(0rain falls through everything;1rain hits buildings but puddles are only on the ground;2rain hits buildings and creates puddles on them). -
_rainSpeed since 2.4.0
float • default:
noneThe speed at which rain drops will move. A negative speed will result in the rain falling from the sky whereas a positive speed will result in rain going up from the ground to the sky.
-
_rainSpeedMod since 2.4.0
float • default:
noneA modifier to
_rainSpeedthat will be added or subtracted from individual rain droplets to have a more natural look of droplets falling at different speeds. -
_rainSpins since 2.4.0
0 | 1 • default:
noneValid values are
0or1(0will cause rain droplets to not spin as it falls;1will cause rain droplets to spin as they fall). -
_rainSpread since 2.4.0
float • default:
noneThe radius in World Units (wu) from the center of the map where rain will fall.
-
_rainStartZ since 2.4.0
float • default:
noneThe height above the ground where rain will start falling from.
-
_rainTexture since 2.4.0
string • default:
noneThe name of the texture (from the client's data directory) used for rain droplets; this value is only respectived when
_rainTypeis set tofrog,particle,bubble,snow, orfatrain -
_rainTopColor since 2.4.0
ColorLiteral • default:
noneWhen
_rainTypeis set torain, the color of the top half of raindrops. -
_rainType since 2.4.0
frog | particle | rain | bubble | snow | fatrain • default:
noneValid rain types are,
frog,particle,rain,bubble,snow, orfatrain. When this value is changed in-game with the/setcommand, it will update respective_rain*settings automatically. -
_useLineRain since 2.4.0
boolean • default:
none -
_useRainBillboards since 2.4.0
boolean • default:
none -
_useRainPuddles since 2.4.0
boolean • default:
none
Rapid Fire Flag
-
_rFireAdLife since 2.4.0
float • default:
1.0 / _rFireAdRateThe amount of seconds a Rapid Fire shot remains on the field after being fired.
-
_rFireAdRate since 2.4.0
float • default:
2.0The amount of seconds a Rapid Fire shot takes to reload.
-
_rFireAdVel since 2.4.0
float • default:
1.5The
_shotSpeedmultiplier used to determine the speed of rapid fire bullets.
Scene Rendering
-
_cullDepth since 2.4.0
int • default:
6 -
_cullDist since 2.4.0
fog | float • default:
fog -
_cullElements since 2.4.0
int • default:
16 -
_cullOccluders since 2.4.0
int • default:
0
Server Administration
-
_disableBots since 2.4.0
boolean • default:
0A true boolean value will disable autopilot and bots (created via the
-solooption) on the server. -
_disableHeightChecks since 2.4.0
boolean • default:
0A true boolean value will disable rudimentary cheat detection for tanks being located "too high" within a world.
-
_disableSpeedChecks since 2.4.0
boolean • default:
0A true boolean value will disable rudimentary cheat detection for tanks moving too fast.
-
_enableDistanceCheck since 2.4.0
boolean • default:
0A boolean value to enable experimental cheat detection on player movements being too great between updates.
-
_endShotDetection since 2.4.0
integer • default:
5The amount of "end shot" messages that can be sent without a corresponding death event.
-
_forbidIdentify since 2.4.0
boolean • default:
0A true boolean value will disallow players from identifying other players; this will disable messages such as "Looking at
" and will remove a player's callsign from Guided Missile's lock notifications. -
_maxPlayerAddDelay since 2.4.0
integer • default:
30
Server Settings
-
_angleTolerance since 2.4.0
float • default:
0.05If a tank has turned more than it was expected to, plus this tolerance, a new update is sent so the other clients are aware of the change in heading.
-
_noSmallPackets since 2.4.0
boolean • default:
0 -
_notRespondingTime since 2.4.0
integer • default:
5.0The amount of times in seconds a player must be considered "non-responsive" before the server reports them as such to other players.
-
_positionTolerance since 2.4.0
float • default:
0.09The amount of World Units (wu) a tank must move before a new update is sent to all players on the server.
-
_rejoinTime since 2.4.0
float • default:
_explodeTimeThe number of seconds a player must wait before rejoining the game after they leave.
-
_speedChecksLogOnly since 2.4.0
boolean • default:
0When set to 0, tanks are kicked from the server when they are detected to be moving too fast. When set to 1, instances of tanks moving too fast are simply logged to standard out instead of kicking them.
-
_syncLocation since 2.4.0
boolean • default:
0 -
_syncTime since 2.4.0
float • default:
-1.0 -
_updateThrottleRate since 2.4.0
float • default:
30.0The maximum number of position updates clients will send every second. Higher values mean higher bandwidth consumption and more server processing time.
Shield Flag
-
_shieldFlight since 2.4.0
float • default:
2.7The amount of time in seconds the shield flag will fly in the air when dropped before falling to again.
Shock Wave Flag
-
_shockAdLife since 2.4.0
float • default:
0.2The amount of time in seconds a Shock Wave lasts.
-
_shockInRadius since 2.4.0
float • default:
_tankLengthThe starting radius of a Shock Wave in world units. A negative value will result in a Shock Wave to first shrink and then expand.
-
_shockOutRadius since 2.4.0
float • default:
60.0The outer radius of the Shock Wave in world units. If this value is greater than
_shockInRadius, the Shock Wave expands outward; if the value is less than_shockInRadius, the Shock Wave will start big and shrink inward. -
_spawnSafeSWMod since 2.4.0
float • default:
1.5The minimum distance in world units that is considered a "safe distance" away from tanks with Shock Wave when calculating spawn locations.
Shot Settings
-
_muzzleFront since 2.4.0
float • default:
_tankRadius + 0.1The distance of a tank's muzzle relative to the tank's center in World Units (wu); this affects bullets' starting location and player camera.
-
_muzzleHeight since 2.4.0
float • default:
1.57The height of a tank's muzzle in World Units (wu); see
_muzzleFront. -
_reloadTime since 2.4.0
float • default:
_shotRange / _shotSpeedTime in seconds between shot reloads; changing this value may affect shot range.
-
_shotRadius since 2.4.0
float • default:
0.5The radius of a shot in world units used to calculate collision detection; e.g. if a shot is 0.5 world units away from a tank, it will consider the tank as being hit.
-
_shotRange since 2.4.0
float • default:
350.0The distance in world units a normal shot can travel.
Note, if this value is changed during runtime, this value can be cut short by a cached
_reloadTimevalue; be sure to run/reset _reloadTimeafter this value is changed via/set. -
_shotSpeed since 2.4.0
float • default:
100.0The speed shots travel measured in world units per second.
Note, if this value is changed during runtime, it can lead to problems such as players not being able to shoot or shots not killing their targets. This is caused by a cached
_reloadTimevalue so run/reset _reloadTimeto recalculate a new value. -
_shotTailLength since 2.4.0
float • default:
4.0 -
_shotsKeepVerticalVelocity since 2.4.0
0 | 1 • default:
0When set to 0, shots will always move in parallel in relation to the ground. When set to 1, shots are affected vertically by the tank's speed, and can fly up and down; lasers are affected by this setting.
Spawn Settings
-
_spawnMaxCompTime since 2.4.0
float • default:
0.01The maximum amount of seconds the server should take when calculating a safe spawn location for players. If this limit is exceeded, then the player will be dropped from a maximum height.
-
_spawnSafeRadMod since 2.4.0
float • default:
20The minimum distance in world units that is considered a "safe distance" away from enemy tanks when calculating spawn locations.
Steamroller Flag
-
_spawnSafeSRMod since 2.4.0
float • default:
3The minimum distance in world units that is considered a "safe distance" away from tanks with Steamroller when calculating spawn locations.
-
_srRadiusMult since 2.4.0
float • default:
2.0The radius in world units that a Steamroller flag will kill nearby tanks.
Tank Settings
-
_squishFactor since 2.4.0
float • default:
1.0The height in world units a tank becomes when they squish while landing.
-
_squishTime since 2.4.0
float • default:
1.0The amount of seconds a tank is squished after landing.
-
_tankAngVel since 2.4.0
float • default:
0.785398The speed of a tank's turning rate measured in world units per second.
-
_tankExplosionSize since 2.4.0
float • default:
3.5 * _tankLengthThe size of a tank's explosion measured in world units.
-
_tankHeight since 2.4.0
float • default:
2.05The height of a tank in world units.
-
_tankLength since 2.4.0
float • default:
6.0The length of a tank in world units.
-
_tankRadius since 2.4.0
float • default:
0.72 * _tankLengthThe radius of a tank in world units.
-
_tankSpeed since 2.4.0
float • default:
25.0The speed of a tank measured in world units per second.
-
_tankWidth since 2.4.0
float • default:
2.8The width of a tank in world units.
-
_trackFade since 2.4.0
float • default:
3.0The number of seconds a tank's tracks begin to fade after being drawn.
Targeting Settings
-
_targetingAngle since 2.4.0
float • default:
0.3The number of radians a player can be offset in facing a tank to still target them with Identify or Guided Missile.
-
_targetingDistance since 2.4.0
float • default:
300.00The distance in world units a player can be from a tank to still target them with Identify or Guided Missile.
Teleporter Settings
-
_teleportBreadth since 2.4.0
float • default:
4.48The horizontal width in world units for randomly generated teleporters.
-
_teleportHeight since 2.4.0
float • default:
10.08The vertical height in world units for randomly generated teleporters.
-
_teleportTime since 2.4.0
float • default:
1.0The maximum duration in seconds a tank can be teleporting before it is forced to stop teleporting.
-
_teleportWidth since 2.4.0
float • default:
1.12The size of the teleporter borders in world units for randomly generated teleporters.
Thief Flag
-
_thiefAdLife since 2.4.0
float • default:
0.05The number of seconds a thief shot will live.
-
_thiefAdRate since 2.4.0
float • default:
12.0The number of seconds it takes for a thief shot to reload.
-
_thiefAdShotVel since 2.4.0
float • default:
8.0The speed measured in world units per second of a thief shot.
-
_thiefDropTime since 2.4.0
float • default:
_reloadTime * 0.5The number of seconds a tank must wait before being able to shoot after stealing a flag.
-
_thiefTinyFactor since 2.4.0
float • default:
0.5The multiplier of a tank's size when they are holding a Thief flag.
-
_thiefVelAd since 2.4.0
float • default:
1.67The multiplier of a tank's speed when they are holding a Thief flag.
Timed Matches
-
_countdownResumeDelay since 2.4.0
integer • default:
5The amount of seconds in the countdown before a paused timed game is resumed.
Tiny Flag
-
_tinyFactor since 2.4.0
float • default:
0.4The multiplier of a tank's size when they are holding a Tiny flag.
Wide Angle Flag
-
_wideAngleAng since 2.4.0
float • default:
1.745329The multiplier applied to a tank's field of vision when holding a Wide Angle flag.
Wings Flag
-
_wingsGravity since 2.4.0
float • default:
_gravityThe gravity of a tank while they are carrying the Wings flag.
-
_wingsJumpCount since 2.4.0
float • default:
1The number of times a tank can perform a jump while in midair before falling to the ground.
-
_wingsJumpVelocity since 2.4.0
float • default:
_jumpVelocityThe initial velocity of a tank's jump while holding a Wings flag measured in world units per second.
-
_wingsSlideTime since 2.4.0
float • default:
0.0The number of seconds a tank will slide in midair while holding a Wings flag.
World Appearance
-
_drawCelestial since 2.4.0
boolean • default:
1A boolean value to draw the stars, sun, and moon.
-
_drawClouds since 2.4.0
boolean • default:
1A boolean value to draw clouds.
-
_drawGround since 2.4.0
boolean • default:
1A boolean value to draw the ground plane.
-
_drawGroundLights since 2.4.0
boolean • default:
1A boolean value to draw light reflections on the ground, such as that produced by bullets.
-
_drawMountains since 2.4.0
boolean • default:
1A boolean value to draw surrounding mountains.
-
_drawSky since 2.4.0
boolean • default:
1A boolean value to draw the sky.
-
_fogColor since 2.4.0
RGB • default:
0.25 0.25 0.25The color of the fog in the format of RGB (i.e.
RED GREEN BLUE) values between 0.0 and 1.0. Additionally, supported color names (e.g. blue, teal, black, pink, gray3, etc.) are supported. -
_fogDensity since 2.4.0
float • default:
0.001The density of the fog that will be rendered for players; only used for
expandexp2fog modes. -
_fogEnd since 2.4.0
float • default:
_worldSizeUsed for linear fog mode, the distance in World Units (wu) relative to a tank's position where fog will occlude everything.
-
_fogMode since 2.4.0
linear | exp | exp2 • default:
noneValid values are,
linear,exp, orexp2; if an invalid value is given, it will default toexp. -
_fogNoSky since 2.4.0
boolean • default:
0A true boolean value will disable fog being drawn on the sky; by default, fog is drawn everywhere.
-
_fogStart since 2.4.0
float • default:
0.5 * _worldSizeUsed for linear fog mode, the distance in World Units (wu) relative to a tank's position where fog will begin to occlude vision.
-
_latitude since 2.4.0
float • default:
37.5When
_syncLocationis true, the latitude of where the map is located along with_longitudeis used to determine the time of day to show to players (day or night). -
_longitude since 2.4.0
float • default:
122When
_syncLocationis true, the longitude of where the map is located along with_latitudeis used to determine the time of day to show to players (day or night). -
_maxLOD since 2.4.0
integer • default:
32767.0The max level of detail to allow.
-
_mirror since 2.4.0
ColorLiteral • default:
noneWhen given a valid color literal, a tinted mirror-like ground reflecting objects and tanks will be shown to players. When given an invalid color literal, the ground will display a mirror-like ground with no tint.
-
_noShadows since 2.4.0
boolean • default:
0A boolean value to allow or disallow shadows being drawn on a map.
-
_skyColor since 2.4.0
ColorLiteral • default:
whiteThe color the sky will be set to.
-
_wallHeight since 2.4.0
float • default:
3.0 * _tankHeightThe outer wall's height.
-
_worldSize since 2.4.0
float • default:
800.0The size of the world in world units from one edge of the world to the opposite edge.
Note: This value is calculated as double of the
worldmap objectsizeproperty.
World Weapons
-
_weapons since 2.4.0
boolean • default:
1When set to
0, no world weapons will be fired on the server. When set to1, world weapons will fire as expected.