BZFlagWiki - User contributions [en]

Server Variables

2014-02-17T20:57:02Z

Javawizard2539: Clarify _updateThrottleRate

The BZFlag Server (BZFS) allows administrators to configure a large number of gameplay and configuration settings from within the client. The /set command in-game allows users with the appropriate permissions to change these values. These may also be known as BZDB variables and "/set variables" depending on who you speak with.

Unless otherwise noted, time values are measured in seconds, distances in [[world units]], and speeds in [[world units]] per second.

{{InfoBox|Note|Some values, such as _worldSize, only take affect at server start since they affect the world file that is generated. It is recommended to apply these in the map file so they are loaded with the map.}}
{|{{Prettytable}}
|-
|{{Hl3}}|'''Name'''
|{{Hl3}}|'''Default'''
|{{Hl3}}|'''Description'''
|-
| _agilityAdVel || 2.25 || Multiplies _tankSpeed for tanks holding Agility flag for a specified amount of time (_agilityTimeWindow)
|-
| _agilityTimeWindow || 1 || The amount of time (in seconds) that the tank will have the speed specified by _agilityAdVel
|-
| _agilityVelDelta || 0.3 || How fast the agility accelerates the player to _agilityAdVel.
|-
| _ambientLight || none ||
|-
| _angleTolerance || 0.05 || If 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
|-
| _angularAd || 1.5 || Multiplies _tankAngVel to determine how fast tanks can turn while holding the Quick Turn flag
|-
| _avenueSize || 2*_boxBase || The amount of space to leave between boxes on randomly generated maps.
|-
| _baseSize || 60 || Width and Depth (bases have constant height) of the square bases for CTF games
|-
| _boxBase || 30 || The smallest amount of Width and Depth a randomly generated box may have.
|-
| _boxHeight || 6*_muzzleHeight || Size of radar box around tanks, as they move in Z. {up and down)
|-
| _burrowDepth || -1.32 || Determines how far down tanks drop when they have the Burrow Flag. Making this much lower makes it below the floor, and impossible to kill the tank without something like a ShockWave flag!
|-
| _burrowSpeedAd || .8 || Multiplied by _tankSpeed to determine how fast tanks holding the Burrow Flag move.
|-
| _burrowAngularAd || .55 || Multiplied by _tankAngVel to determine how fast tanks can turn while holding the Burrow flag.
|-
| _coldetDepth || 6 ||
|-
| _coldetElements || 4 ||
|-
| _countdownResumeTime || 5 || This enforces a delay when resuming a paused countdown. If the argument is lower or equal to 0 then resuming is instantly, otherwise it is delayed according to the value (in seconds). ''Available in 2.1 and later''
|-
| _countdownResumeDelay || 5 || Legacy name for _countdownResumeTime, was renamed in 2.1 and later.
|-
| _cullDepth || 6 ||
|-
| _cullDist || fog || Far plane culling distance ('fog' uses the fog parameters).
|-
| _cullElements || 16 ||
|-
| _cullOccluders || 0 ||
|-
| _disableBots || none || A value of 1 in this variable does not allow autopilot or bots on the server, equivalent to the old -prohibitbots command line option.
|-
| _disableSpeedChecks || 0 || Allows disabling/enabling the speed kicks.
|-
| _disableHeightChecks || 0 || Allows disabling/enabling the "too high" check.
|-
| _drawCelestial || 1 || Draw the stars, sun, and moon.
|-
| _drawClouds || 1 || Draw the clouds.
|-
| _drawGround || 1 || Draw the ground plane.
|-
| _drawGroundLights || 1 || If set to 0, lights on the ground (such as the light from bullets) will not be drawn.
|-
| _drawMountains || 1 || Draw the mountains.
|-
| _drawSky || 1 || Draw the sky pyramid.
|-
| _enableDistanceCheck || 0 || Distance checking tries to verify if a player moved too far between updates (as in, cheating).
|-
| _endShotDetection || 5 || This setting controls how many "end shot" messages can be sent without corresponding deaths (or other reasons, such as a shield drop).
|-
| _explodeTime || 5 || After a tank is killed, this is how long it takes to blow up, and then "respawn". Larger values translates into longer explosions and more client processor time. Note that an explosion is invisible if you are inside it, so large values may make it invisible up close, and extremely large values may make explosions entirely invisible.
|-
| _flagAltitude || 11 || The height that the flag flies up when dropped and the height that a flag spawns at.
|-
| _flagEffectTime || 0.64 || How much time it takes for the flag to go into effect and how quickly the tank spawns from miniature to full size.
|-
| _flagHeight || 10 || The height of the flag (not its pole).
|-
| _flagPoleWidth || 0.025 || The diameter of the flag pole.
|-
| _flagPoleSize || 0.8 || The height of the flag pole.
|-
| _flagRadius || 2.5 || Determines how close a tank must be to a flag to pick it up.
|-
| _fogMode || none || Valid values: linear, exp, or exp2.
|-
| _fogDensity || 0.001 || Used for exp and exp2 fog modes.
|-
| _fogNoSky || 0 || 1 will turn off fog drawing on the sky. The default is fog everywhere.
|-
| _fogStart || 0.5*_worldSize || Used for linear fog mode, the distance where fog begins to occlude vision.
|-
| _fogEnd || _worldSize || Used for linear fog mode, the distance where the fog occludes everything.
|-
| _fogColor || "0.25 0.25 0.25" || "RED,GREEN,BLUE" values between 0.0 and 1.0 and/or basic colors such as blue, teal, black, pink, gray3, red4, etc.
|-
| _forbidHunting || 0 || If turned on (1), prevents players from hunting others.
|-
| _forbidIdentify || 0 || If turned on (1), prevents players from identifying others on the world map.
|-
| _forbidMarkers || 0 || If turned on (1), removes the large flag markers that appear to indicate where your team flag(s) is.
|-
| _friction || 0 || Zero is normal friction, the closer to 0 the harder it is to start and stop, and the higher the number the easier it is to start and stop.
|-
| _gmActivationTime || 0.5 || The 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 its own GM and be blown up!
|-
| _gmAdLife || 0.95 || Multiplied by _shotRange to determine the distance guided missiles will go.
|-
| _gmSize || 1.5 || The size (in WU) of the GM missile shown for players with good graphics settings.
|-
| _gmTurnAngle || 0.628319 || The angle at which a Guided Missile will turn to follow its target. (Measured in radians)
|-
| _gravity || -9.8 || The rate at which a tank will fall (or be kept from jumping) Measured in [[World units]]/Seconds^2. Setting this to a zero or positive value will result in tanks being unable to stay down and will float away.
|-
| _handicapScoreDiff || 50 || How much of a score difference from the average of all player's scores there must be for a player to get a handicap
|-
| _handicapVelAd || 2 || Player with handicap will receive this much more (_tankSpeed * _handicapVelAd) velocity than the normal _tankSpeed value.
|-
| _handicapAngAd || 1.5 || Player with handicap will receive this much more (_angularAd * _handicapAngAd) turning ability than the normal _angularAd value.
|-
| _handicapShotAd || 1.75 || Player with handicap will receive this much more (_shotSpeed * _handicapShotAd) bullet speed than the normal _shotSpeed value.
|-
| _hideFlagsOnRadar || 0 || No flags will appear on the radar.
|-
| _hideTeamFlagsOnRadar || 0 || No team flags will appear on the radar.
|-
| _identifyRange || 50 || If a flag is this distance or closer to a tank carrying the Identify (ID) flag, it will display the closest flag's type.
|-
| _inertiaAngular || 38 || Sets the maximum angular acceleration. Available in version 3.0. Replaces the "-a" option.
|-
| _inertiaLinear || 45 || Sets the maximum linear acceleration. Available in version 3.0. Replaces the "-a" option.
|-
| _jumpVelocity || 19 || The speed a tank moves vertically while jumping.
|-
| _laserAdVel || 1000 || The length of each laser shot. Lasers aren't exactly "infinite" as their description states, they go on for as long as this variable states.
|-
| _laserAdRate || 0.5 || Multiplied by _rFireAdRate to determine the firing rate for a laser.
|-
| _laserAdLife || 0.1 || The amount of time (in seconds) that a laser remains after being fired.
|-
| _latitude || 37.5 || The latitude at which the world exists. This affects the timezone.
|-
| _lgGravity|| 12.7 || Modifies the gravity for owners of the Low Gravity flag. Similar to the _gravity variable. ''Available starting in version 2.1''
|-
| _lockOnAngle || 0.15 || Angle (in radians) in relation to tanks heading (positive or negative) that will allow a Guided Missile to lock onto a target.
|-
| _longitude || 122 || The longitude at which the world exists. This affects the timezone.
|-
| _lRAdRate || 0.5 ||
|-
| _maxBumpHeight || 0.33 || Any difference between the surface a tank is on and the top surface of an object the tank runs into that is less than this value will allow the tank to simply move up to the object rather than being stopped by it.
|-
| _maxFlagGrabs || 4.0 || How many times a flag can be dropped before it respawns. At the first spawn, flags are assigned a random # between 1 and _maxFlagGrabs. Each grab reduces that number by 1, until zero is reached, then the flag spawns at a new location. Flags will always respawn no matter how many flag grabs they have left if dropped over an 'unsafe' zone.
|-
| _maxLOD || 32767 || The max level of detail to allow.
|-
| _mirror || none || Options: '''white''', '''black''', '''red''', '''blue''', '''pink''', '''purple''', '''orange''', etc... ("black 0.75" is a good setting, some invalid options such as '''mirror''' will give a mirror look)
|-
| _momentumLinAcc || 1 || Momentum flag's effect on going forwards and backwards.
|-
| _momentumAngAcc || 1 || Momentum flag's effect on turning.
|-
| _momentumFriction || 0 || Friction (same as _friction) when holding the Momentum flag.
|-
| _mGunAdVel || 1/_mGunAdRate || The speed of the machine gun's bullets.
|-
| _mGunAdRate || 10 || _reloadTime divided by _mGunAdRate gives how long machine gun bullets take to reload.
|-
| _mGunAdLife || 1.5 || Multiplied by _shotRange to determine the distance machine gun bullets go.
|-
| _muzzleFront || _tankRadius + 0.1 || Location of muzzle of tank (affects bullets and player camera location).
|-
| _muzzleHeight || 1.57 || See _muzzleFront.
|-
| _noClimb || 1 || Allow or disallow climbing on sloped surfaces. A value of 0 allows, 1 disallows.
|-
| _noShadows || 0 || Enables or disables shadows. A value of 0 allows, 1 disallows.
|-
| _noSmallPackets || 0 ||
|-
| _notRespondingTime || 5 || The amount of time (in seconds) the server should wait before reporting a tank as not responding.
|-
| _obeseFactor || 2.5 || Multiplier of normal size that determines how big a tank gets when carrying the Obese flag.
|-
| _pauseDropTime || 15 || The amount of time (in seconds) that a tank needs to be paused before its flag is dropped automatically.
|-
| _positionTolerance || 0.09 || If a tank has moved more than this amount in position, send a new update to all tank players.
|-
| _pyrBase || 4 * _tankHeight || Base size of pyramids generated by the default random map generator.
|-
| _pyrHeight || 5 * _tankHeight || Height of pyramids generated by the default random map generator.
|-
| _radarLimit || _worldSize || The maximum area that the radar can see (when not rotated).
|-
| _rainBaseColor || none || When _rainType = rain, sets color of the bottom of raindrops.
|-
| _rainDensity || none || Determines how many drops of rain are in the space defined by _rainSpread.
|-
| _rainEndZ || none || The height above the ground where rain should stop falling.
|-
| _rainMaxPuddleTime || none || The amount of time (in seconds) a rain puddle should exist before disappearing.
|-
| _rainPuddleSpeed || none || The speed at which puddles should spread out.
|-
| _rainPuddleColor || none || Color of rain puddles. none means no puddle.
|-
| _rainPuddleTexture ||none || Texture of puddles. Best to leave default.
|-
| _rainRoofs || 1 || '''0''' rain falls through everything<br>'''1''' rain hits buildings, but puddles are only on the ground<br>'''2''' rain hits buildings, and creates puddles on them
|-
| _rainSpread || none || The radius from center of map where rain will fall.
|-
| _rainSpeed || none || The speed at which the rain falls.
|-
| _rainSpeedMod || none || Randomizes _rainSpeed by adding/subtracting up to this number from each raindrop's speed
|-
| _rainSpins || none || '''0''' Rain does not spin as it falls<br>'''1''' Rain spins as it falls.
|-
| _rainStartZ || none || The height above ground that rain should fall from.
|-
| _rainTexture || none || The name of the texture in data directory.<br>''Works with _rainTypes of frog, particle, bubble, snow, fatrain''
|-
| _rainTopColor ||none || When _rainType = rain, sets color of the top of raindrops.
|-
| _rainType || none || Adjusts all _rain* and _use* variables automatically<br>Valid Options : '''frog''', '''particle''', '''rain''', '''bubble''', '''snow''', '''fatrain'''
|-
| _rejoinTime || _explodeTime || The number of seconds before clients can rejoin a game, after they leave.
|-
| _rejumpTime || 0.01 || From version 3.0. Time a tank has to wait before he can jump again after landing. Any value higher than 0 will make it difficult to jump away from sloped faces like pyramids.
|-
| _reloadTime || _shotRange/_shotSpeed || Time between shot reloads, note that this can cut shot range short.
|-
| _rFireAdVel || 1.5 || Multiplied by _shotSpeed to determine the speed of the rapid fire bullets.
|-
| _rFireAdRate || 2 || The reload time (in seconds) for rapid fire bullets.
|-
| _rFireAdLife || 1/_rFireAdRate || How long the rapid fire bullets last.
|-
| _shieldFlight || 2.7 || The amount of time (in seconds) that a shield flag floats in the air (after you drop it) before coming down again.
|-
| _shockAdLife || 0.2 || The amount of time (in seconds) that a shockwave lasts.
|-
| _shockInRadius || _tankLength || The starting radius of the shockwave. Negative values will make the shockwave shrink and expand.
|-
| _shockOutRadius || 60 || The outer radius of the shockwave. If greater than _shockInRadius, the shockwave expands outward. If less than _shockInRadius, the shockwave starts big and shrinks inward.
|-
| _shotRadius || 0.5 || For collision detection.
|-
| _shotRange || 350 || Range of shots, note that they can be cut short by _reloadTime.
|-
| _shotSpeed || 100 || Speed of shots.
|-
| _shotTailLength || 4 ||
|-
| _shotsKeepVerticalVelocity || 0 || If '''0''', shots always move straight in relation to the ground. If '''1''', shots are affected vertically by the tank's speed, and can fly up and down. Lasers are also affected.
|-
| _skyColor || white || Sets the sky to a specific color.
|-
| _spawnMaxCompTime || 0.01 || This controls the maximum amount of time to attempt finding a safe spawn location. If this time is exceeded, the tank will just get dropped in from maximum height. The time should be in seconds, so the default is to only wait for 10ms.
|-
| _spawnSafeRadMod || 20 || How far away players are forced to spawn from enemy tanks.
|-
|_spawnSafeSRMod || 20 || How far away players are forced to spawn from tanks with Steamroller.
|-
|_spawnSafeSWMod || 1.5 || How far away players are forced to spawn from tanks with Shockwave.
|-
| _speedChecksLogOnly || 0 || If set to 1, someone moving too fast will not get kicked - it will just log it to the stdout.
|-
| _srRadiusMult || 2 || Radius of steamroller effect.
|-
| _squishFactor || 1 || How much tanks squish when landing.
|-
| _squishTime || 1 || How much squishy time you get after falling to the ground.
|-
| _syncTime || 1 || Whether or not to sync the players time with the servers'.
|-
| _syncLocation || 0 || Whether or not to sync the location time with the servers'.
|-
| _tankAngVel || 0.785398 || How fast the tank can turn.
|-
| _tankExplosionSize || 3.5 * _tankLength || How large the tank's explosion is.
|-
| _tankHeight || 2.05 || The height of the tank.
|-
| _tankLength || 6 || The length of the tank.
|-
| _tankRadius || 0.72 * _tankLength || The radius of the tank.
|-
| _tankSpeed || 25 || The speed of the tank
|-
| _tankWidth || 2.8 || The width of the tank.
|-
| _targetingAngle || 0.3 || How far in radians the player can be offset in facing a target to still target them. (Identify or Guided Missile Lock On)
|-
| _teleportBreadth || 4.48 || How much width a randomly generated teleporter has.
|-
| _teleportHeight || 10.08 || How much height a randomly generated teleporter has.
|-
| _teleportTime || 1 || If a teleporting tank exceeds this time, it no longer teleports.
|-
| _teleportWidth || 1.12 || How much width a randomly generated teleporter has. Note that this is not to be confused with the "X" size of teleporters. It is the size of a border.
|-
| _thiefAdLife || 0.05 || The amount of time (in seconds) that a thief shot lasts.
|-
| _thiefAdRate || 12 || The amount of time (in seconds) that the Thief "shot" reloads.
|-
| _thiefAdShotVel || 8 || The speed of thief.
|-
| _thiefTinyFactor || 0.5 || Multiplied by the normal tank size to shrink a tank carrying the thief flag.
|-
| _thiefVelAd || 1.67 || Multiplied by _tankSpeed to determine how fast tanks holding the thief goes.
|-
| _thiefDropTime || reloadTime * 0.5 ||The amount of time you must wait to fire a shot after stealing a flag.
|-
| _tinyFactor || 0.4 || Multiplied by the normal tank size to shrink a tank carrying the tiny flag.
|-
| _trackFade || 3 || The amount of time (in seconds) before track marks fade.
|-
| _updateThrottleRate || 30 || The maximum number of position updates clients will send every second. Higher values mean higher bandwidth consumption and more server processing time.
|-
| _useLineRain || none || '''0''' Rain is not a vertical line<br>'''1''' Rain is vertical lines, smoothly shaded from _rainTopColor to _rainBaseColor
|-
| _useRainPuddles || none || '''0''' Rain does not create puddles<br>'''1''' Rain creates puddles
|-
| _useRainBillboards || none || '''0''' Rain is lines or polygons<br>'''1''' Rain is billboards, textured and look the same from all angles
|-
| _velocityAd || 1.5 || Multiplies _tankSpeed to determine the speed of a tank carrying the high speed (V) flag
|-
| _wallHeight || 3 * _tankHeight|| The outer wall height.
|-
| _weapons || 1 || Used with world weapons, '''0''' world weapons will not fire<br>'''1''' world weapons will fire
|-
| _wideAngleAng || 1.745329 || The viewing angle when a tank has the Wide Angle bad flag.
|-
| _wingsGravity || _gravity || How much gravity affects tanks with the WG flag.
|-
| _wingsJumpCount || 1 || The number of jumps a tank with the wings flag can do before returning to the ground.
|-
| _wingsJumpVelocity || _jumpVelocity || The initial velocity of a jump with wings, in [[world units]]/sec.
|-
| _wingsSlideTime || 0 || When in the air, the tanks will slide for this long.
|-
| _worldSize || 800 || The size of the world from one end to the other. This would not be the same as the [[World_(object)|World Object]] '''size''' option as that one accepts a size parameter from the center to one end.
|}

[[Category:Server]]

BZFlag 2.99

2009-10-08T06:25:06Z

Javawizard2539: /* Release Date */ Changed "third quarter" to "fourth quarter", as the third quarter ended a couple of days ago

BZFlag version 3.0 is the next planned release of BZFlag.

==Overview==
Version 3.0 is currently in development and marked as version v2.99.x. Upon release it will be marked as version v3.0. The primary goals for this version are improved server side stability and security in an effort to minimize the impact of clients that have been modified to provide their users benefit ( aka, cheating ). Additional efforts are being made to extend the server side customization of the game. v3.0 will be completely incompatible with all previous versions of the game. Users of v3.0 will only be able to play on 3.0 servers. This is similar to how v2.0 was incompatible with 1.10.

==Development==
Development began on 3.0 on October 25th 2005. After an initial rush of changes, development stalled, as a number of bugs were found in the current release build of the time ([[BZFlag 2.0.4|v2.0.4]]). These bugs and problems, as well as a number of graphical changes from [[trepan]] necessitated the release of compatible [[BZFlag 2.0.6|v2.0.6]], [[BZFlag 2.0.8|v2.0.8]], and [[BZFlag 2.0.10|v2.0.10]] releases.

==Version Number Change==
v3.0 is the first version to use the new version numbering system. The 3.0 release initially began as the 2.1 development line, with the intent of being released as version 2.2. Part of the way through development, however, the [[Versions|versioning]] number scheme changed and the development revision changed from 2.1 to 2.99. With previous releases the minor version number in the version triplet (major.minor.revision) represented protocol and client compatibility. With 3.0 compatibility is instead reflected in the major version number. This new scheme gives more "room" to deal with minor packaging revisions and patch release updates.

==Features==
v3.0 has a number of features that make for a much improved gameplay experience.

===Fonts===
The font system has been replaced and now uses standard TrueType fonts([http://en.wikipedia.org/wiki/TrueType TTF]). This offers a number of advantages over the older bitmap based font system, including support for unicode character sets.

Users can now set the default fonts that they wish to use on a per-locale basis so they can use the best fonts for their character set. (More info on how?)

===Server Side Logic===
A number of gameplay features have been moved from the client to the server, to ensure more consistent gameplay over the internet, including;
* Flag operations (pickup, capture, identify, etc)
* Pause/unpause
* Shot type

===Game state and security checks===
Many changes and enhancements have been made to the network protocol to prevent errors in the network message stream or shared game state.

===BZW Format===
*Links can now be included in groups, with relative naming.
*Mesh faces can now be used as teleportation link sources (with numerous options)
*Mesh faces can now be used as team bases (must be flat tops).
*Mesh faces can now be used as zones (must be flat tops).
*Meshes can now contain weapon objects.
*World Text objects have been added (with numerous options)
*Dynamic Colors now use a simpler format.
*Solid objects can now specify the 'ricochet' property individually.

===Graphics===
Changes have been made to the graphical quality settings. What was Experimental quality in 2.0.12 is now High quality. Medium quality is between the old High and Medium, and Low has remained mostly unchanged.

The new Experimental mode includes new shot and flag graphics.

===New Server List===
The list of servers has been enhanced to allow tabbed browsing as well as improved searching and sorting.

===HUD Markers===
If HUD markers showing flag position, GM lockon are now shown to players. THe name and team of the closest target is also shown, helping prevent teamkills. Servers can turn off this feature for all players if desired.

===BZFS API===
The [[BZFS API]] has been reviewed and re-factored for 3.0 and includes a number of new events and functions.

====Server Side Players====
The API has experimental support for server side players (bots).

====Custom Flag Names====
The API may define new custom flag names using any strings desired. The ammount of logic that can be processed for custom flags is limited.

====HTTP based plug-ins====
The networking system for BZFS now allows for the support of HTTP (and other ) connections. A number of plugins have been made to take advantage of this new feature, such as;
* [[Fastmap]]
* [[Webadmin]]
* [[Webreport]]
* [[Webstats]]

====BZFS API Versioning====
The versioning system in the BZFS API has been redone, and now event data classes are versioned for forward computability. Custom plug-ins that were written for v2.0.x must be updated to use the new classnames before they will work with v3.0.x. This should only be a one time change as the new classes are versioned and will remain the same in future releases. All standard plug-ins that ship with the bzflag source code have been updated.

===Lua BZFS API===
The lua scripting language (http://lua.org), is now built into the bzfs executable, and exposes almost all of the features from the C++ BZFS API (and a few that the C++ API does not have). It has the advantages of being easier to learn and write than comparable C++ code, and it can be embedded in world files. The main disadvantage is that it is not as fast as native c++ code.

===Server Administration===
Some changes have been made to help you server administrators.

The [[Webadmin]] plug-in allows server owners to manage many aspects of the server from a standard web browsers.

====Local Authentication====
Local authentication ( '''/identify''' ), has been removed from the game, servers can use global authentication services for all authentication needs.

===Gameplay Changes===
A number of changes have been made to the game that will subtly affect gameplay.
====Acceleration====
Tank acceleration is now always on. The "-a" server option has been removed, and the acceleration values are pulled from BZDB variables. These variables are _inertiaLinear and _inertiaAngular.

====Lag Compensation====
Clients now use a synced timestmap and attempt to compensate tank positions for lag. This can change the way the game feels for players that are used to "leading" the target based on its lag.

====Hit Volume====
The volume that defines a "hit" on a tank has been changed. It is now a box around the tank that can be adjusted by the server using BZDB variables.

====No TK Option====
A server can define an option that will allow players to not be killed if a team-mates shot hits them

===Build System===
Much effort has been put into making the bzflag source tree easier to compile on various OSs. The makefile build system has been updated and attempts to detect as many items as possible from the host System. The windows build system has been updated to be compatible with Visual Studio 2008 Express Edition that is freely available. When possible, copies of third party libraries are included with the source code.

===Bug Fixes===
A student is being paid as part of the Google Summer of Code program to evaluate and fix the backlog of reported bugs in the software. This will have the overall effect of increasing the stability of the game.

===ChangeLog===
A full list of changes can be found in the [http://bzflag.svn.sourceforge.net/viewvc/*checkout*/bzflag/trunk/bzflag/NEWS NEWS] file in the [[BZFlag Source]] code in [[BZFlag SVN|SVN]].

==Known Issues==
A lot of stuff needs testing, and probably doesn't work.

==Release Date==
As is always the case for major updates to BZFlag, '''''3.0 will be released when it is done'''''. At present, a major effort is being made to release sometime in the fourth quarter of 2009.

==Misconceptions about V3.0==
There have been a few misconceptions in the community regarding what this new version will and will not do. Most of this is simply due to the exceptionally long development time, or comments being taken out of context.

'''V3 will do everything Server Side, including shots'''

This is untrue. While more things have been moved to the server, shoots and hits are still handled by the client. Shots and hits will not be moved to the server until the code can be shown to maintain the level of response time that players have come to expect.

'''V3 will use more bandwith and be laggy'''

V3 does a better job of handling network traffic to and from players. Many messages have been reduced in size. Server side handling of some events, (like flag grabs) have actually removed some messages from the network stream. Network performance should be similar to V2.x. In some cases, lag compensation may even improve apparent performance.

==See also==
[[Versions]]

[[V3RCChecklist]]

[[Category:Versions]]

BZFlag 2.99

2009-10-08T06:01:22Z

Javawizard2539: /* Lag Compensation */ Corrected grammar mistake

BZFlag version 3.0 is the next planned release of BZFlag.

==Overview==
Version 3.0 is currently in development and marked as version v2.99.x. Upon release it will be marked as version v3.0. The primary goals for this version are improved server side stability and security in an effort to minimize the impact of clients that have been modified to provide their users benefit ( aka, cheating ). Additional efforts are being made to extend the server side customization of the game. v3.0 will be completely incompatible with all previous versions of the game. Users of v3.0 will only be able to play on 3.0 servers. This is similar to how v2.0 was incompatible with 1.10.

==Development==
Development began on 3.0 on October 25th 2005. After an initial rush of changes, development stalled, as a number of bugs were found in the current release build of the time ([[BZFlag 2.0.4|v2.0.4]]). These bugs and problems, as well as a number of graphical changes from [[trepan]] necessitated the release of compatible [[BZFlag 2.0.6|v2.0.6]], [[BZFlag 2.0.8|v2.0.8]], and [[BZFlag 2.0.10|v2.0.10]] releases.

==Version Number Change==
v3.0 is the first version to use the new version numbering system. The 3.0 release initially began as the 2.1 development line, with the intent of being released as version 2.2. Part of the way through development, however, the [[Versions|versioning]] number scheme changed and the development revision changed from 2.1 to 2.99. With previous releases the minor version number in the version triplet (major.minor.revision) represented protocol and client compatibility. With 3.0 compatibility is instead reflected in the major version number. This new scheme gives more "room" to deal with minor packaging revisions and patch release updates.

==Features==
v3.0 has a number of features that make for a much improved gameplay experience.

===Fonts===
The font system has been replaced and now uses standard TrueType fonts([http://en.wikipedia.org/wiki/TrueType TTF]). This offers a number of advantages over the older bitmap based font system, including support for unicode character sets.

Users can now set the default fonts that they wish to use on a per-locale basis so they can use the best fonts for their character set. (More info on how?)

===Server Side Logic===
A number of gameplay features have been moved from the client to the server, to ensure more consistent gameplay over the internet, including;
* Flag operations (pickup, capture, identify, etc)
* Pause/unpause
* Shot type

===Game state and security checks===
Many changes and enhancements have been made to the network protocol to prevent errors in the network message stream or shared game state.

===BZW Format===
*Links can now be included in groups, with relative naming.
*Mesh faces can now be used as teleportation link sources (with numerous options)
*Mesh faces can now be used as team bases (must be flat tops).
*Mesh faces can now be used as zones (must be flat tops).
*Meshes can now contain weapon objects.
*World Text objects have been added (with numerous options)
*Dynamic Colors now use a simpler format.
*Solid objects can now specify the 'ricochet' property individually.

===Graphics===
Changes have been made to the graphical quality settings. What was Experimental quality in 2.0.12 is now High quality. Medium quality is between the old High and Medium, and Low has remained mostly unchanged.

The new Experimental mode includes new shot and flag graphics.

===New Server List===
The list of servers has been enhanced to allow tabbed browsing as well as improved searching and sorting.

===HUD Markers===
If HUD markers showing flag position, GM lockon are now shown to players. THe name and team of the closest target is also shown, helping prevent teamkills. Servers can turn off this feature for all players if desired.

===BZFS API===
The [[BZFS API]] has been reviewed and re-factored for 3.0 and includes a number of new events and functions.

====Server Side Players====
The API has experimental support for server side players (bots).

====Custom Flag Names====
The API may define new custom flag names using any strings desired. The ammount of logic that can be processed for custom flags is limited.

====HTTP based plug-ins====
The networking system for BZFS now allows for the support of HTTP (and other ) connections. A number of plugins have been made to take advantage of this new feature, such as;
* [[Fastmap]]
* [[Webadmin]]
* [[Webreport]]
* [[Webstats]]

====BZFS API Versioning====
The versioning system in the BZFS API has been redone, and now event data classes are versioned for forward computability. Custom plug-ins that were written for v2.0.x must be updated to use the new classnames before they will work with v3.0.x. This should only be a one time change as the new classes are versioned and will remain the same in future releases. All standard plug-ins that ship with the bzflag source code have been updated.

===Lua BZFS API===
The lua scripting language (http://lua.org), is now built into the bzfs executable, and exposes almost all of the features from the C++ BZFS API (and a few that the C++ API does not have). It has the advantages of being easier to learn and write than comparable C++ code, and it can be embedded in world files. The main disadvantage is that it is not as fast as native c++ code.

===Server Administration===
Some changes have been made to help you server administrators.

The [[Webadmin]] plug-in allows server owners to manage many aspects of the server from a standard web browsers.

====Local Authentication====
Local authentication ( '''/identify''' ), has been removed from the game, servers can use global authentication services for all authentication needs.

===Gameplay Changes===
A number of changes have been made to the game that will subtly affect gameplay.
====Acceleration====
Tank acceleration is now always on. The "-a" server option has been removed, and the acceleration values are pulled from BZDB variables. These variables are _inertiaLinear and _inertiaAngular.

====Lag Compensation====
Clients now use a synced timestmap and attempt to compensate tank positions for lag. This can change the way the game feels for players that are used to "leading" the target based on its lag.

====Hit Volume====
The volume that defines a "hit" on a tank has been changed. It is now a box around the tank that can be adjusted by the server using BZDB variables.

====No TK Option====
A server can define an option that will allow players to not be killed if a team-mates shot hits them

===Build System===
Much effort has been put into making the bzflag source tree easier to compile on various OSs. The makefile build system has been updated and attempts to detect as many items as possible from the host System. The windows build system has been updated to be compatible with Visual Studio 2008 Express Edition that is freely available. When possible, copies of third party libraries are included with the source code.

===Bug Fixes===
A student is being paid as part of the Google Summer of Code program to evaluate and fix the backlog of reported bugs in the software. This will have the overall effect of increasing the stability of the game.

===ChangeLog===
A full list of changes can be found in the [http://bzflag.svn.sourceforge.net/viewvc/*checkout*/bzflag/trunk/bzflag/NEWS NEWS] file in the [[BZFlag Source]] code in [[BZFlag SVN|SVN]].

==Known Issues==
A lot of stuff needs testing, and probably doesn't work.

==Release Date==
As is always the case for major updates to BZFlag, '''''3.0 will be released when it is done'''''. At present, a major effort is being made to release sometime in the third quarter of 2009.

==Misconceptions about V3.0==
There have been a few misconceptions in the community regarding what this new version will and will not do. Most of this is simply due to the exceptionally long development time, or comments being taken out of context.

'''V3 will do everything Server Side, including shots'''

This is untrue. While more things have been moved to the server, shoots and hits are still handled by the client. Shots and hits will not be moved to the server until the code can be shown to maintain the level of response time that players have come to expect.

'''V3 will use more bandwith and be laggy'''

V3 does a better job of handling network traffic to and from players. Many messages have been reduced in size. Server side handling of some events, (like flag grabs) have actually removed some messages from the network stream. Network performance should be similar to V2.x. In some cases, lag compensation may even improve apparent performance.

==See also==
[[Versions]]

[[V3RCChecklist]]

[[Category:Versions]]

Jargon

2009-09-28T03:49:09Z

Javawizard2539: /* Jargon */ I've seen pyramids quite frequently referred to as "pyra"s as well

This page hopes to clarify some common jargon, acronyms and slang used by many players in game. They can be useful to know, especially in team situations, as other players will assume that you know what they are talking about.

Many players use map "landmarks," like "mid tower" or "@ R jump," to signify places on the map, so it's a good idea to learn your maps as well as the jargon.

= Acronyms =

<properties>
CTF=[[Capture the Flag]]
FFA=[[Free For All]]
RH=[[Rabbit Hunt]]
KOTH=King of the Hill
R=(Team's) Right
L=(Team's) Left
RF=Red flag
GF=Green flag
BF=Blue flag
PF=Purple flag
HF=Have fun
GJ=Good Job. Often said to the team when a teammate has just captured the opposing team's flag
GL=Good Luck
GS=Good shot. Generally used when a particularly difficult shot kills you
GG=Good game
G1=Good One (shot)
NP=No Problem - mostly used as a response if you're teamkilled
NS=Nice Shot
N1=Nice One (shot)
SRY=Sorry
THX=Thank You
TK=Team Kill, to kill one's own team.
TY=Thank You
WTF?=Something's not quite right..... (Vulgar)
WTH?=Similar to WTF - cleaner version
</properties>

= Jargon =

<properties>
Base=Usually referring to your own base. (eg: ST base! "There's someone with stealth in/at/near our base")
Bots=Non-human-player tanks.
Camping=Staying in one place with the same flag for a long time. If you do this you are ''a camper''.
Capping=Capturing the other teams flag, verb ''to cap''.
Flag Running=Working against your own team, taking your team's flag towards the other team's base. If you do this you are a ''flag runner''.
Flag Shopping=Rapidly picking up and dropping flags, in order to find a particularly powerful or useful one. Also known as ''flag farming''.
Geno=Genocide Flag, usually when seen it chat by itself it warns that an opposing team player has the flag so be careful.
In=Inside the base (if applicable)
Jump/Jumper/Launcher=Either a world object that launches a tank in the air, or a tank that has used said world object.
Lang=Language, Watch your language. (Please don't respond with the language you speak.)
Laser Spamming=Uselessly, blindly, rapidly shooting with the laser flag, often resulting in team kills.
N, S, E, W=North, South, East, West. Compass points relative to the map. (eg: "Where the rabbit?" "N inside hut" or "SE corner")
Out=Directly outside the base (if applicable)
Mid=Middle of the map
Pass=Send the flag to the middle, or to a safe zone. See [[Jumping#Dropping_Flags|this article]].
Pyr/Pyra=Pyramid
Spamming=Filling the chat box with meaningless text.
Spawn camping=Sitting near a team's spawn site waiting to kill them when they respawn after their flag is captured.
Spawn killing=Killing someone as soon as they spawn.
Tele=Teleporter
Theirs=Attack the other team's flag, or used to signify the other team's base.
Ours=Protect your team flag, or used to signify your team's base.
Watch!=Watch out! or Guard! (eg: Watch ours!)
Win=Kill everyone on the map. At the same time.
</properties>

= See Also =
* [[Flag List|Flag Abbreviations]]
* [http://en.wiktionary.org/wiki/Appendix:Internet_slang Common Internet Slang]

[[Category:Gameplay]]

BZFlag on IRC

2009-08-20T16:51:21Z

Javawizard2539: /* Other projects and unofficial channels */

=FreeNode=
The official BZFlag org. and its associated communities use the [http://freenode.net/ freenode IRC network] for communication and collaboration.

==Channels==
===Official channels===
BZFlag maintains 2 official channels run by the org.
====#bzflag====
The [irc://irc.freenode.net/bzflag #bzflag] channel is the primary development and support channel. The major developers and many long time community members are users. Discussions in the channel range from development and coding discussions to technical support and bug reports. #bzflag is a great channel to discuss new features and bugs. The channel is moderated by the project administration and development staff. '''This channel is not for help with specific servers or administration issues'''

====#bzflag-chat====
The #bzflag-chat channel is a more informal channel designated for player community discussions.

===Other projects and unofficial channels===
A number of players, servers, and [[leagues]] have their own channel for more focused discussion. Some of these include:

* ##bar (DUCLeague team, The Barbarians)
* #badgerking (Official Channel for Badgerking's FFA)
* #BoomBZ (Team Channel for GU team [BoOm])
* ##bz-inc (DUCLeague team, [http://my.bzflag.org/league/index.php?link=teaminfo&id=689/ Bz-Incorporated])
* ##bzexcess (Support channel for the [http://bzexcess.com BZExcess.com servers.])
* ##bzflagr (Support channel for the [http://bzflagr.net BZFlagr.net servers.]) - closed down
* #bzfx (Support channel for the bzfx.net BZFlag servers)
* ##bzpod (Channel to discuss the BZFlag podcast, BZPod)
* ##bzpro (Support channel for the [http://bzpro.net BZPro.net servers.])
* ##bztank (Unofficial support channel for the [http://bztank.net BZTank.net servers].)
* #bztraining (Official support channel for the [http://bztraining.org BZTraining server network] and for [http://bznetwork.googlecode.com BZNetwork])
* ##bzw (A place to discuss map making for BZFlag, including ideas and help)
* ##divi (Support channel for [http://divi.fairserve.net Divibox] and other [http://fairserve.bzflag.org Fairserve] servers)
* #dub (Support channel for the dub.bzflag.org BZFlag servers)
* ##ducleague (Support channel for [http://my.bzflag.org/league/ Ducati League (DucLeague)])
* #forestforce ([http://gu.bzleague.com/index.php?link=teaminfo&id=10 GULeague Team])
* ##guleague (Support channel for [http://gu.bzleague.com/ GamesUnited League (GULeague)])
* #hepcat (Support channel for borrego.hepcat.org BZFlag server) ''defunct''
* ##icf (Support channel for [http://gu.bzleague.com/index.php?link=teaminfo&id=112 Invasive Chaotic Frenzies, (GULeague)])
* #inleague (Support channel for [http://in.bzleague.com InterNational League (INLeague)])
* #kas (GULeague team, KAS)
* ##norang (Support channel for [http://bzflag.norang.ca Norang.ca] BZFlag servers)
* #pillbox (Support channel for [http://pillbox.bzleague.com/ Pillbox League (PBLeague)])
* ##planetmofo (Support channel for [http://www.planet-mofo.com planet-mofo.com] servers)
* #plosileague (Support channel for [http://bzfx.net/league/ Plosileague]) ''defunct''
* #silvercat (Support channel for [http://silvercat.bzflag.org/ Silvercat BZFlag servers]) ''defunct''
* ##t42 ([http://gu.bzleague.com/index.php?link=teaminfo&id=39 GULeague team])
* ##untamed ([http://my.bzflag.org/league/index.php?link=teaminfo&id=909 DUCLeague team])

When the Freenode Group Management System is implemented, channels with a single # will need to either register their organization with Freenode or rename to begin with ## (a "reference" channel, one that holds no legal claim to the name).

=stormcenter.net=
An unofficial bzflag channel is run on irc.stormcenter.net
* #bzflag (official support channel for [http://www.bztank.net BZtank] servers)

=IRC Clients=
To access the IRC network you need to use an IRC client. [http://irchelp.org/ http://irchelp.org/] is an excellent resource for more information on general IRC.

=External links=
*[http://irchelp.org/ IRC help docs]

[[Category:Development]]
[[Category:Support]]

BZFS

2009-08-11T08:14:36Z

Javawizard2539: Noted that bzfs -conf files have to end with a newline or bzfs complains about them not existing

''This is an article specifically about the BZFS program. For general information on creating a BZFlag server, see [[Creating A Server]].''

BZFS is name of the the [[BZFlag]] server application. It is a command line application that can ether be run manually or started from within the game. The server supports a large list of [[BZFS Command Line Options|command line options]] that can be used. All BZFlag games are hosted on BZFS servers, there is no 'single player' game that is run with only a client.

==Public Vs. Private Servers==
BZFS can be run in ether a public or private mode. Public servers are listed with the central [[List Server]] system and can take advantage of the [[Global Registration]] system for user management. Private servers will only be visible on the LAN they are started on. The in-game server menu can only start private servers.

==Command line options and Config files==
BZFS uses a large number of [[BZFS Command Line Options|command line options]] to set the various modes and options for a game. These options can be specified from the command line prompt of the host OS, or via a text file that is called the 'Config'. BZFS does not ship with a standard config file, it is assumed that the user will make their own. The full path to the config file is specified with the '''-conf''' option. The file referenced by '''-conf''' must itself end with a newline or bzfs will complain that the file does not exist.

==World Files==
BZFS can read in [[BZW]] formated map files and use them to define the 3d world the game is played in.

==Plug-ins and the BZFS API==
BZFS can be extended by the use of server side [[Plug-ins]]. These [[Plug-ins]] are runtime loaded DLLs/SO files that use the [[BZFS API]] to modify and automate various game logic and settings.

==See also==
[[BZFS Command Line Options]]

[[BZFS API]]

[[Plug-ins]]

[[Sample conf|Sample Config File]]

[[Category:Server]]

BZFlag on IRC

2009-08-02T04:12:03Z

Javawizard2539: /* Other projects and unofficial channels */ Added BZTraining's channel

=FreeNode=
The official BZFlag org. and its associated communities use the [http://freenode.net/ freenode IRC network] for communication and collaboration.

==Channels==
===Official channels===
BZFlag maintains 2 official channels run by the org.
====#bzflag====
The [irc://irc.freenode.net/bzflag #bzflag] channel is the primary development and support channel. The major developers and many long time community members are users. Discussions in the channel range from development and coding discussions to technical support and bug reports. #bzflag is a great channel to discuss new features and bugs. The channel is moderated by the project administration and development staff. '''This channel is not for help with specific servers or administration issues'''

====#bzflag-chat====
The #bzflag-chat channel is a more informal channel designated for player community discussions.

===Other projects and unofficial channels===
A number of players, servers, and [[leagues]] have their own channel for more focused discussion. Some of these include:

* ##bar (DUCLeague team, The Barbarians)
* #badgerking (Official Channel for Badgerking's FFA)
* #BoomBZ (Team Channel for GU team [BoOm])
* ##bz-inc (DUCLeague team, [http://my.bzflag.org/league/index.php?link=teaminfo&id=689/ Bz-Incorporated])
* ##bzexcess (Support channel for the [http://bzexcess.com BZExcess.com servers.])
* ##bzflagr (Support channel for the [http://bzflagr.net BZFlagr.net servers.]) - closed down
* #bzfx (Support channel for the bzfx.net BZFlag servers)
* ##bzpod (Channel to discuss the BZFlag podcast, BZPod)
* ##bzpro (Support channel for the [http://bzpro.net BZPro.net servers.])
* ##bztank (Unofficial support channel for the [http://bztank.net BZTank.net servers].)
* #bztraining (Official support channel for the [http://bztraining.org BZTraining server network])
* ##bzw (A place to discuss map making for BZFlag, including ideas and help)
* ##divi (Support channel for [http://divi.fairserve.net Divibox] and other [http://fairserve.bzflag.org Fairserve] servers)
* #dub (Support channel for the dub.bzflag.org BZFlag servers)
* ##ducleague (Support channel for [http://my.bzflag.org/league/ Ducati League (DucLeague)])
* #forestforce ([http://gu.bzleague.com/index.php?link=teaminfo&id=10 GULeague Team])
* ##guleague (Support channel for [http://gu.bzleague.com/ GamesUnited League (GULeague)])
* #hepcat (Support channel for borrego.hepcat.org BZFlag server) ''defunct''
* ##icf (Support channel for [http://gu.bzleague.com/index.php?link=teaminfo&id=112 Invasive Chaotic Frenzies, (GULeague)])
* #inleague (Support channel for [http://in.bzleague.com InterNational League (INLeague)])
* #kas (GULeague team, KAS)
* ##norang (Support channel for [http://bzflag.norang.ca Norang.ca] BZFlag servers)
* #pillbox (Support channel for [http://pillbox.bzleague.com/ Pillbox League (PBLeague)])
* ##planetmofo (Support channel for [http://www.planet-mofo.com planet-mofo.com] servers)
* #plosileague (Support channel for [http://bzfx.net/league/ Plosileague]) ''defunct''
* #silvercat (Support channel for [http://silvercat.bzflag.org/ Silvercat BZFlag servers]) ''defunct''
* ##t42 ([http://gu.bzleague.com/index.php?link=teaminfo&id=39 GULeague team])
* ##untamed ([http://my.bzflag.org/league/index.php?link=teaminfo&id=909 DUCLeague team])

When the Freenode Group Management System is implemented, channels with a single # will need to either register their organization with Freenode or rename to begin with ## (a "reference" channel, one that holds no legal claim to the name).

=stormcenter.net=
An unofficial bzflag channel is run on irc.stormcenter.net
* #bzflag (official support channel for [http://www.bztank.net BZtank] servers)

=IRC Clients=
To access the IRC network you need to use an IRC client. [http://irchelp.org/ http://irchelp.org/] is an excellent resource for more information on general IRC.

There is a BZFlag-hosted IRC client at http://my.BZFlag.org/irc/irc.cgi.

=External links=
*[http://my.BZFlag.org/irc/irc.cgi BZFlag.org-hosted IRC client]
*[http://irchelp.org/ IRC help docs]

[[Category:Development]]
[[Category:Support]]

BZFlagWiki:Content Policy

2009-08-02T03:50:24Z

Javawizard2539: /* Writing Style */ "exempt" is correct grammer here, not "exempted"

This page describes the acceptable content policy for articles in this wiki.

== Overview ==
The BZFlag wiki is provided as shared informational resource for the player community. Its intended content is factual information regarding the BZFlag game and its community. To do this it must maintain a level of impartiality when dealing with that content. Below is a set of guidelines for users posting articles here.

== Subjects ==
All articles on the BZFlag Wiki MUST have a direct bearing on the game itself. Articles that are not directly related to the game will be removed from the wiki.

=== Acceptable Subjects ===
The following are acceptable subjects for BZFlag Wiki Articles.
* Documentation of BZFlag Software.
* Documentation of BZFlag terms and concepts.
* Documentation of tasks specific to the direct use of the BZFlag source code, or software.
* Collaborative development projects directly related to BZFlag.
* Guides and help for playing the game or using BZFlag-related tools.
* Factual historical references to BZFlag, software, source code, and developers.
* General Information about specific maps, and links to their location.
* General Information about specific servers, and links to their administration and websites.
* General Information about server networks, and links to their administration and websites.

=== Unacceptable Subjects ===
The following subjects should not be addressed in wiki articles.
* Server specific rules and policies.
* Advertisements for specific servers, users, or maps.

== Article Contents ==
The contents of articles must be presented in an impartial and factual manner. Wiki articles should be considered descriptive of their subjects, and at all times informational. If a statement can not be backed up with facts, it does not belong in the article. If the fact has no bearing on the subject matter in a descriptive way, it does not belong in the article. Some articles will have more or less factual content following these rules. The further away a subject is from the core game, the less information is applicable to the wiki. The page describing the command line options of the BZFS server will have significantly more applicable information then an article on a network of servers will.

If the article does not deal directly with the BZFlag software or development process, and needs to reference information that is available on other websites, then the article should simply link to them. This includes items such as server rules, and other information that is elsewhere.

Articles should not be written to promote or hinder any one specific server, network, group, or person. No statements should be based on opinion unless the article is designed specifically for promoting a collaborative workflow. In all cases statements should be presented with civility.

Articles do not "belong" to any one author. The nature of a wiki is for community created and edited content. Recognize that articles can be changed by anyone and no individual controls any specific article; therefore, any writing you contribute can be mercilessly edited and redistributed at will by the community. If the author of an articles wishes to post information that is not to be changed by other users (such as server rules), it should not be part of the wiki article. This information should be linked to via an external web-link.

== Writing Style ==
As previously stated articles should be written to be descriptive. Personal words like "you", "me", "your", etc.. should not be used, as the wiki is not a conversation. If part of the article is a description of steps of action, then they should simply be described as the action taken, not the actions of the specific user. The various talk namespaces are of course exempt from this rule.

== Content Disputes ==
As the wiki is user edited, conflicts and edits in the contents or articles can and will occur. When an article is changed, the previous author should read the changes and attempt to understand them before taking any action. Users changing articles should leave descriptive comments with the change indicating why they changed the article. Be civil. If a previous author disputes the changes, they should attempt to work out an amicable solution on the talk page of the article. Stay cool when the editing gets hot; find consensus. The revert function should not be used in haste; it is primarily intended to assist with article vandalism, or when a change blatantly disregards this policy. Users that are unable to work out acceptable content for an article should contact the Project Administrators and be prepared to explain the issue and how the desired content will follow this policy.

==Page History==
Please [[BZFlagWiki:Be_bold|'''Be Bold''']] when editing, moving and creating articles. This is how a wiki grows and do not worry about messing up. All prior versions of articles are kept, so there is no way that you can accidentally damage the BZFlag Wiki or irretrievably destroy content. But remember — whatever you write here will be preserved for posterity.

[[Category:BZFlagWiki Policy]]

User:Javawizard2539

2009-07-29T21:26:46Z

Javawizard2539: ...

I've been playing BZFlag since something like early '07. My primary programming language is Java. I also program in C++. My nickname on Freenode IRC is usually jcp, although I sometimes use javawizard2539 there too, and my username on the forums and while playing bzflag is javawizard2539. If you need to contact me, probably the best way is to pm me on the forums, or contact me via IRC.

User:Javawizard2539

2009-07-29T21:26:21Z

Javawizard2539:

I've been playing BZFlag since something like early '07. My primary programming language is Java. I also program in C++. My nickname on IRC is usually jcp, although I sometimes use javawizard2539 there too, and my username on the forums and while playing bzflag is javawizard2539. If you need to contact me, probably the best way is to pm me on the forums.

User:Javawizard2539

2009-07-25T07:56:33Z

Javawizard2539:

Template:Apicall/doc

2009-03-14T03:41:10Z

Javawizard2539: I think I've pretty much updated the documentation to reflect what I changed. Now I just need to get around to documenting all of the Template:apicall subpages...

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}

Template:Apicall/doc

2009-03-14T03:30:59Z

Javawizard2539:

<b>This documentation needs to be updated, due to some changes I've made in the template.</b>

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}

Template:Apicall/doc

2009-03-14T03:30:02Z

Javawizard2539: Updated the documentation to add the return type, which was omitted by mistake

<b>This documentation needs to be updated, due to some changes I've made in the template.</b>

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}

Template:Apicall

2009-03-14T03:24:47Z

Javawizard2539:

<tt>{{#if:{{{returns|}}}|{{apicall/typelink|{{{returntype}}}}}|void}} {{{name}}} ({{apicall/ifsigparam|{{{param1type|}}}|{{{param1|}}}}}{{apicall/ifnsigparam|{{{param2type|}}}|{{{param2|}}}}}{{apicall/ifnsigparam|{{{param3type|}}}|{{{param3|}}}}}{{apicall/ifnsigparam|{{{param4type|}}}|{{{param4|}}}}}{{apicall/ifnsigparam|{{{param5type|}}}|{{{param5|}}}}}{{apicall/ifnsigparam|{{{param6type|}}}|{{{param6|}}}}}{{apicall/ifnsigparam|{{{param7type|}}}|{{{param7|}}}}}{{apicall/ifnsigparam|{{{param8type|}}}|{{{param8|}}}}}{{apicall/ifnsigparam|{{{param9type|}}}|{{{param9|}}}}}{{apicall/ifnsigparam|{{{param10type|}}}|{{{param10|}}}}})</tt><br/>
<div style="border-left: 30px solid white; border-top: 1px solid white">
{{#if:{{{version|}}}|<b>Minimum API Version:</b> {{{version|}}} <br>}}
{{{description|<i>No description</i>}}}
{{#if:{{{param1|}}}{{{param2|}}}{{{param3|}}}{{{param4|}}}{{{param5|}}}{{{param6|}}}{{{param7|}}}{{{param8|}}}{{{param9|}}}{{{param10|}}}{{{param11|}}}{{{param12|}}}{{{param13|}}}{{{param14|}}}{{{param15|}}}{{{param16|}}}{{{param17|}}}{{{param18|}}}{{{param19|}}}{{{param20|}}}|<div style="border-top: 4px solid white; border-bottom: 3px solid white"><b>Parameters: </b></div>}}
{{apicall/ifparam|{{{param1|}}}|{{{param1desc|}}}}}{{apicall/ifparam|{{{param2|}}}|{{{param2desc|}}}}}{{apicall/ifparam|{{{param3|}}}|{{{param3desc|}}}}}{{apicall/ifparam|{{{param4|}}}|{{{param4desc|}}}}}{{apicall/ifparam|{{{param5|}}}|{{{param5desc|}}}}}{{apicall/ifparam|{{{param6|}}}|{{{param6desc|}}}}}{{apicall/ifparam|{{{param7|}}}|{{{param7desc|}}}}}{{apicall/ifparam|{{{param8|}}}|{{{param8desc|}}}}}{{apicall/ifparam|{{{param9|}}}|{{{param9desc|}}}}}{{apicall/ifparam|{{{param10|}}}|{{{param10desc|}}}}}{{apicall/ifparam|{{{param11|}}}|{{{param11desc|}}}}}{{apicall/ifparam|{{{param12|}}}|{{{param12desc|}}}}}{{apicall/ifparam|{{{param13|}}}|{{{param13desc|}}}}}{{apicall/ifparam|{{{param14|}}}|{{{param14desc|}}}}}{{apicall/ifparam|{{{param15|}}}|{{{param15desc|}}}}}{{apicall/ifparam|{{{param16|}}}|{{{param16desc|}}}}}{{apicall/ifparam|{{{param17|}}}|{{{param17desc|}}}}}{{apicall/ifparam|{{{param18|}}}|{{{param18desc|}}}}}{{apicall/ifparam|{{{param19|}}}|{{{param19desc|}}}}}{{apicall/ifparam|{{{param20|}}}|{{{param20desc|}}}}}{{#if:{{{returns|}}}|<div style="border-top: 4px solid white"><b>Returns: </b></div><div style="border-left: 30px solid white; border-top: 4px solid white">{{{returns}}}</div><br/>}}
</div><br/>{{#ifeq:{{{nopagelink|_NOT_HERE_}}}|_NOT_HERE_|[[Functions(API)|Function List]]}}<br/>
<noinclude>{{Documentation}}</noinclude>
<includeonly>
[[Category:BZFS API Functions]]
</includeonly>

User:Javawizard2539

2009-03-02T04:28:57Z

Javawizard2539: Creative, it really is getting reported by CIA. Reverted my user page back to the way it was before.

I've been playing BZFlag since something like early '07. My primary programming language is Java. I also program in C++. My nickname on IRC is javawizard2539, and my username on the forums and while playing bzflag is... go figure. I'm involved in 2 projects on Sourceforge, BZFlag and [http://sf.net/projects/OpenGroove OpenGroove], a project I recently started that is still WAY early in development. If you need to contact me, probably the best way is to send me an email at javawizard@trivergia.com , or you can also send me a PM on the forums or catch me online at the [[BZFlag on IRC|BZFlag IRC Channels]].

User:Javawizard2539

2009-03-02T04:28:02Z

Javawizard2539: Added something to my user page...

Known Cheats

2009-02-21T17:57:54Z

Javawizard2539: /* Blatant Cheats */ Added the cheat that allows speaking as another player (but not how it's done, for obvious reasons)

Cheats performed on BZFlag are usually made by modifying your client. A great deal of power is invested in the client program, and therefore the client may cheat in every way from creating invincible tanks, to invisibility, to super killing. If you have seen any cheats, have performed them yourself, or have noticed a hole in the source, please add it here. Preventions for many of these cheats are being developed for inclusion in [[BZFlag 3.0|v3.0]].

== Warning ==
Do not use a modified client on a public server. If you are found to be using a cheat client, you will likely be banned from multiple servers and could quickly find yourself with nowhere to play. Cheating in BZflag is not the same as using a cheat code in a PlayStation game. See also the ''Notes on "CHEAT" servers'' at the bottom of the [[BZFlag_README | README]], which forbid the hosting of a "cheat" server. A copy of the README is included with the source code and is displayed when you install a pre-compiled copy of the game.

== Blatant Cheats ==
The following cheats are considered "blatant" cheats because they are usually apparent, even to new players.

NOTE: Some of these cheats may be prevented or already fixed in certain versions of BZFlag.

A cheater may:
* fly without Wings.
* steal from or give flags to other players.
* give flags to observers.
* rapidly pickup and drop every flag on the map, as if a flag reset were performed.
* spawn with a flag (usually Guided Missile or Genocide, but can be anything).
* be immune to the effects of bad flags.
* grab a new flag when passing through a teleporter (when no flag exists).
* move, pickup flags, or shoot other tanks while paused.
* move through buildings without Oscillation Overthruster ("wall walking").
* move backwards through buildings with the Oscillation Overthruster.
* drive outside of the playing area.
* jump back briefly to avoid a bullet then return to where you were ("network jitter").
* double jump.
* move vertically on a map very quickly or higher than settings would normally allow.
* instantaneous travel to a new location.
* jump and land at a pre-determined set of coordinates (i.e. the center of a team pad).
* shoot teammates without blowing them up.
* shoot bullets that travel at a different rate (usually faster).
* shoot bullets that travel at impossible linear paths (i.e. downwards, sideways).
* shoot bullets from any side of their tank.
* fire multiple shots simultaneously, often in spreads & separate impossible paths.
* shoot bullets which cannot be seen on radar or in the HUD.
* cause himself to be shot by any other player, even if no shots were fired or the player hasn't spawned (AKA "TK Cheat").
* cause another player to shoot the cheater, even if no shots were fired.
* produce abnormally long laser blasts (in terms of length and time).
* be zoned, but yet still shoot tanks that are not zoned.
* become instantly unzoned.
* not lose flags when paused.
* cause the bullets of other tanks to explode prematurely.
* lock onto stealthed players while using Guided Missile.
* produce abnormally large, small, or frequent shockwave blasts.
* produce shockwaves at several locations simultaneously.
* respond differently to gravity.
* move at a different rate (usually faster).
* instantly self-destruct.
* be completely invincible to shots ("god mode").
* be invincible while on auto-pilot.
* be partially invincible, repelling everything but some particular flags (often SW or SR are chosen).
* instantly kill everyone else.
* spawn without delay or very rapid respawns (Has been fixed in 2.0.11).
* be joined as an observer, but playing with a visible, invincible tank
* be able to strafe or slide left or right
* send chat messages that appear to have come from another player

== Subtle Cheats ==
'''Subtle cheats''' are modifications to the BZFlag client that give the user an unfair advantage. Unlike the obvious "blatant" cheats, these modifications are often difficult to detect by other players. These modifications often involve small changes to existing source code, and will make their users appear luckier, more intuitive, or more accurate shooters, giving them a slight edge.

Some of these cheats may be detected by examining long-term player statistics. For example, if a specific player picks up a certain superflag 80% of the time over an extended period, on a map where flag positions are completely randomized, then there is strong reason to suspect the player of using a flag identification cheat.

The following is a list of known subtle cheats:

[[Image:Bzfi0002.png|thumb|A screenshot taken on a typical cheat client. Various modifications and enhancements are visible.]]
[[Image:Coo.png|thumb|A screenshot taken on cheat client.]]

;FlagColoring
:Flags are given unique colors (or some other identifying feature - colors are simplest). This can be applied to some, or all flags. For example, bad flags are brown, Shock Wave is cyan, Stealth is orange, Guided Missile is pink, etc. This allows the user to avoid bad flags, spot good flags from across the map, and tell what flags other players are carrying or picking up much more easily.

;RadarPath
:The player can see bullet trajectories at an extended length, making shots easier to avoid, or aiding with targeting. The latter function is used mostly on ricochet maps.

;StealthDetect
:The player can see stealthed tanks on the radar. Often times the cheater's client will flash the stealthed tank on the cheater's radar. This allows a cheater to know that he shouldn't be able to know that tanks position and allow him to "play dumb".

;CloakDetect
:The player can see cloaked tanks on the field. Often times the cheater's client will show cloaked tanks as zoned tanks (as if holding the PZ flag).

;DisableBadFlags
:Bad flags whose effects are invisible to other players are disabled from affecting the tank.

;NoGenocide
:A teammate is impervious to Genocide.

;FunnyBullet
:Various cheats that affect the manner in which bullets are fired are possible. The simplest is to increase bullet velocity. Other cheats include launching multiple bullets in different directions and giving bullets a vertical slope. Many of these cheats are less subtle, and discussed above.

;SkinnyTank
:Normally, if your aim is a little bit off, you can still kill a tank. When this cheat is in effect, other players have to aim more accurately to kill the user.

;ImprovedConsole
:The player's console provides more information than is normal. It's debatable whether this should be considered a cheat or not, but players with better consoles will have a slight advantage.

;GuidedMissileWontUnlock
:When the user is killed, his guided missiles remain locked on their targets. This is harder to detect than a Guided Missile being able to lock onto stealthed players, which is discussed above.

[[Image:Bzfi0001.png|thumb|A hacked client equipped with the ProgressiveIdentify cheat. One flag has been identified so far.]]

;BulletFreeZone
:Any player in the game can cause anyone else's bullets to explode prematurely (if their client is hacked). Here are a few possible effects:
:# A victim (or victims) will not be able to fire his weapon (bullets will explode shortly after leaving the muzzle). Others can't tell who is causing this.
:# Bullets will explode before hitting a cheater, as if the cheater has a forcefield.
:# Bullets will explode before hitting a "victim" who is not the cheater, creating the impression that the victim has a forcefield and is cheating. Or the cheater could create the impression that a whole group of tanks are cheating.
:# Bullets will not be allowed to enter a "bullet-free zone" (such as a building or platform).

;TinyCloak
:The cheater's tank is modified to be smaller and harder to hit, but only when carrying the Cloaking flag. Making a tank this hard to hit would be a blatant cheat if the tank wasn't cloaked.

;ProgressiveIdentify
:A variation of the FlagColoring cheat. The client holds the identity of each flag in memory whenever it is picked up by any player and displays the flag type on the cheater's HUD.

In addition to the above subtle cheats, a cheater may:
* have a wider than normal field of vision (e.g. 120 degrees)
* have Guided Missles modified to not lock onto team mates
* modify the turn rate of his Guided Missles
* modify the way his targets are selected for Guided Missle lock
* have an indicator showing when an opponent is in reloading mode
* modify his client string
* automatically self-destruct if a geno bullet comes too close to him
* see the screen and radar when paused
* be able to see who locked on them with a Guided Missle
* have radar or different radar settings independent of server radar settings
* have lines on the radar showing which way each tank is facing
* see burrowed tanks as regular tanks on the radar
* have no limits imposed upon the radar "/set _radarLimit 0 or Burrow do not affect the radar"
* have shots by a zoned tank not show up on radar
* make slight turns when falling
* have different binocular zoom settings
* fire with no delay after stealing a flag with thief
* have an indicator showing how many wing jumps are left
* see invisible bullets on radar
* see opponent's team color despite opponent having masquerade flaga
* have an auto-aiming ability that lines up on other tanks to fire upon
* be able to enable auto-pilot on non-auto-pilot maps
* be able to enable/disable/enable auto-pilot without delay
* be able to enable auto-pilot without notifying the server/other players

== Other Malicious Activities ==
The following is a list of malicious activities that cheaters might also engage in:

* attempt to guess or "crack" the server or map's password.
* the use of "Bots" or "Drones" to lag a server by sending large amounts of data or using client commands rapidly
* the use of "Bots" or "Drones" to deny a poll or create and complete a poll in the favor of the cheater

[[Category:Gameplay]]
[[Category:Server]]
[[Category:Server Security]]

Flag ideas

2009-01-03T02:25:02Z

Javawizard2539:

== Some simple guidelines ==
=== <span style="color:#cc0000">READ THIS FIRST</span> ===
* First, check that your idea isn't already here. Also check the [[Flag ideas/Rejected|flag ideas already rejected]] page to see if your idea has already been considered and dismissed. The chances are that someone else has already come up with your flag.
* Next, think carefully about your flag. Come up with a short and succinct description. Not only will a short description will make it easier for the project management team to make a decision about the flag, but it usually also indicates the quality of the idea. Chances are if a flag requires more than a short sentence or two, it's too complicated for the game.
* Make sure your flag idea isn't overpowered or stupid.
* Finally, add your flag to the '''top''' of the section with the blank 'status' field. Use the teal background color and leave the status blank!
* Note that your flag approved to a "yes" does not mean it will happen. Everything done is what the developers want to do - if a flag requires significant changes to the codebase and isn't the most brilliant idea ever, it'll probably sit here for quite some time before being implemented, if ever.

This is NOT a list of flags that are being considered. Discussion/implementation of these is encouraged, but does not mean any of these flags are going into the game.

If you do implement a flag keep these things in mind:
* All powerful flags aren't fun.
* Flags that ensure your immediate destruction aren't fun.
* Flags that aren't useful aren't fun.
* Flags boost/modulate tactical trait of tanks

Based on these observations we have the following rules:

;Flag power must be limited
:For example, BZFlag has stealth and cloaking flags, but no stealth-and-cloak flag. Such a tank would be virtually impossible to destroy. Nobody likes to play against someone who can't lose.
The guided missile and laser flags are both exceptionally powerful flags, but neither make the owner invincible. Laser takes twice as long to reload and a guided missile can be dodged while still firing on the owner. You've got to be good, but it can be done!

;Flag powers can counteract/balance each other.
:Some flags are handily defeated with another kind of flag. The oscillation overthruster can be destroyed by a super bullet or a shock wave (or a genocide). Cloaking is effective against laser and stealth is good against guided missile. Ricochet is useful against ricochet.
:Consider adding counterbalancing flags together. Or consider adding a flag that acts as a counterbalance to an existing flag or flags. Also consider making your new flag counterbalanced by an existing flag; superbullet is often a good choice.

;Don't add flags that (almost) instantly kill the owner.
:I considered adding a Death flag that would instantly kill the tank that grabbed it. I changed my mind because that's not fun and seriously dampens interest in picking up flags. Mines are similar. You're driving around and *boom* you're dead. Nothing you could've done to avoid it, no mistake you made. You're just dead. People don't mind losing so much if they know it was because they did something wrong.
:Even worse is a flag that disables your radar and vision. You're basically dead. You can shoot at random and hope to get lucky, but no amount of skill can save you. And what's worse than the Death flag is that you have to stagger around waiting for someone to kill you.
:A flag that seriously disables a tank is not as bad because the player can still use skill to defeat as many enemies as possible before getting shot. Thus we have flags like left turn only and obesity.

;Flags should require new skills
:Flags that require new skills keep the game interesting. If there's still more to learn about using ricochet or guided missile, or more to learn about fighting against them, then people will keep playing.
:Some flags seem pretty dull to some players. The steamroller and the phantom zone come to mind, or quick turn. These aren't the most powerful flags, but they do have their uses and some people enjoy them. However, I think I should have removed SR and PZ. Steamroller's usefulness is very limited and looks pretty weak compared to shock wave. PZ tends to encourage very defensive play, which slows the game down. But quick turn can be very effective when used well; put it in a tight furball and it'll do serious damage. You just have to learn how to take full advantage of it.

== List of suggested flags: ==

{| cellpadding="10" cellspacing="1" border="1"
|+align="bottom" style="color:#e76700;"|''Legend''
|-
|style="background-color:#5BFAFA;"|'' ''
|To be Approved
|-
|style="background-color:#a14141;"|'' ''
|Approved as a not bad idea, but needs research
|-
|style="background-color:#ffff00;"|'' ''
|Rejected
|-
|style="background-color:#41a141;"|'' ''
|Claimed (Implementing)
|-
|style="background-color:#4141a1;"|'' ''
|SVN (Implemented, and going to be in the release)
|-
|style="background-color:transparent;"|'' ''
|Maybe but there are issues
|}

{| cellpadding="2" cellspacing="1" border="1" width="100%"
|- style="background-color:#ffff88;"
!Name
!+/-
!Status
!Use
|-
|Omega Flag (OF)
| +
|style="background-color:#ffff00;"|''Not really fair to those without the flag, and technical aspects of BZFlag don't allow flags to spawn out-of-bounds''
|In game description: Flag with vast power that only spawns out-of-bounds.

Development description: Combines the effects of Wings, Ricochet, Guided Missile, Tiny, Laser, Super Bullet, Rapid Fire, Stealth, Cloaking, Oscillation Overthruster, Phantom Zone, Shield, Low Gravity, Mass Driver, Seer, Shock Wave, and Invisible Bullet. Meaning, it makes you undetectable save for Seer and effects, only drops the flag when you're shot, lets you rapidly fire a guided laser that goes through walls, ricochets off the outside wall, is invisible on radar and creates a shock wave where it hits, and lets you see through other disguises. However, this omega doomsday flag only spawns out-of-bounds by default, unless the server is configured to spawn it in a certain location (past an army of server-side bots, perhaps?) so it is only available to those capable of the /flag command or getting through whatever guards it. I know this flag is WAY overpowered, but that's the point.

|-
|Another Dimension (AD)
| +
|style="background-color:#ffff00;"|''Confusing, especially for new players; just kill the player.''
|In game description: Lock on with right click, and hit to send target to another dimension.

Development description: The projectile looks like a normal shot, but it's guided, goes through walls and has infinite range. One shot only. If it hits (it can be blocked with the outside wall) it will teleport the target to a maze world map that is installed to the hard drive with the client. (Score is not affected by this flag.) This sub-map is very large, but can be exited by entering a teleporter, dying, or leaving. The point at which the target enters the maze is random, and perhaps the positions of the teleporters out are variable also.

|-
|No Vertical velocity (NV)
| -
| style="background-color:#5BFAFA;"| '' ''
|Shots will not keep Vertical Velocity.

|-
|Ammo (AM)
| +
| style="background-color:#5BFAFA;"| '' ''
|You will gain 1 shot for every 4 shots you have. You start with one shot gained.

|-
|Vertical Velocity (VV)
| +
| style="background-color:#5BFAFA;"| '' ''
|Your shots will keep vertical velocity.

|-
|No Ricochet (NR)
| -
| style="background-color:#5BFAFA;"| '' ''
|Your shots don't bounce off objects that they would normally bounce off of.

|-
|Low Jump
| +/-
| style="background-color:#5BFAFA;"| '' ''
|Tank won't jump to full height. Blessing and a curse; less time in the air is good in combat but tank can't reach areas designed for normal jumps.
|-
|Long Range (LR)
| +
| style="background-color:#5bfafa;"|'' ''
|If your bullets hit tanks within a short distance, they do not kill, but can kill at a long distance 2x the server-set distance
|-

|-
|Punch Bullet (PB)
| +
| style="background-color:#5bfafa;"|'' ''
|If your bullets hit tanks they are thrown some distance away in the direction of the bullet
|-
|-
|Subtle Tankochet (SA)
| +
| style="background-color:#5bfafa;"|'' ''
|Like Tankochet flag below (bullets bounce off you) but for every bullet that bounces off you you lose a point and you die when you drop the flag (if you have been shot already)
|-
|-
|Bouncy Tank (BT)
| +
| style="background-color:#5bfafa;"|'' ''
|In-game description: Your tank bounces off of walls!
Description here: When you touch a wall or building, your tank will bounce off of it. This could make it easier to dodge. The server could possibly decide how much you bounce, or the angle and speed at which you hit the wall or building. --Data
|-
|Disable (DA)
| -
| style="background-color:#5bfafa;"|'' ''
|In-game description: Shots travel faster and further, but only temporarily disables targets.
Description here: Increased reload speed (say, same as Rapid Fire) and perhaps also increased range (devs should determine best balance); shots have a different colour (much darker, or maybe even an "electric charge" crackle). On the other hand, hits don't actually kill, but only disables the target for some seconds (perhaps by server variable). Useful to freeze groups of enemies for instance during base invasion, but requires other team mates to actually finish the job. Shooting a disabled tank works as normal (that is, the shooter gets the point and the Disable-carrying tank gets nothing). /KlaymenDK
|-
|No Shooting (NS)
| -
| style="background-color:#5bfafa;"|'' ''
|In-game description: Can't shoot. Stay out of trouble!
Description here: Pretty much as it says in the in-game description. You can't shoot. How you would be able to get rid of it in those "kill to get rid of bad flag" servers I'm not entirely sure.
|-
|Short Shot (SS)
| -
| style="background-color:#5bfafa;"|'' ''
|In-game description: Shots don't go as far. Stay in the fray!
Description here: Not as limited as the No Shooting flag, this shortens how far your shots go before dissipating. Speed stays the same.
|-
|Long Shot (LS)
| +
| style="background-color:#5bfafa;"|'' ''
|In-game description: Shots go farther. Snipe from a distance!
Description here: The inverse of the Short Shot flag, your shot speed will stay the same but it'll remain on the field longer.
|-
|AfterBurner (AB)

or

Rocket Jam (RJ)
| -
|style="background-color:#5bfafa;"|'' ''
|In-game description: Tank can't stop going forwards at high speed. Don't hesitate!

Description here: On pickup (or perhaps after first forward movement) tank instantly starts going forwards (only, no reverse) at high-speed (or faster?). Left/Right turning is still normal. (Perhaps reduced turning circle?)

Makes it easy to crash into walls. Getting stuck in a corner will make you an easy target. However, an alert player could probably hold out with this for long enough to make it quite fun.
|-
|Temporary Shield (TS)
|
| style="background-color:#5bfafa;"|'' ''
|In-game description: Trigger a temporary shield. Be careful not to hold on too long!
Description here: Akin to the shield on the old Atari 2600/coin-op [http://www.atariage.com/manual_html_page.html?SoftwareID=828 Asteroids] game. "Fire" triggers shield, which remains in place until released, but enabling shield for too long (A short "reload" threshold, 2 seconds?) results in self-destruction. Shots at shielded player could be any of: ''pass-through'', ''absorb'', or ''deflect'' -- although the first one is more true to the original concept.

'''Other notes:'''
* Suggested limit of 3-5 uses per flag, although this would be set per-server.
* This is an implicitly defensive flag -- there's no weaponry when using it -- but could be well suited for advancing a front in a CTF, etc.
|-
|Low Ammo (LA)
| -
|style="background-color:#5bfafa;"|'' ''
|Description: You will have half of the ammo you originally had. If odd round up with maybe a little longer reload time.
|-
|Safe Thief (ST)
|
|style="background-color:#5bfafa;"|'' ''
|In-game description: Front and rear shots.

Description here: Shots only go go 1/4 distance of normal shot, can only be killed with thief, SW, & SB, any tank that touches you dies and you get their flag, if they don't have a flag; you still drop your flag.

|-
|Front+Rear fire (FR)
|
|style="background-color:#5bfafa;"|'' ''
|In-game description: Front and rear shots.

Description here: Fires the default fire and additionally fires at the same time rear-shots.
|-
|No Ricochet (NR)
| -
|style="background-color:#5bfafa;"|'' ''
|In-game description: Shots don't ricochet.

Description here: Like the Jamming and No Jumping flags in maps that have radar and jumping enabled by default, this flag disables the ricochet ability in maps where ricochet is normally enabled.
|-
|Long SB (LSB)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Shoot through building, infinite range, long reload time

Description here: SB-- range and speed of L, 2.5 times reload time of normal SB.
|-
|Radar (RD)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Can use radar.

Description here: Like how in some maps that have jumping flags or ricochet flags when those things are normally disabled, in maps with radar disabled, this would give you radar ability. It would counteract the Jamming flag in normal maps.
|-
|Sticky Jump (SJ)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Stick to ceeling.

Description here: When you jump when you are under a building, your tank 'sticks' to the ceeling. Pressing jump again would cause you to end up on the top of the building. When a tank is stuck to the ceelimg, it would be incincible to L; and have a form of GM that had 1/4 the range and only locked-on to targets below.
|-
|Flat (FL)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Tank is flat from sides, but normal size from front and back. Can hide against walls.

Description here: Like Narrow but the forward-backward dimension is where you are flat instead of the left-right dimension if you understand.
|-
|Signal Decoder (SD)/Transmission Interceptor (TI)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Listen to all messages.

Description here: Any message sent on the server, even ones to a team or individual tank, are picked up. In the case of private messages, it will appear as [SendingTank->IntendedRecipient]. Also, commands show up, such as /set, /me, or /say, as well as their results. Good for detecting enemy strategies.
|-
|Carbonite Missile (CM)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Shoots a guided missile that slows down tanks near where it detonates. Can kill only with a direct hit.

Description here: The missile is similar to the missile from GM, but it's light blue and has different variables to control its movement speed/turn speed. When it hits something or times out, it creates a light blue shockwave-looking pulse that may leave residual graphical effects in the vicinity and/or on tanks in the area. Instead of doing damage, this pulse temporarily slows down the tanks it hits; the duration of the slowdown is the same as the duration of the residual graphical effects mentioned above. The time that the tanks are slowed down, as well as the degree of the slowdown and the degree of reduction to turning capability (it can slow turning too) are all server variables. There should also be a brief time between shots, and/or an increase in reload time.
|-
|Pulse/Plasma Cannon (PC)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Fires a burst of plasma capable of shaking buildings. Can kill Phantom Zone.

Description here: Shoots a large, wave-like shot that is bigger and slower than normal shots. Alternately, two shots spiraling around each other. Either way, it hovers in front of you for a short time before going forward, and during that time you cannot fire. If it hits a building, all tanks inside that building via OO or PZ are killed, all shots inside it (such as SB or PZ) are disintegrated, all tanks touching the sides bounce away, and all tanks on top briefly are forced to jump rapidly, like on a trampoline that has a very low jump height.
|-
|Mass Driver (MD)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Fires a fast bullet that can go through multiple targets and shields. No ricochet.

Description here: The bullet moves about twice as fast as a normal bullet, and has 1.5x range by default, and corresponding reduction in reload time. It kills shielded tanks, and keeps going if it hits a tank to hit other tanks. However, it never ricochets.

Possible addition: A server variable (binary/true or false/trinary) sets whether it shoots one shot from the tank's barrel, one shot alternating between left and right of the tank, or two shots from the left and right of the tank at once, in reference to the Canderous-class Assault Tank from Star Wars: Empire at War: Forces of Corruption.
|-
|Shield (SH)
| +
|style="background-color:#5bfafa;"|'' ''
|Description: It's an idea for the improvement of Shield, not a new flag entirely. The idea is that if a person with Shield is hit, they are briefly invincible, and possibly flicker and/or be unable to shoot. This would really help; I remember numerous times when I was hit while equipped with Shield, and was immediately killed anyway because the other guy launched a cluster of shots.
|-
|Score Drain (SD)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Drains score continuously. Does not kill.

Description here: Shoots a normal bullet with a line (laser sprite) between it and the user tank. When it hits someone, the line attaches to them instead. The bullet vanishes. Then score goes continuously from the tank with higher score to the one with the lower score at a speed determined by the size of the difference of the scores (the larger the difference, the faster the score drains, and obviously it slows down as time passes) as well as server variables; it stops draining when the scores are equal. The tanks have full freedom of movement, but if they get out of range of each other ("range" being the range of a standard shot), or something (either a wall or a tank) gets between them, the line will disappear and the drainage will stop. The tank firing can only have one line out at once, even if it hasn't hit something yet. The range is reduced if the firing tank moves backward or to the side; the line cannot be longer than the range of a shot.
|-
|ShotGun (SG)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Shoots a large bullet that explodes into smaller ones on contact.

Description here: What this does is shoots a single abnormally large shot using all of your shots. It has reduced range and speed and does not ricochet. When it hits anything, it does not do damage; it releases as many bullets as you have shots; they fly in random directions and are normal range. Server variables control whether they go out in set angles or random, and if they go at random/set/no vertical angles. Note that the big shot does NOT do damage directly; it explodes on contact, but does not kill, but the target usually dies from bursts.
|-
|Basic Invulnerability (BI)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Immune to normal shots[ and shots from Rogues]. Any altered shot[ from a team] can kill. [Can't kill Rogues.]

Description here: It's immunity to normal shots. ANY other shot, be it GM, SW, from PZ, or even RF, MG, or even ricochet in a non-ricochet map, (but not Burrow, Wings, or vertical velocity shots or similar) can kill the user. This is designed to counter non-shot flag users, non-flag users, and rogues. Some binary switch on the server makes the stuff in [] square brackets appear and immunity to rogues take effect.
|-
|Fog Shield (FS)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Creates fog nearby for decreased visibility nearby and deflection of Shock Wave and Super Bullet.

Description here: A sphere with extremely thick gray fog. If Super Bullet hits it will bounce off; if Shock Wave hits it the shock wave will cease to exist in the area or bounce off or just totally disappear. Designed as a counter for Shock Wave and Super Bullet.
|-
|Cloaking Shield (CS)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Causes everything non-permanent nearby to be invisible out-the-window; still visible on radar and Phantom Zone. Blocks OO, PZ, and Laser.

Description here: The in-game description is pretty effective. It generates a sphere of tank and shot invisibility that blocks Oscillation Overthruster, Phantom Zone, and Laser, and is specifically designed to counter Laser. The downside is the double-blindness of those in the shield; they can't see tanks or shots out-the-window. Radius defined by /set variable.
|-
|RepulsorLift (RL)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Tank floats over the ground. Immune to steamroller. Good for avoiding burrowers and climbing stairs or ramps.

Description here: The tank will lose its treads for a wider hull, hover in the air, and appear to be constantly activating its jump thrusters. If possible, also make it so it moves up and down. Due to this, it is over the heads of those tanks that use burrow, and it can't steamroll them; it can't be shot by them either, but it may be able to shoot them with vertical velocity shots and the up-down automatic movement, and if it jumps and gets close to the ground as it lands. It can change direction in midair, and go up ramps of steepness less than a value (in degrees) defined at the server. Also, it's immune to steamrollering because it floats; it can possibly be squished (if you decide to implement it) only by landing directly on it. Can't multi-jump.
|-
|Jamming Shield (JS)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Jams radar, communications, and guided missiles nearby.

Description here: Within a radius around the tank, no tank (not even allies or the user) can see on radar. Within this area, communications do not exist; if someone (except the server or observers, or using a non-/me command) says something, no tank in the area will hear it; and if one within the field chats, no one will hear it (except observers and loggers). Projectiles that can be guided (even when not guided as they enter the field) within the field will constantly lock on to random points and therefore be ineffective; but if they leave the field, they will return to their original targeting; if they weren't guided, they will just go straight.
|-
|Point Defense (PD)
| +
|style="background-color:#5bfafa;"|'' ''
|In-game description: Automatically shoots down incoming missiles.

Description here: When a missile that has a lock (any team's missile, even allied, but not ones fired without locking on first) gets within a certain range of the tank, a laser shoots from the tank (preferably from the top of the tank, under the flag, but if that's too hard to implement, from the main muzzle) to the missile for exactly one frame and destroys the missile. There is a brief reload time between shots, say about double the reload time of MG. This flag is the perfect counter-flag to GM. And don't say Stealth is the counter to GM; it's NOT, it's only as effective against GM as anything else.
|-
|AirStrike (AS)
| +
|style="background-color:#transparent;"|'' Too complex and confusing for players, too powerful ''
|Lock onto a player using right click; firing drops a bullet from the sky onto target. Similar to GM, but useful against people who camp on towers and can't be hit by normal means. (dim3wit)
|-
|Shoot Different (SD)
| -
|style="background-color:#5bfafa;"|'' ''
|Your tank leaves a "trail" behind about 20 world units long that, if shot, will result in your tank being destroyed by the next shot that travels over the trail. If any tank runs over the trail you will also die. The trail is not visible, but emits a glow that is seen around the borders. The trail is the same width as the tank. When you shoot a tank, it results in that tank killing you. I don’t think you’d want to get this flag because it is BAD, which means you can’t drop it.
|-
|Bad Thief (BT)
| +
|style="background-color:#5bfafa;"|'' ''
|When you shoot a tank with this flag, the flag is transferred to that tank while a random flag (including bad flags) is transferred to you. If you don’t shoot someone in 1 minute, you die. You can only be killed by SB, L, SW, and GM with this flag.
|-
|Evil Tunneler (ET) (mind the abbreviation)
| +
|style="background-color:#5bfafa;"|'' ''
|With this flag, you tunnel completely under the ground and you can go up or down as well by pressing V or C, respectively. When you pick up the flag, you go below the ground to a default 50 world units and generates a 100 world units force field for 3 seconds that allows you to go below safely. Your shots travel straight up and if you are in a position that lets your shot travel above the ground (your shots underground have the same range as a regular bullet), you can shoot, and your shots travel straight upwards at a velocity equal to that of a normal bullet, pausing 20 world units above the ground or building it passes through, then traveling downwards at a speed equal to a Burrow tank going forward, and expiring when it hits the ground. You can’t be steamrolled while you have this flag but if a SB or L passes above you at any altitude you die. You can be shot by other ET tanks, if their shots pass within 10 world units of you, you die, and when a GM is fired within 100 world units of you, it goes underground towards you and expires normally, however, if that explodes below any tank, including teammates they die. Your shots show up on radar but they appear a stationery dot with altitude, if the altitude is below ground the entire square is colored purple or some other color like that. You cannot kill PZ or tanks with Wings. The maximum depth you can descend to is 3000 world units, so if you go any lower, you self-destruct. The maximum altitude (literally) you can reach is the same as a burrow tank and in that altitude you can be steamrolled, and as long as your muzzle is above ground you fire normal shots and can be steamrolled. PZ tanks can steamroll you at any altitude. When your shots expire, they explode in a cloud that tags all tanks caught in it with a 20-second time bomb and when the time’s up, the points go to you but only ½ rounded to the nearest even number, excluding 1. You can only fire half the shots allowed between reloads but reload is ½ server set time. Your tank controls are normal and normal speed. When you jump you go downwards instead of up at the server-set jump height, except reversed.
|-
|Ghost (GH)
| +/-
|style="background-color:#transparent;"|'' no flag combos ''
|Combines Stealth and Cloak, but the player who picks up this flag will die in around 20-30 seconds, even if he drops the flag. Only useful if applied well. (dim3wit)
|-
|Shot Shockwave (SS)
| +
|style="background-color:#5bfafa;"|'' ''
|Like SP, but you can only have one shot.
|-

|Dangerous Debris (DD)
| +
|style="background-color:#5bfafa;"|'' ''
|When you shoot a tank, their “debris” destroys all tanks they touch on the ground or in the air.
|-

|RaDiation (RD)
| +
|style="background-color:#5bfafa;"|'' ''
|For 10 seconds, your tank emits a “radiation” that kills all tanks within a 5 world unit radius.
|-

|Wind Shot (WS)
| +
|style="background-color:#5bfafa;"|'' ''
|Your shots deflect away from enemies when you have this flag. You cannot be shot by regular shots with this flag, and cannot kill any tanks (except PZ).
|-

|BadBullet (BB)
| -
|style="background-color:#5bfafa;"|
|Your bullets become guided missiles that loop around and hit you, if there are no enemies in the way (if they get hit they die). Does not kill teammates. Goes slow enough for you to outrun but goes through buildings. Has very long range and cannot travel out of the world. Stops after 3 minutes. Has large turning circle and ricochets off world borders and teleporters. Bad flag.
|-
|Jump and Stay (JS)
| +
|style="background-color:#5bfafa;"|
|You jump and when you reach the top of the jump, you stay at that level, but cannot jump further. You can still move and shoot.
|-
|Crazy Color (CC)
| +
|style="background-color:#5bfafa;"|
|Your tank looks like a rogue on the hud, radar and scoreboard, but isn't. Prevents teams from knowing which side you're on. Bad flag.
|-
|CanYon (CY)
| +
|style="background-color:#5bfafa;"|
|Causes a deep gorge to spread in front and behind you, killing all tanks that fall in. Teammates are not affected. You can't shoot while you have this flag.
|-
|Quantum Plane(QP)
| +/-
|style="background-color:#5bfafa;"|'' ''
|Basically the bullet behaves like a quantum, where it starts off like a wave and has multiple locations, has the capability of tunneling through boundaries, and when encountered by a tank collapses into a particle resulting in that tank collapsing into a reality where that tank may or may not be killed (like Schrödinger's Cat). When a tank shoots, the shot does not have a specific location, but rather a probability distribution along a plane parallel to the ground at the same altitude the shot was made. This "quantum plane" would have the same color as a bullet, however it would be brighter and more opaque where the probability of the bullet's location is higher, and more translucent and not as bright where the probability is less, in other words it would look like a flat electron cloud. The Bullet would have zero probability of being in an object, so OO tanks are safe, however the bullet can be inside hollow areas closed off from the area where the tank shot the bullet (i.e. rooms), this allows for quantum tunneling. The probability distribution is determined by the boundaries formed from the cross section of the map in the quantum plane, in other words the wave has to be a standing wave that resonates within the boundaries, thus the particular probability distribution would be found by a partial differential equation. When a tank intersects the plane, the probability of that tank being hit by the bullet is calculated by a double integral, where the tank's cross section is the boundary. Then a random number generator determines if that tank is shot or not shot, and the chances of either way is determined by the the tank's probability of being shot. Once it is determined either way, that particular plane collapses for the tank that intersected with it, thus the plane does not affect that particular tank anymore nor does that tank see it, so to that tank the plane doesn't exist anymore, however it can still affect other tanks that have not collapsed the wave function. The Quantum Plane exists until all the tanks intersect with it, or until it expires after the amount of time it takes to reload a regular bullet. It is possible for more than one tank to be killed by the same Quantum Plane, however it is also possible for the QP holder's teamates and even the QP holder itself to be killed. In fact as soon as the QP holder fires, it collapses the Quantum Plane in its perspective, because the holder automatically intersects with the plane.
|-
|Teleport Shot
| +
|style="background-color:#5BFAFA;"|''No, no on drop flags, and too complex
UPDATE: It's not on-drop, it means that only one shot is allowed. I clarified the description.''
|You can only shoot one shot with this flag. When your shot expires, you appear where it expired. Shots don't kill.
|-
|Flame Thrower (FT)
| +
|
|Firing a shot emits a short length of flame, which never ricochets. It should get wider as it leaves the barrel, have a duration of half a second or so and have a long reload time. If it could "snake" as the turret turns, even better! There should be a new sound to accompany the firing and some nice graphics for the flame.
|-
|Flag Drop (FD)
| +
|
|Firing causes all tanks nearby to drop their flags. Cannot kill with this flag.
|-
|Cloaked Shot (CS)
| +
|style="background-color:#4141a1;"|''Yes, done in 2.99''
|Shots are invisible out-the-window. Still visible on radar. Glow is still visible out HUD. Watch out for ricochet!
|-
|Unsteady (US)
| -
|style="background-color:#5bfafa;"|'' ''
|When jumping, the tank gets a random angular momentum, like you accidently moved your move while pressing jump.

''(This is a resubmit: I submitted this flag along with others quite some time ago, but, unlike the others, this just vanished from the Wiki)''
|-
|SPinner (SP)
| -
|style="background-color:#5BFAFA;"|'' ''
|If you turn when you have this flag you can't stop turning. Optional: If you leave the tank turning it slowly gets faster and faster, but probably only to a set speed otherwise it would get too fast.
|-
|Blink (BK)
| +
|style="background-color:#ffff00;"|'' complex, pick one ''
|Player alternates from stealth to cloak. Radar signature alternates from stealth to cloak. Player with flag is always visible either in window or radar. If a bad flag, player alternates from blindness and jamming for limited time.
|-
|Blink (BK)
| -
|style="background-color:#ffff00;"|'' mean ''
|If a bad flag, player alternates from blindness and jamming for limited time. Primary preference is to use blink as super flag described above.
|-
|Tankochet
|
|style="background-color:#ffff00;"|'' just a super shield, too powerfull ''
|bullets ricochet off your tank for a limited time
|-
|False Enemy (FE)
|
|style="background-color:#5BFAFA;"|'' ''
|The opposite of MQ; when you pick up this flag, your teammates see you as from another team.
|-
|Campers Bullet (CP)
| +
|style="background-color:#ffff00;"|'' to specific''
|Shots go through teleporters, without actually teleporting. Useful for hiding behind a teleporter and shooting through it, while being shielded by the teleporter.
|-
|Black Hole (BH)
| +
|style="background-color:#ffff00;"|'' too complex ''
|Your shots move slowly, shots within half a shockwave radius of yours aim towards yours, (double maximum turn/frame of guided missile,) your shots absorb any shots that hit them to increase their range. Black holes either can't absorb each other or if they collide, they instantly kill all tanks, including the shooter(s).
|-
|GalaGa (GG)
| +
|style="background-color:#ffff00;"|'' lame ''
|When this flag is held, your tank becomes 1.5 (to 2) times wider. However, you are able to shoot two bullets at the cost of one (like a dual fighter in Galaga).
|-
|Dome of Protection (DP)
| +
|style="background-color:#ffff00;"|'' shield''
|Similar to SW, but instead the "shell" is a protective dome. All shots are simply absorbed or, if there is richochet, bounce off it. It can only be penetrated by SB and SW. Note: when the flag is held the player cannot fire normal shots. They can still fight by making the shots bounce back at them.
|-
|Ricochet Guided missile (RG)
| +
|style="background-color:#ffff00;"|''combo flag.''
|Instead of exploding, the RG bounces off of surfaces and continues to track the target. Option 1: It loses velocity with each bounce. Option 2: When the RG bounces, it travels in a straight line for a certain distance before regaining lock. EDIT: Perhaps we keep it as a simple ricochet, without any lock loss. The GM keeps lock, it' just takes longer to get there.
|-
|NearSight (NS)
| -
|style="background-color:#ffff00;"|''complex''
|All tanks farther than (variable defined) world units are completely invisible on HUD. The closer they are to the player, the more visible they become. Similar to an invisible fog, does NOT effect buildings. Gives enemies a long-range advantage.
|-
|Long Shot (LS)
| +
|style="background-color:transparent;"|''Maybe, not a bad idea.''
|Bullets go twice as far but at a slower speed. Possibly N/2 extra bullets.\
|-
|Low Gravity(LG)
| +
|style="background-color:#4141a1;"|''Yes, done in 2.99''
|Gravity is reduced to a large degree allowing the tank to jump very high in the air.
|-
|Long Reload (LR)
| -
|style="background-color:#a14141;"|''Yes.''
|Reloading weapon takes twice as long.
|-
|Don't Stop (DS)
| -
|style="background-color:#a14141;"|''Yes.''
|Tank always moves forward or backwards, it cannot stop.
|-
|BackFire (BF)
| +/-
|style="background-color:#a14141;"|''Yes.''
|Shots fire to rear of tank instead of front.
|-
|FrienDly fire (FD)
| +
|style="background-color:#ffff00;"|''no, a server mode.''
|Your shots don't kill friendly tanks (Your own ricochets are harmless!).
[Additional suggestions: immune to friendly shots? This can also be a server-side setting, like ricochet.]
|-
|Sensor Echo (SE)
| -
|style="background-color:#a14141;"|''Maybe, not a bad idea.''
|All tanks show up twice (or more) on radar. Echoes behave like the tank they mirror, down to the flag.
|-
|Delayed Shot (DS)
| -
|style="background-color:#a14141;"|''Yes.''
|Shots wait some prescribed amount of time (2 seconds?) between clicking and actually firing.
|-
|Extra Shot (ES)
| +
|style="background-color:#a14141;"|''Yes.''
|Player gets an extra shot.
|-
|SlowMotion (SM)
| -
|style="background-color:#a14141;"|''Yes.''
|Tank moves and turns with half speed.
|-
|INcoming (IN)
| +
|style="background-color:#ffff00;"|''No, it's very very close to a cheat.''
|Bullets that will hit the tank are highlighted on radar/main view in some fashion as a warning system.
|-
|Flip Out (FO)
| -
|style="background-color:#ffff00;"|''No not really different from reverse controls.''
|Out of window view is upside-down.
|-
|EarthQuake (EQ)
| +
|style="background-color:#ffff00;"|''No, same as using a shockwave on landing.''
|When landing after a jump, a shockwave will destroy tanks on the ground in the immediate vicinity of the landing tank.
|-
|DeFender (DF)
| +
|style="background-color:#ffff00;"|''No, too confusing for players.''
|Fires a short-range shot that projects a miniature shockwave to destroy enemy shots.
|-
|Retro (RE)
| -
|style="background-color:#ffff00;"|''No, doesn't do ANYTHING''
|View becomes green wireframe and otherwise looks like the [http://en.wikipedia.org/wiki/Battlezone original Battlezone].
|-
|Velocity Shooting (VS)
| -
|style="background-color:#ffff00;"|''No, is a server option, not to be mixed for some players and not others.''
|Shots keep Vertical-Velocity (as its set on some Servers for all players). If you jump; shots go up and when you fall; shots aim downward.
|-
|SQuishable (SQ)
| -
|style="background-color:#ffff00;"|''No, too confusing for players.''
|The opposite of Steamroller. When you touch other tanks (including teammates), you die.
|-
|Judas (JD)
| -
|style="background-color:#ffff00;"|''No, too confusing for players.''
|When you pick up the flag, you immediately become a player on a different (random) team (or rogue). You must play on that team for as long as you have the flag. If you kill one of your new teammates, you die. BUT you can kill your old teammates for as long as you hold the flag. When you drop the flag or are killed, you revert to your old color.
|-
|ANtagonize(AN)
| -
|style="background-color:#ffff00;"|''No, can not be localized easily, and may anger people.''
|This bad flag causes your tank to automatically send out mild insults and taunts to opposing players. Especially the good ones by name.
|-
|CoW launcher (CW)
| -
|style="background-color:#ffff00;"|''No, would require vertical aiming to work properly.''
|(Goofy) Launches a cow along a parabolic trajectory.
|-
|ConFusion (CF)
| -
|style="background-color:#ffff00;"|''No, too similar to CB.''
|Tank colors and names are shuffled around. Like colorblindness, but worse.
|-
|ShowOff(SO)
| +
|style="background-color:#ffff00;"|''No, basically useless in gameplay.''
|(Goofy) Tank is capable of doing tricks, back flips when jumping, riding on one tread, etc.
|-
|Leash(LE)
| -
|style="background-color:#ffff00;"|''No, too confusing for players.''
|Tank is confined to a small radius for a set time period but can still jump.
|-
|BUckler (BU)
| +
|style="background-color:#ffff00;"|''No, shield is enough.''
|Give the player a 45 degree shield that reflects all shots. It should be located in the arc between 270-315 degrees. The shielded area should be visible but transparent.
|-
|PSychic (PS)
| +
|style="background-color:#ffff00;"|''No, too powerful and makes ID pointless.''
|Callsigns and flag names of all (visible?) tanks appear above the tank.
|-
|Full Reverse(FR)
| +
|style="background-color:#ffff00;"|''No, too similar to HS and too limited in scope.''
|Your tank can move full speed in reverse. A middle ground between high speed and normal.
|-
|All Terrain (AT)
| +
|style="background-color:#ffff00;"|''No slopes, never. No.''
|Can drive over slopes and pyramids, (unless steeper than 45?) and perhaps up walls too.
|-
|Tac Nuke (TN)
| +
|style="background-color:#ffff00;"|''No too powerful.''
|On impact with any surface or tank, causes TN to detonate like a half-size SW. Option 1: TN has long reload time or is a single shot flag. Option 2: TN has an "arming" range where it cannot detonate until it passes out of that range. This range can be equal to 1/2 the blast radius or some arbitrary number. Option 3: If the TN hits a tank with a Shield flag, it is neutralized.
|-
|Glue Trail (GT)
| +
|style="background-color:#ffff00;"|''No, too confusing for players.''
|Leaves a trail that slows down other tanks behind it. fades after server-set number of seconds?
|-
|Oil Slick (OS)
| +
|style="background-color:#ffff00;"|''No, too confusing for players.''
|Leaves a trail that makes tanks behind skid/spin. Fades after server-set number of seconds?
|-
|Petrificus Totalus (PT)
| -
|style="background-color:#ffff00;"|''No, too confusing for players, and rather lame.''
|Paralyzes tank. Cannot move, turn or shoot for set number of seconds.
|-
|Toy Gun (TG)
| -
|style="background-color:#ffff00;"|''No, pointless in game play, just use the Useless flag.''
|When you shoot,the bullet that comes out is a fake bullet attached to a string which is attached to your tank.
|-
|Icy Treads (IT)
| -
|style="background-color:#ffff00;"|''No, just like momentum.''
|Tank loses traction on the ground and on all objects, as if the friction setting was lowered for that particular tank.
|-
|ParaChute (PC)
| +
|style="background-color:#ffff00;"|''No, just like Wings.''
|You can control your tank ONLY when falling down and you fall down slower.
|-
|ToRnado (TR)
| -
|style="background-color:#ffff00;"|''No, too confusing for players.''
|You jump and spin uncontrollably.
|-
|GhostS (GS)/SPawn (SP)
| +
|style="background-color:#ffff00;"|''No, FAR too complex.''
|2 or 3 mini bot tanks come out of your tanks and help you by providing cover ect. They die by being shot or after a certain period of time (45 secs?).
|-
|Death Ball (DB)
| +
|style="background-color:#ffff00;"|''No, FAR too complex.''
|Tank morphs into a Death Ball and kills anyone who touches it. Faster than a normal tanks. Can be killed by being shot 5 times. You can't jump.
|-
|DiG (DG)
| +/-
|style="background-color:#ffff00;"|''No, too similar to burrow.''
|Your tank goes completely underground upon picking up the flag, and you may then shoot up at tanks above you. Anybody may lock on you (as with GM) if they hold GM, SB, or even no flag. You are also in range of SW. Bullets will follow you underground.
|-
|RaM (RM)
| +
|style="background-color:#ffff00;"|''No, too poweful and complex.''
|Tank travels at normal speed unless you fire. Firing causes your tank to accelerate forward quickly and only for a certain range. When you touch another tank, it has Steamroller effect, causing them to explode.
|-
|Auto Teleport (AT)
| +
|style="background-color:#ffff00;"|''No, too complex, too powerful, and looks too much like a cheat.''
|With this flag a player can teleport to any place visible place on the radar by clicking the desired area on the radar. Only one teleport can be done per flag, otherwise you would be impossible to kill. Another way to make it harder is to put a reload time on it, so there would be at least some pause between teleports. If you teleport to an area occupied by a building, you go to the highest place on the specified area of the building.
|-
|Ice Laser (IL)
| +
|style="background-color:#ffff00;"|''No, too confusing for players, just kill them.''
|This laser does not kill players. Instead, it freezes them. They can't move, jump, or shoot, for 10 seconds. Players who are shot by normal bullets while they are frozen become unfrozen. When a tank is frozen, the tank becomes white, preventing other players from knowing which team the frozen tank is on.
|-
|Kamakazi Attack (KA)
| +/-
|style="background-color:#ffff00;"|''No, too confusing for players.''
|This can be a good and a bad flag. When picked up, starts a self-destruct timer, that, when runs out, will blow you up. But if the right button is pressed before the time is up, then you blow up on the click. This can be use to kill multiple tanks, and can also be used in mid-air. Moderate blast-radius?
|-
|Swallow Tanks (SW)
| +
|style="background-color:#ffff00;"|''No, far too confusing.''
|(GOOFY) If you touch another tank it disappears and becomes an observer to your tank. The more tanks you swallow the more obese you become. You can only swallow a limit of 3 tanks at a time, if you swallow more you pop. If you are killed all of the tanks you are carrying are set free. The tanks jump as they are set free to avoid multiple shots that may have been fired at the original tank. Swallow your own teammates and carry them deep into enemy territory!
|-
|Electricity Bolt (EB)
| +
|style="background-color:#ffff00;"|''No, far too powerful and confusing.''
|Looks like thief shot when fired (Short range weapon) only when it hits a structure it kills everyone on it or touching it (or in it, players with OO). This would be handy for killing tanks sitting in hard to get to places!
|-
|Invisible Objects (IO)
| -
|style="background-color:#ffff00;"|''Maybe.''
|All surface objects (pyramids, boxes, etc.) become invisible.
|-
|Meatloaf Launcher(ML)
| -
|style="background-color:#ffff00;"|''Just move forward while jumping, unrelated name.''
|Jumping propels your tank not only upwards but forwards as well.
|-
|Bent Turret (BT)
| -/+
|style="background-color:#ffff00;"|''Maybe.''
|All shots go out 30 degrees to the left/right (than a normal shot). Some people might call this a super flag because it helps dodging.
|-
|Tiny Bullet (TB)
| -
|style="background-color:#ffff00;"|''Perhaps.''
|This bad flag causes your the bullets to shrink, making them hard for you to hit your opponent.
|-
|Missle Jammer (MJ)
| +
|style="background-color:#ffff00;"|''Maybe.''
|Prevents a GM lock on your tank. You can still be killed by normal shots, or unlocked shots.
|-
|Score Flags (SF)
| +
|style="background-color:#a14141;"|''Maybe, a multi-player isn't a bad idea.''
|Gives you more than one point for each kill. Maybe randomize between 2 and 5 points. (This could also be used as a handicap for beginners)
|-
|NearSight (NS)
| -
|style="background-color:#ffff00;"|''Maybe, not too game breaking, but not relay that exciting.''
|All tanks farther than (variable defined) world units are completely invisible on HUD. The closer they are to the player, the more visible they become. Similar to an invisible fog, does NOT effect buildings. Gives enemies a long-range advantage.
|-
|Black Death (BD)
| +/-
|style="background-color:#ffff00;"|''No, far too powerful and confusing''.
|This flag is similar to a team flag only when it is captured it kills all other opposing teams (instead of just one specific team). This would make it so that multiple teams would be competing for one flag. (The color of the flag is black)
|-
|Colored Flag (CF)
| +
|style="background-color:#ffff00;"|''No, would destroy CTF.''
|CTF only flag. Other people see the CF as their own team flag (except own team?)
|-
|Punch (PU)
| +
|style="background-color:#ffff00;"|''No, just kill with steamroller.''
|Hitting a tank at full speed throws it some appreciable distance away
|-
|Remote Mines (RM)
| +
|style="background-color:#ffff00;"|''No, no mines. They will seem to kill players for no reason.''
|Firing places a mine, up to some predefined number. The next shot detonates all of them
|-
|Firewall (FW)
| +
|style="background-color:#ffff00;"|''No, too hard to sync, and somewhat confusing.''
|Firing creates a temporary wall of flame that tanks cannot pass
|-
|Glue Bomb (GB)
| +
|style="background-color:#ffff00;"|''No, too confusing for players.''
|Shot would detonate in a big pile of glue, slowing down people in the blast radius
|-
|Corbomite Device (CD)
| +
|style="background-color:#ffff00;"|''No, too confusing, and hard to sync.''
|When the tank is shot, it generates a reciprocating shot to what killed it - these shots can be dodged normally, in most cases (SW, GM being impossible/difficult)
|-
|Clone (CN)
| +
|style="background-color:#ffff00;"|''No, too confusing and too much like cheats.''
|Tank emits a hologram clone at some offset from itself as a diversion.
|-
|Smoke Screen (SC)
| +
|style="background-color:#ffff00;"|''No, doesn't add much for gameplay.''
|The tank emits a cloud of smoke behind it. This provides a visual wall, and perhaps cancels out GM locks as well.
|-
|Time Lapse (TL)
| -
|style="background-color:#ffff00;"|''No, too similar to blind and jamming combined.''
|Holding this flag will cause the HUD & radar to refresh only every second or so.
|-
|Big Bullet (BB)
| +
|style="background-color:#ffff00;"|''No, too powerful, shots are computed as point hits.''
|Bullets are twice (or more) as large. Tank feels a kick-back when firing
|-
|Gravity Well (GW)
| +
|style="background-color:#ffff00;"|''No, FAR too complex.''
|One-shot fire, creates a gravity well at some distance away from the firing tank. This well pulls in all tanks around it - driving away from the well will slow the descent. Possible avoidance/negation flags include BU, OO, PZ, HS.
|-
|Mirror (MI)
| +
|style="background-color:#ffff00;"|''No, just make CL deflect laser.''
|Holding this flag will reflect a hit by laser. Flag is not dropped after a hit. The appearance of a tank holding this flag changes so that it reflects the surroundings. Or maybe appears pseudo-transparent, rather like the inside of structures viewed with Oscillation Overthruster, or of objects when in the PZ.
|-
|Plasma Ball (PB)
| +
|style="background-color:#ffff00;"|''No, too limited, and just kinda weird.''
|Shoots a large (8 unit) sphere that behaves exactly like a super bullet -- except it travels very, very slowly. It would travel as fast as a burrowed tank going in reverse, thus being easy to outrun in open areas, but hard to avoid on "indoor" maps. Because of the size, it would kill burrowed tanks when fired on the ground.
|-
|Fake Bullets(FB)
| +
|style="background-color:#ffff00;"|''No, too complex, and pointless.''
|1) your bullets look, bounce, show up on radar, and seem real, but they pass right through tanks, causing no damage, and can't harm anyone. This can seem like a bad flag, but would be great to get the other team jumping and running while having zero chance of hitting your own team (and this is how I'd like to use it). 2) Could be made a bad flag that requires you to hold it for a certain amount of time before dropping it. (Would be nice if there were a way to keep a bad flag if you choose.) 3) optional: fire rate is doubled, or unlimited
|-
|BulletInertia(BI)
| +
|style="background-color:#ffff00;"|''No, it's a server setting.''
|When a shot is fired it has the same motion as the tank when it was fired. So if the tank is falling the shots move downward towards the ground, and shots are accelerated or decelerated if the tank is going forward of backward.
|-
|Warp Engine (WE)
| +
|style="background-color:#ffff00;"|''No, FAR too complex.''
|Tank can hit newly-defined "Warp" key (perhaps jump key?) and, with a two-second delay, instantaneously be transported an amount in the direction of facing equal to the current warp power, which starts at a minimum value. Pushing the key during the delay period increases the power; increasing it past a certain amount causes the warp engine to overload and blow up. Warping into buildings or outside the world boundary causes a collision and blows up the tank. (A random chance of being dropped when used, depending on how much power is applied? Use a gradual teleporter fog during the about-to-warp delay? Signal about-to-warpness to the other players by turning the tank gradually bright glowing white? Use a new sound for when the warp occurs?)
|-
|Identify Friend/Foe (FF)
| +
|style="background-color:#ffff00;"|''No, just apply the setting to Masquerade.''
|Masquerade for the radar. Tank shows up for everyone as their team on the radar.
|-
|Rotating Turret (RT)
| +
|style="background-color:#ffff00;"|''No, no turning turrets, ever.''
|Turret can turn. Like GM, you can lock on people, and the turret always fires in their direction (horizontally, not vertically). May need some graphics changes (tank becomes bottom part - tank orientation + top part - turret orientation)
|-
|Boat (BO)
| +
|style="background-color:#ffff00;"|''No, too dependent on map features.''
|Tank floats on water. Moats don't kill you. You move a bit slower on water though. You can still jump on water, but not as high.
|-
|MortarBomb (MB)
| +
|style="background-color:#ffff00;"|''No, requires vertical aim to be any use.''
|Shot has same trajectory as a jump. Vertical velocity alters trajectory. Should be very useful once mastered. Many applications e.g. stop-shoot-go to drop a shot on a pursuer. - FiringSquad
|-
|CriticalMass (CM)
| +/-
|style="background-color:#ffff00;"|''No, this is a server side plugin, not a flag.''
|When killed you explode in a ShockWave (perhaps larger). Tanks with this flag should pulse on your radar. Suicide to kill at close range and dangerous to have near you. Points scored from explosion should accrue to the holder not the killer, otherwise not worth holding onto flag. - FiringSquad
|-
|ShortHop (SH)
| +/-
|style="background-color:#ffff00;"|''No, too similar to jump.''
|Jump is half the normal height and takes half the time. (+) Good for jumping over bullets and regaining control quickly to return fire. (-) Unable to reach everywhere. - FiringSquad
|-
|1000 Tons Weight (TW)
| +/-
|style="background-color:#ffff00;"|''No, just stupid''
|Timer starts as soon as flag as picked up(30 sec timer? Server set?), and user cant drop it. When timer runs out, a 1000 ton weight falls out of the sky killing the owner. When you shoot someone the flag gets transfered over. Player 1 gets TW, 25 seconds go by, he shoots Player 2, then, 5 seconds time, BOOM. Make a nice CLLANNG sound, and tank stops, and other tanks see the weight fall on him. (Punkus)
|-
|Red Eye (RE)
| +/-
|style="background-color:#ffff00;"|''No, too complex and somewhat pointless.''
|First shot causes target tank out-of-window screen to become all white (like a red-eye flash). Out-of-window view stays white for a certain number of seconds (2? 3?). Within that time initial tanks shots are normal, other shooting tank causes white screen again. Radar works as normal, only out-of-window view is affected
|-
|SUbtle (SU)
| +
|style="background-color:#ffff00;"|''No, just use CL''
|Tank appears normal to friendlies - only outline visible to enemies.
|-
|Klingon Cloak (KC)
| +
|style="background-color:#ffff00;"|''No, to powerful.''
|A super cloak, combining stealth and cloak to render you totally invisible to others (though not untouchable). You're not invincible though because, just like with the cloaks used by the Klingons, your tank cannot fire while you have this flag and there is a couple second delay between dropping cloak and being able to fire. Not much for fighting, but great for sneaking up on campers.
|-
|Team Invulnerable(TI)
| +
|style="background-color:#ffff00;"|''No, just use Friendly Fire.''
|Can't be killed by a teammate, except maybe superbullet, genocide.
|-
|TagYourit (TY)
| -
|style="background-color:#ffff00;"|''No, should be a game mode, not a flag.''
|Your tank can't fire and the only way to drop the flag is to get within a certain radius of another tank. The flag is automatically transferred to the other tank.
|-
|SwiM (SM)
| +
|style="background-color:#ffff00;"|''No, too complex.''
|In short: Can get into building. while in building can:
* raise slowly while the jump-key is pressed. fall slowly otherwise.
* get to the almost top of the building. from the top can shoot and be shot - while holding the jump key(otherwise he'll fall-in)
* and can die if the countdown reaches zero. a countdown will be started when he gets to a building, and stopped when he gets out.
|-
|Proximity Drop (PD)
| +
|style="background-color:#ffff00;"|''No, too confusing for the other players.''
|When driving close to opposing tanks (say 3 tank lengths) you cause them to lose their flags.
|-
|Lightning Bolt (LB)
| +
|style="background-color:#ffff00;"|''No, lame munchkin flag. Too limited in use.''
|A lightning bolt descends from the sky and hits the highest object above the tank (possibly passing through everything on it's way down?), destroying people above you. Harmless to your own tank. Effective against tanks with GM sniping from high places. Completely useless against almost everything else.
|-
|ThrUster (TU)
| +
|style="background-color:#ffff00;"|''No, We have Wings.''
|Clicking causes thrusters to fire up underneath your tank. Holding the left mouse button keeps the rockets on (for a time, until they burn out and you plummet to the ground). Landing on other tanks destroys, unless the thrusters used up. Rockets must recharge (especially after being burnt out) like any offensive weapon. A bit like the tank in StarFox64 - yes, I know, sinful console game.
|-
|Ostrich (OS)
| -
|style="background-color:#ffff00;"|''No, we have burrow.''
|(Goofy) Your tank becomes an ostrich. Clicking causes you to bury your head (and the rest of your body) underground, making it impervious to attack for a very short period, but completely unable to move. Any tanks in the way of it diving underground are destroyed. Weak against lasers, because there would be no time to duck.
|-
|LaZarus(LZ)
| +
|style="background-color:#ffff00;"|''No, just use shield.''
|When killed holding this flag, after being exploded your tank magically combines, and you are not dead.
|-
|WaveFront (WF)
| +
|style="background-color:#ffff00;"|''No, just use shockwave.''
|Like shockwave, but only, say, 30 degrees high and wide, but has longer range
|-
|Dud Shot (DS)
| -
|style="background-color:#ffff00;"|''No, it's kinda mean. And you could not shake it on servers with shake kills.''
|Not all of your bullets work
|-
|Death Blossom (DB)
| +
|style="background-color:#ffff00;"|''No, Just use shockwave.''
|Shoots all bullets available in a circular pattern from the tank.
|-
|COlumn(CO)
| +
|style="background-color:#ffff00;"|''No, very limited in use.''
|All of your (currently loaded) shots are fired at once, on top of each other, making a vertical column.
|-
|Sniper Rifle (SR)
| +
|style="background-color:#ffff00;"|''No, just use laser.''
|Your Tank's shots have infinite range, think of the good, and the bad.
|-
|Flash Bang (FB)
| +
|style="background-color:#ffff00;"|''No, redefines too many existing behaviors, and far too complex.
|A few possible implementations. 1) Right-click fires non-lethal shots which travel until a second right-click upon which they explode (similar to SW radius, perhaps bigger) and blind tanks within blast. 2) Could be semi-bad flag where normal shots don't kill but temporarily blind tanks that are hit to allow escape (or kill by teammate). 3) Right click flashes all opponents within line-of-sight of tank w/flag. If tanks are turned such that they can see tank w/flag, they are temporarily blinded.
|-
|Freeze Wave (FW)
| +
|style="background-color:#ffff00;"|''No, just kill them.''
|Similar to Shock Wave, except that instead of destroying other tanks within the shock radius, it freezes other tanks within the freeze radius for a certain time, so they cannot move or fire (even in mid-air). When the other tanks re-awaken, they are immune to freezing for a certain time. Dropping the flag forces a reload time (like Thief). This flag encourages team play. An alternate implementation would freeze yourself if any team tanks get frozen.
|-
|ARchitect(AR)
| +
|style="background-color:#ffff00;"|''No.. Just... No.''
|Your tank can move buildings by driving into them.
|-
|Gravity Bullet (GB)
| +
|style="background-color:#ffff00;"|''No, requires vertical aim to work well.''
|Your bullets are affected by gravity. This obviously reduces the range when fired on the ground, but a tank sitting on a building or jumping has the ability to hit people below them... if they time their shots right.
|-
|RubberTank (RT)
| +
|style="background-color:#ffff00;"|''No, use shield.''
|I'm rubber and you're glue, whatever you shoot bounces off me and kills you! Regular shots ricochet off your tank back in the direction they came, if shooter is still there or close then he gets hit by his own shot. GMs explode without killing or cause rubber damage (flag drop). Super bullet and shock wave kill. Steam roller bounces off you, maybe causing his death or both your flags to drop.
|-
|MagNet (MN)
| -
|style="background-color:#ffff00;"|''No, it's just mean.''
|Bullets are attracted to player's tank.
|-
|Force Field (FF)
| +
|style="background-color:#ffff00;"|''No, Just use Shield.''
|Pushes bullets away. Well aimed shots do not get pushed away
|-
|Boomerang Bullet (BB)
| -
|style="background-color:#ffff00;"|''No, too limiting.''
|Shots move in a curved path that includes the point of firing
|-
|ZigZag (ZZ)
| -
|style="background-color:#ffff00;"|''No, too limiting. ''
|Shots don't fly straight. Instead they fly in a sine wave or a zigzag pattern. Probably no reasonable expectation of hitting what you want.
|-
|FReeze (FR)
| -
|style="background-color:#ffff00;"|''No Too limiting.''
|Tank can't move, only jump and fire.
|-
|Shock Ring (??)
| +
|style="background-color:#ffff00;"|''No, just use shockwave.''
|Shockwave in a horizontal ring pattern
|-
|RemoteControl (RC)
| +
|style="background-color:#ffff00;"|''No.. Just... No.''
|Player can take control of another player's tank, steer and/or fire it, causing the other player to become vulnerable and/or kill himself or others. Offensive and defensive uses, especially if gm or laser campers are around. Automatically dropped after use.
|-
|TransLocate (TL)
| +
|style="background-color:#ffff00;"|''No.. Just... No.''
|Identify a player, then switch places (perhaps N times use)
|-
|Clone (CN)
| +
|style="background-color:#ffff00;"|''No.. Just... No.''
|Takes on the properties of the nearest player's flag
|-
|Lemur mode (LM)
| -
|style="background-color:#ffff00;"|''No.. Just... No.''
|Walk on walls. (maybe parallel to ground only, from however high you touched it, and then jump to get off?)
|-
|Cattle Prod (CP)
| +
|style="background-color:#ffff00;"|''No, Steamroller!?!?!''
|(Goofy) A cattle prod sticks out some fixed distance in front of the bearer's tank. Anyone who touches the prod dies. Clicking while the flag is in effect does nothing.
|-
|MiRage (MR)
| -
|style="background-color:#ffff00;"|''No.. Just... No.''
|Player sees tanks and shots where they shouldn't be.
|-
|Wormhole Bullet(WB)
| -
|style="background-color:#ffff00;"|''No.. Just... No.''
|Bullets that hit other tanks send them to a random link/teleporter instead of killing them. (If there are no teleporters, don't create flags?).
|-
|INflate(IN)
| -
|style="background-color:#ffff00;"|''No.. Just... No.''
|Your bullets cause tiny tanks to become normal sized, normal tanks to become obese, and obese tanks to explode.
|-
|Proximity Fuse (PF)
| +
|style="background-color:#ffff00;"|''No.. Just... No.''
|Shells explode with a small shock wave when they pass within range of a tank (even a friendly one).
|-
|Laser Cloud(LC)
| +
|style="background-color:#ffff00;"|''No.. Just... No.''
|Firing this causes a x amount (x = amount of shots available) of short laser beams to project from the tank, killing all GM, bullets, and tanks they meet. It can aim up and down, and has the range of a Shockwave. Can be over driven by a greater amount of shots than the tank has lasers for. Right clicking causes one single laser beam twice as long as usual, it uses all the shots available, and takes twice as long to recover (optional)
|-
|French Fries (FF)
| -
|style="background-color:#ffff00;"|''No, too complex, kinda lame.''
|(Goofy) Other tanks are attracted to the french fry and will turn to it if they are facing it within 90 degrees.It automatically moves toward it. Other tanks can still turn around (slowly) until it gets out of the magical 90 degrees.
|-
|Time Displacement(TD)
| +
|style="background-color:#ffff00;"|''No.''
|Employing this causes the whole world to freeze for a short period of time. Except you, and perhaps PZ. You loose your flag after this. You can't shoot while the world is frozen.
|-
|Ugly
| +
|style="background-color:#ffff00;"|''No.''
|When opposing tanks have you in there lock angle, their tanks automatically turn away from you. This can be compensated for by turning against it.
|-
|Fly by Wire (FW)
| +
|style="background-color:#ffff00;"|''No, though adding this to GM might be nice.''
|Missile flies with built-in camera; player's tank stands still until missile flight is over.
|-
|KamikaZe (KZ)
| -
|style="background-color:#ffff00;"|''No.''
|Tank drives fast, explodes with a large radius when it collides with another tank or obstacle
|-
|Random Teleport (RT)
| -
|style="background-color:#ffff00;"|''No.''
|Can't control when or where it teleports you
|-
|Air Burst (AB)
| +
|style="background-color:#ffff00;"|''Never.''
|Flag explodes when it reaches its apex when dropped. Apex is especially high. Explosion is large (bigger than shock wave). Being in or behind a building should protect you. Being behind (or through!) a teleporter should not.
|-
|Heat Seeker (HS)
| +
|style="background-color:#ffff00;"|''Never, same as GM.''
|Missile is fire-and-forget; heads toward nearest "heat source"
|-
|HoloGram (HG)
| +
|style="background-color:#ffff00;"|''Never.''
|Player's tank appears off to one side from where it really is.
|-
|Grappling Beam (GB)
| +
|style="background-color:#ffff00;"|''No.''
|Clicking fires a laser-like beam that travels at the same speed as bullets, and does the same thing to enemy tanks if they are hit. If the beam hits a pyramid or a box, however, the tank gets pulled rapidly to the object that was hit (like a grappling hook).
|-
|ILlusion (IL)
| +
|style="background-color:#ffff00;"|''No.''
|Opposing players see 2(?) fake copies of your tank at constant random offsets from your real position (if they are shot, either nothing happens or the fakes disappear?).
|-
|SNake (SN)
| +
|style="background-color:#ffff00;"|''No.''
|(Goofy) Becomes like a game of Nibbles for the bearer of the flag; a laser-looking barrier comes out behind the tank, and stays there (possibly for only a fixed length). Any player that touches the barrier dies.
|-
|Kill or be Killed (KK)
| -
|style="background-color:#ffff00;"|''Never.''
|Player has to make kills within a certain time, or risk blowing him/herself up. {abbrev should be changed for obvious reasons}
|-
|ShotGun (SG)
| +
|style="background-color:#ffff00;"|''Never.''
|Shots split and go off in different directions.
|-
|Interdimensional Teleport (IT)
| +
|style="background-color:#ffff00;"|''Never, no "on drop" actions.''
|Teleports to a random location when dropped
|-
|Rear Shot (RS)
| +
|style="background-color:#ffff00;"|''Never.''
|Shoots both in front and behind (if available shots)
|-
|LLama (LL)
| -
|style="background-color:#ffff00;"|''No.''
|(Goofy) Involuntarily charges all visible tanks, starting with the closest, including teammates. Has the same effect as SR on impact. Other tanks see an amusing llama. graphic.
|-
|SuperDrop(SD)
| +
|style="background-color:#ffff00;"|''Never.''
|When killed holding this flag, all tanks loose their flags, and they are sucked into the ether.
|-
|George Bush (GB)
| -
|style="background-color:#ffff00;"|''No.''
|(Goofy) All game and player messages are sent through a filter translating them into George W. Bush speak. Because he knows how difficult it is to put code on your project.
|-
|Turbo Boost (TB)
| +
|style="background-color:#ffff00;"|''Never.''
|Right click makes you faster than high speed briefly. Flag can be used multiple times, maybe with a recharge time.
|-
|ReFlect (RF)
| +
|style="background-color:#ffff00;"|''Never.''
|When you get hit, you die as usual, but shot isn't stopped, it is reflected back in the direction it came from.
|-
|MirroR (MR)
| +
|style="background-color:#ffff00;"|''Never.''
|See reflections of other tanks on the walls for aiming ricochet bullets
|-
|SubterFuge (SF)
| +
|style="background-color:#ffff00;"|''Never.''
|Similar to Antagonize. Players near you or those you id are sent deceptive messages purportedly from other players or teammates. These would be stock messages such as: watch out, [callsign] is behind you... let's go after [callsign]... boo... where callsign is a player on a team other than theirs or a rogue.
|-
|MagShield(MS)
| +
|style="background-color:#ffff00;"|''No, need to shoot.''
|A defense only flag. Fire and you envelope yourself with a brief magnetic shield that looks like or similar to shock wave, only this shield acts like a wall stopping or causing shots to rico as appropriate. Put up your shield soon enough and you're safe, but wait too long and a shot's ricocheting around inside with you. Tanks can drive thru the shield, both to fire at you or to be protected by you as you approach a target (camper). To fire yourself you have to drop the flag.
|-
|Tether Ball(TB)
| +
|style="background-color:#ffff00;"|''No. too many changes.''
|A ball appears behind the tank attached by a tether and can be swung along the ground by sharp turns. If a tank (even your own) hits either the tether or the ball it is destroyed.
|-
|Dumbfire Missile (DM)
| +
|style="background-color:#ffff00;"|''No.''
|A missile that can not be locked on, but has an actual blast area (miniature shock-wave, but without affecting PZ players). Possible alternative: Full size SW, but flag is 'used' (dropped for a long time, like the shield flag) when fired.
|-
|MultiFlag (MF)
| +
|style="background-color:#ffff00;"|''Never.''
|Tank can hold two other flags at the same time.
|-
|OIl (OI)
| +
|style="background-color:#ffff00;"|''No. large engine change.''
|Tank leaves an oil trail behind which steers people off course.
|-
|Flag Launcher(FL)
| +
|style="background-color:#ffff00;"|''No. No multiple flags.''
|Gives tank the same attributes as TH but can pick up a second flag without being affected, and fire it at another tank. If it misses you keep the flag but if it hits the tank is forced to give up any currently held flags and pick up the launched flag. Good with LE.
|-
|Radar Scout (RS)
| +
|style="background-color:#ffff00;"|''No, confusing.''
|Your tank becomes a radar-equipped scout (you can still shoot). In a certain radius around you, all tanks (except you) look obese (due to increased radar) and can be shot like obese tank (hitting is easier); they still fit through teleporters. In addition, cloaked and stealthed tanks and shots also become visible. Every tank on the play field can see and shoot the obese and cloaked tanks, so you have the advantages that

Tanks are more likely to shoot at each other, since you are normal in size, the others are obese
Others will think twice before destroying you since you provide them with a targeting aid
|-
|TurreT (TT)
| +
|style="background-color:#ffff00;"|''No.''
|Turns your tank into a turret. Same as Burrow + Machine Gun + Angular Velocity, but your tank can't move at all.
|-
|AnnoYance (AY)
| +
|style="background-color:#ffff00;"|''No, too easy to camp by a flag.''
|Tank is very large and fast, can't shoot, and invincible. Can distract enemies while friendlies go in for the kill.
|-
|AntiMatter (AM)
| +
|style="background-color:#ffff00;"|''No, needs more thought for vertical worlds.''
|Tank cannot be hit except for SB/SW. 50% increased reload time, can be steamrolled by any tank, colliding with buildings results in death too
|-
|Targeting Computer (TC)
| +
|style="background-color:#ffff00;"|''No, a lag nightmare.''
|HUD shows where to aim for lead-ahead based on dead reckoning
|-
|StraFe (SF)
| +
|style="background-color:#ffff00;"|''No, will not be a flag feature if ever implemented.''
|Modifier key makes turning strafe
|-
|ECCM (um...)
| +
|style="background-color:#ffff00;"|''No.''
|When firing from ECCM equipped tank, other tanks in front of it, 20/30 degrees, have for a while both not working radar and communication (excluding admins).
|-
|HeadAche (HA)
| -
|style="background-color:#ffff00;"|''No.''
|All colors (not just tank colors) are inverted. Causes confusion for player, should have time limit. Submitted by ThatGuySpencer
|-
|Double Shot (DS)
| +
|style="background-color:#ffff00;"|''No, see backfire.''
|Shots come out of both ends of your tank, shoting backwards and fowards (maybe your bullets run out twice as fast) - Terminator
|-
|X-ray Vision(XV)
| +
|style="background-color:#ffff00;"|''No, difficult to portray with complex worlds.''
|Can see through buildings, but not drive through them. Either they are completely invisible (making out-the window driving fun) or they show up like with OO. Makes it possible to surprise others who are behind objects, and who are depending only on radar to know where you are.
|-
|SNiper (SN)
| +
|style="background-color:#ffff00;"|''No, to much like laser.''
|Tank has one, invisible, shot that lasts until it hits something/someone. Never ricochets. Blam!
|-
|PariaH (PH)
| -
|style="background-color:#ffff00;"|''No.''
|Tank is identified in all ways as each other player's nemesis.
|-
|NeMesis (NM)
| +
|style="background-color:#ffff00;"|''No, not a good flag feature.''
|HUD indicates direction (but not distance) to last person to kill you, even if under stealth.
|-
|Rear Window (RW)
| +
|style="background-color:#ffff00;"|''No.''
|View is split horizontally, bottom half is view out the back.
|-
|Collector (CO)
| -
|style="background-color:#ffff00;"|''No holding multiple flags, unproductive''
|Or cleaner (CR). Everything is normal except this tank can collect all the flags, without being able to use them. The moment he presses spacebar or dies all flags he holds return to the world.
|-
|Bomber (BM)
| +
|style="background-color:#ffff00;"|''No we don't do splash damage''
|Like WG, but all shots go downwards. Speed is determined by _gravity. Useful for flying servers. When flying with BM the speed is slower than that of WG, but bombs shot will have a larger radius (can kill more things around them).
|-
|Pole-aXed (PX)
| -
|style="background-color:#ffff00;"|''No may as well just kill him, and we don't kill for a bad flag''
|Tank cannot move forwards or backwards, can steer and jump (even on no jump servers,to be more fair). It's like being stuck on a pole.
|-
|Splash-Damage (SD)
| +
|style="background-color:#ffff00;"|''No we don't do splash damage''
|When one of your bullets hits an enemy, he explodes in a shockwave.
|-
|PHase shift (PH)
| -
|style="background-color:#ffff00;"|''Combines OO, SB and more -- too powerful.''
|Oscillation Overthruster, but can backup, jump and shoot in walls. Shoots Super Bullets, and can be killed by Phantom Zone.}
|-
|ASsassin (AS)
| +
|style="background-color:#ffff00;"|''No, too complex, too powerfull''
|As small, fast and short-ranged as thief. Fatal and can't steal flags. Stealth and Cloaking in effect when someone is not in range, and cloaking in effect when you can't see them. (partial cloaking in effect when you can see part of them, that is, they're on the side of your view.) Can be steamrolled by anyone. Longer reload time than Thief. Can only kill once (but maybe you still keep the flag?).
|-
|BoMb (BM)
| -
|style="background-color:#ffff00;"|''No, rather pointless''
|Can be transferred to someone by shooting them, also transfers the timer. When the bad flag timer (or another timer) is up, the holder dies and creates a shockwave.
|-
|Terrain Immunity (TI)
| +
|style="background-color:#ffff00;"|''No, too map specific''
|User is invulnerable to, and can walk through, terrain hazards such as stuff that would normally be fatal to touch and conveyor belts.
|-
|Cloaked Bullet (CB)
| +
|style="background-color:#ffff00;"|''Same as Cloaked Shot, implemented in 2.99''
|Your bullets are invisible out-the-window.
|-
|Charge Beam (CB)
| +
|style="background-color:#ffff00;"|''No, just use multiple shots from a regular laser''
|Hold mouse button to charge. Releasing shoots a laser that keeps firing for as long as you charged the beam for. (Maybe a limit on charge time, so there's a limit on how long you fire a laser for?)
|-
|Gravitational Field (GF)
| +
|style="background-color:#ffff00;"|''BZFlag is not a physics engine. Possible lag and sync nightmare.''
|Attracts nearby tanks and bullets towards you. You are also afected by Newton's third law, with a resulting force pushing you in the opposite direction of the sum of all the force vectors of all the tanks and bullets you attract. It can be good and bad. With skill you can use this flag to alter bullet paths and tank motion to your/your teammate's advantage, or to your enemy's disadvantage. An example of the effect might be if a tank w/ WG is nearby you could be pulled aloung in flight,although flight would be more difficult for the tank w/ WG. There is a higher risk of being hit and higher difficulty in moving.
|-
|Destroy Buildings (DB)
| +
|style="background-color:#ffff00;"|''No, significantly difficult to implement, and allows for to much abbuse''
|When your shot hits an object (such as a building) it causes that object to disappear temporarily. Still ricochets off.
|-
|PLane (PL)
| +
|style="background-color:#ffff00;"|''No multiple flags, no vertical shots, no weird [http://en.wikipedia.org/wiki/Royal_Flying_Corps flying] stuff. This probably won't be implemented.''
|Turns your tank into a plane. Planes have two guns, one on each wing. You can accelerate or decelerate by using scroll wheel up to accelerate, down to decelerate. Point the mouse in the direction you want to turn. If you are shot or touch a wall you turn back into a tank. ENEMY tanks get vertical lock-on on you, meaning if they shoot while you are within their view, then their shot is at an angle upward or downward so that it might hit you. You can get some flags as a plane. Shock wave drops a bomb straight down with the velocity of a shot, plus your velocity; Laser shoots a laser from your nose-cone; Rapid Fire, Super Bullet, Machine Gun, GM are the same as normal (but you still have wing guns); Cloaking, Stealth, and Masquerade are the same; Thief shoots from nose-cone; Black Hole shoots from nose-cone; OO lets you fly through walls (except floor and the surrounding wall, of course); PZ is same as normal; Galaga makes you wider, but you can shoot more shots; Charge Beam from nose-cone; Sensor Package is same as normal; No Ricochet prevents ricochet; etc.. If you drop a flag as a plane, it drops first the grabbed flag, then once you have no grabbed flag, turns you back into a tank. I realize this probably won't be implemented.
|-
|Sensor Package (SP)
| +
|style="background-color:#ffff00;"|''No, too powerful''
|In-game description: "Tank has upgraded sensors and can send locks to guided missiles and allies." Description here: You can see what flag an enemy has, you get those arrow things for enemy team flags as well as your own (and also vertical ones), all walls show up as green wireframe on black background; you get those "enemy in range, enemy to left/right" from Battle Zone when an enemy is in your range; you can lock on to enemies (but not allies) (as you do, all ENEMY missiles within the radius of a SW lock onto them, all ALLIES with GM lock onto them, but not their fired missiles), you also get notifications when you are within an enemy's line of sight and range, especially when you are within the blast radius of someone with shockwave, you can see what flag somebody has on the radar and HUD (letters over their head).
|-
|Flak (FK)
| +
|style="background-color:#ffff00;"|''No, too complex''
|Your tank shoots debris (or oval shaped sheilds or whatever they may look like) that collide and disintegrate regular type bullets instantly when the two come in contact.
|-
|Improved Masquerade (IM)
| +
|style="background-color:#ffff00;"|''No, no on shot changes, and too complex''
|Your tank appears on the Radar and through the view finder as a friendly tank to the enemy, but not to right-clicks and identification through targeting. However, this lasts until your fire. When you fire, you immediately lose the flag. This is good for infiltrating another side, but as soon as someone right-clicks you in his targeting reticule, your identity is displayed.
|-
|Kick back (KB)
| +
|style="background-color:#ffff00;"|''No, no advantage to the flag, just make it a server option for all shots''
|When shot your tanks goes backwards a certain distance. This lasts for a server set # of seconds
[Note: How is this a positive flag? This is also too similar to Big Bullet.]
|-
|Oldschool (OS)
| +
|style="background-color:#ffff00;"|''No, is not general enough, depends on other map setup''
|Immune to super bullets, missiles, laser beams, shock waves, and steamrolls. Tanks with other flags can still hit you, and theives can steal your flag; in other words, business as usual. Make others drop their precious flags.
|-
|New Age (NA)
| +
|style="background-color:#ffff00;"|''No, is not general enough, depends on other map setup''
|Immune to regular bullets; can only be killed by lasers, missiles, super bullets, steamrolls, and shock waves. Opposite of Oldschool. Probably disabled on maps without easily accessible superweapon flags.
|-
|Entanglement (QE)
| +
|style="background-color:#ffff00;"|''No''
|Whoever kills you gets destroyed by the server.
|-
|Laser Tripwire (LT)
| +
|style="background-color:#ffff00;"|''No, too complex''
|Shot travels until it strikes a wall, then generates a (non-ricocheting) laser beam along the direction of the surface normal until it reaches another surface. Beam remains until touched by a tank, which is destroyed. If player fires another tripwire, the existing tripwire is deleted. Player may drop the flag to leave the most recent tripwire in place. Shockwave will delete any tripwire it touches (if not too difficult to code).
|-
|Shotgun (SG) (Different to other one)
| +/-
|style="background-color:#ffff00;"|''No, too much like MG, same as the other ShotGun suggestion''
|All available shots are fired at once (set # by server), 1 straight, the next a set # of degrees left of the first, then the next # of degress right of the first and so on creating dispersed shots. Fast bullets but reduced range, no ricochet and very slow reload time. Good against multiple enemies in range and provides strategic usage of walls for cover while reloading. Useless against laser and guided missle and good players can jump/avoid and shoot you while reloading which is why shots travel faster. Good for short range but useless in long range.
|-
|Air Safe (AS)
| +
|style="background-color:#ffff00;"|''No, GM already has a counter flag: ST''
|Countermeasure for guided missle. Guided missles that come within sw radius of the player are destroyed but all other shots unaffected. Dampens power of guided missle.
|-
|SHort tank (SH)
| +
|style="background-color:#ffff00;"|''No, simply make a server option to make burrow jump''
|Makes tank short. Exactly like burrow except that it allows you to be on buildings and jump.
|-
|Communications Disruption (CD)
| -
|style="background-color:#ffff00;"|''No, too specific to a play style''
|You cannot send team messages. You can still send PMs, Admin messages and public messages.
|-
|Double Shot (DS)
| +
|style="background-color:#ffff00;"|''No, too complex, with not enough added benefit. Shots would have to bounce in non physical ways to seperate.''
|Every time a player with this flag fires and the shots bounce off a wall (or other object) it splits the shot into 2 shots. Can only happen once (split shots cannot split again).
|-
|Super Shield (SS)
| +
|style="background-color:#ffff00;"|''No, too complex''
|You have to be shot a set amount of times to die. A bit like shield BUT different types of shots damage the tank more. (Say a tanks picks up the SS flag and he/she has to be hit 5 times to die, but SW takes off 4 hits so he only has to be hit 2 times with SW to die). This could also work with Double Shot (DS) where when the shot splits it only makes half the damage of a normal shot. (He/she would now have to be hit 10 times with split bullets to die). Maybe put a health bar over the players tank that shows how many times YOU have to hit the tank with your bullets. (P1 gets SS flag and has to be hit 4 times to die, P2 gets GM (which takes off 2 hits) and he looks at P1 and it has the health bar and a number saying 2 (P2 has to hit P1 with the GM that he has 2 times) then P3 gets a SW flag and the health bar says 1 (because SW takes off 4 points and P1 only has 4 health points). If the health bar is too hard then i think that you could just have the SS without a health bar.
|-
|Flag Magnet (FM)
| +
|
|When you shoot this, all nearby flags get pulled into it and disappear (Go to phantom zone?)
|-
|Flag Changer (FC)
| +
|
|You can give/take somebody bad/good flags. (Zoned flags too?) Dontkillmyimabeg.
|-
[[Category:Gameplay]]

Functions (API)

2008-12-20T06:10:37Z

Javawizard2539: /* Reporting */ bz_fileReport takes two arguments, not one (the second argument is the player to indicate that the report has come from)

{{DoDoc|Fill in articles for all API Functions}}

{{BZFS_API_Doc}}

==Overview==

The BZFS API provides a number of functions to plug-ins for use in querying the current game state. Functions are used both to get information about the game, and to trigger in game actions, such as activating a world weapon.

==Function Groups==
Functions are broken into a series of groups based on the type of action or information they deal with.

===Event Registration===
BZF_API bool [[bz_registerEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );

===Non-Player Connections===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );

===Player Information===

BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, [[bz_PlayerUpdateState]] &state );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
BZF_API [[bz_APIIntList]]* [[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Team Management===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
BZF_API bool [[bz_setPlayerWins]] (int playerId, int wins);
BZF_API bool [[bz_setPlayerLosses]] (int playerId, int losses);
BZF_API bool [[bz_setPlayerTKs]] (int playerId, int tks);
BZF_API bool [[bz_resetPlayerScore]] (int playerId);
BZF_API int [[bz_getPlayerWins]] (int playerId);
BZF_API int [[bz_getPlayerLosses]] (int playerId);
BZF_API int [[bz_getPlayerTKs]] (int playerId);

=== Latency Information ===
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]]( const char* group, const char* perm );

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );

=== Server Management ===
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] (int playerID, bz_eTeamType = eNoTeam);
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();

=== Rabbit Hunt===
BZF_API void [[bz_newRabbit]]( int player, bool swap );
BZF_API void [[bz_removeRabbit]]( int player );

=== Map Management ===
BZF_API void [[bz_setClientWorldDownloadURL]]( const char* URL );
BZF_API const bzApiString [[bz_getClientWorldDownloadURL]] ( void );
BZF_API bool [[bz_saveWorldCacheFile]]( const char* file );

=== Flag Management ===

BZF_API bool [[bz_givePlayerFlag]] ( int playerID, const char* flagType, bool force );
BZF_API bool [[bz_removePlayerFlag]] ( int playerID );
BZF_API void [[bz_resetFlags]] ( bool onlyUnused );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName]]( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3], bool reset = true );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, float *pos, float tilt, float direction, int shotID , float dt );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt);

=== Server Time ===
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );
BZF_API void [[bz_getLocaltime]] ( [[bz_localTime]] *ts );

=== Global Database Management (BZDB) ===
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]]( const char* variable );
BZF_API bool [[bz_getBZDBBool]]( const char* variable );
BZF_API int [[bz_getBZDBInt]]( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPersistent]]( const char* variable );
BZF_API bool [[bz_BZDBItemExists]]( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]]( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]]( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]]( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]]( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]]( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]]( void );

=== Logging ===
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]]( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

===Server Administration===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( const char* ipAddress, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IDBanUser]] ( const char* bzid, const char* bzID , int duration, const char *reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );

BZF_API int [[bz_getLagWarn]]( void );
BZF_API bool [[bz_setLagWarn]]( int lagwarn );
BZF_API bool [[bz_pollActive]]( void );
BZF_API bool [[bz_pollVeto]]( void );

=== Reporting ===
BZF_API [[bz_APIStringList]]* bz_getReports( void );
BZF_API [[bool bz_fileReport]]( const char* message, const char* from );

=== Timed Game Management===
BZF_API bool [[bz_setTimeLimit]]( float timeLimit );
BZF_API float [[bz_getTimeLimit]]( void );
BZF_API bool [[bz_isTimeManualStart]]( void );
BZF_API bool [[bz_isCountDownActive]]( void );
BZF_API bool [[bz_isCountDownInProgress]]( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands===
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

===Plug-in Management===
BZF_API int [[bz_getLoadedPlugins]]( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]]( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]]( const char* path );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information===
BZF_API bool [[bz_getPublic]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]]( void );
BZF_API void [[bz_updateListServer]] ( void );

===HTTP Transfer===
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
BZF_API bool [[bz_stopAllURLJobs]] ( void );

===Inter-Plug-in Communications===
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API [[_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

===Game Recording===
BZF_API bool [[bz_saveRecBuf]]( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]]( void );
BZF_API bool [[bz_stopRecBuf]]( void );

===Map Management===
====Map Information====
BZF_API void [[bz_getWorldSize]]( float *size, float *wallHeight );
BZF_API int [[bz_getWorldObjectCount]]( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]]( void );
BZF_API void [[bz_releaseWorldObjectList]]( [[bz_APIWorldObjectList]]* list );

====Map Collisions====
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

====Custom Map Objects====
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

===Utility===
BZF_API const char *[[bz_MD5]](const char* str);
BZF_API const char *[[bz_MD5]](const void* data, size_t size);

===Misc===
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );

===Server Side Players (Development)===
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Functions (API)

2008-12-20T06:08:09Z

Javawizard2539: /* Server Administration */

{{DoDoc|Fill in articles for all API Functions}}

{{BZFS_API_Doc}}

==Overview==

The BZFS API provides a number of functions to plug-ins for use in querying the current game state. Functions are used both to get information about the game, and to trigger in game actions, such as activating a world weapon.

==Function Groups==
Functions are broken into a series of groups based on the type of action or information they deal with.

===Event Registration===
BZF_API bool [[bz_registerEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );

===Non-Player Connections===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );

===Player Information===

BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, [[bz_PlayerUpdateState]] &state );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
BZF_API [[bz_APIIntList]]* [[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Team Management===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
BZF_API bool [[bz_setPlayerWins]] (int playerId, int wins);
BZF_API bool [[bz_setPlayerLosses]] (int playerId, int losses);
BZF_API bool [[bz_setPlayerTKs]] (int playerId, int tks);
BZF_API bool [[bz_resetPlayerScore]] (int playerId);
BZF_API int [[bz_getPlayerWins]] (int playerId);
BZF_API int [[bz_getPlayerLosses]] (int playerId);
BZF_API int [[bz_getPlayerTKs]] (int playerId);

=== Latency Information ===
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]]( const char* group, const char* perm );

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );

=== Server Management ===
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] (int playerID, bz_eTeamType = eNoTeam);
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();

=== Rabbit Hunt===
BZF_API void [[bz_newRabbit]]( int player, bool swap );
BZF_API void [[bz_removeRabbit]]( int player );

=== Map Management ===
BZF_API void [[bz_setClientWorldDownloadURL]]( const char* URL );
BZF_API const bzApiString [[bz_getClientWorldDownloadURL]] ( void );
BZF_API bool [[bz_saveWorldCacheFile]]( const char* file );

=== Flag Management ===

BZF_API bool [[bz_givePlayerFlag]] ( int playerID, const char* flagType, bool force );
BZF_API bool [[bz_removePlayerFlag]] ( int playerID );
BZF_API void [[bz_resetFlags]] ( bool onlyUnused );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName]]( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3], bool reset = true );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, float *pos, float tilt, float direction, int shotID , float dt );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt);

=== Server Time ===
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );
BZF_API void [[bz_getLocaltime]] ( [[bz_localTime]] *ts );

=== Global Database Management (BZDB) ===
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]]( const char* variable );
BZF_API bool [[bz_getBZDBBool]]( const char* variable );
BZF_API int [[bz_getBZDBInt]]( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPersistent]]( const char* variable );
BZF_API bool [[bz_BZDBItemExists]]( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]]( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]]( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]]( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]]( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]]( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]]( void );

=== Logging ===
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]]( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

===Server Administration===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( const char* ipAddress, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IDBanUser]] ( const char* bzid, const char* bzID , int duration, const char *reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );

BZF_API int [[bz_getLagWarn]]( void );
BZF_API bool [[bz_setLagWarn]]( int lagwarn );
BZF_API bool [[bz_pollActive]]( void );
BZF_API bool [[bz_pollVeto]]( void );

=== Reporting ===
BZF_API [[bz_APIStringList]]* bz_getReports( void );
BZF_API [[bool bz_fileReport]]( const char* message );

=== Timed Game Management===
BZF_API bool [[bz_setTimeLimit]]( float timeLimit );
BZF_API float [[bz_getTimeLimit]]( void );
BZF_API bool [[bz_isTimeManualStart]]( void );
BZF_API bool [[bz_isCountDownActive]]( void );
BZF_API bool [[bz_isCountDownInProgress]]( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands===
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

===Plug-in Management===
BZF_API int [[bz_getLoadedPlugins]]( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]]( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]]( const char* path );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information===
BZF_API bool [[bz_getPublic]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]]( void );
BZF_API void [[bz_updateListServer]] ( void );

===HTTP Transfer===
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
BZF_API bool [[bz_stopAllURLJobs]] ( void );

===Inter-Plug-in Communications===
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API [[_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

===Game Recording===
BZF_API bool [[bz_saveRecBuf]]( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]]( void );
BZF_API bool [[bz_stopRecBuf]]( void );

===Map Management===
====Map Information====
BZF_API void [[bz_getWorldSize]]( float *size, float *wallHeight );
BZF_API int [[bz_getWorldObjectCount]]( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]]( void );
BZF_API void [[bz_releaseWorldObjectList]]( [[bz_APIWorldObjectList]]* list );

====Map Collisions====
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

====Custom Map Objects====
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

===Utility===
BZF_API const char *[[bz_MD5]](const char* str);
BZF_API const char *[[bz_MD5]](const void* data, size_t size);

===Misc===
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );

===Server Side Players (Development)===
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Functions (API)

2008-12-20T06:05:28Z

Javawizard2539: /* Player Information */ Changed setPlayerLimboText to setPlayerLimboMessage (the correct name)

{{DoDoc|Fill in articles for all API Functions}}

{{BZFS_API_Doc}}

==Overview==

The BZFS API provides a number of functions to plug-ins for use in querying the current game state. Functions are used both to get information about the game, and to trigger in game actions, such as activating a world weapon.

==Function Groups==
Functions are broken into a series of groups based on the type of action or information they deal with.

===Event Registration===
BZF_API bool [[bz_registerEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Events(API)|bz_eEventType]] eventType, [[Events(API)|bz_EventHandler]]* eventHandler );

===Non-Player Connections===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );

===Player Information===

BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, [[bz_PlayerUpdateState]] &state );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
BZF_API [[bz_APIIntList]]* [[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_anyPlayers]] ( void );

=== Team Management===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

=== Score Management ===
BZF_API bool [[bz_setPlayerWins]] (int playerId, int wins);
BZF_API bool [[bz_setPlayerLosses]] (int playerId, int losses);
BZF_API bool [[bz_setPlayerTKs]] (int playerId, int tks);
BZF_API bool [[bz_resetPlayerScore]] (int playerId);
BZF_API int [[bz_getPlayerWins]] (int playerId);
BZF_API int [[bz_getPlayerLosses]] (int playerId);
BZF_API int [[bz_getPlayerTKs]] (int playerId);

=== Latency Information ===
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );

=== Permission Group Management ===
BZF_API [[bz_APIStringList]]* [[bz_getGroupList]] ( void );
BZF_API [[bz_APIStringList]]* [[bz_getGroupPerms]] ( const char* group );
BZF_API bool [[bz_groupAllowPerm]]( const char* group, const char* perm );

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );

=== Server Management ===
BZF_API bool [[bz_restart]] ( void );
BZF_API void [[bz_shutdown]] ();
BZF_API void [[bz_superkill]] ();
BZF_API void [[bz_gameOver]] (int playerID, bz_eTeamType = eNoTeam);
BZF_API void [[bz_reloadLocalBans]] ();
BZF_API void [[bz_reloadMasterBans]] ();
BZF_API void [[bz_reloadGroups]] ();
BZF_API void [[bz_reloadUsers]] ();
BZF_API void [[bz_reloadHelp]] ();

=== Rabbit Hunt===
BZF_API void [[bz_newRabbit]]( int player, bool swap );
BZF_API void [[bz_removeRabbit]]( int player );

=== Map Management ===
BZF_API void [[bz_setClientWorldDownloadURL]]( const char* URL );
BZF_API const bzApiString [[bz_getClientWorldDownloadURL]] ( void );
BZF_API bool [[bz_saveWorldCacheFile]]( const char* file );

=== Flag Management ===

BZF_API bool [[bz_givePlayerFlag]] ( int playerID, const char* flagType, bool force );
BZF_API bool [[bz_removePlayerFlag]] ( int playerID );
BZF_API void [[bz_resetFlags]] ( bool onlyUnused );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName]]( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3], bool reset = true );
BZF_API bool [[bz_RegisterCustomFlag]] ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

=== Shot Type Control ===
BZF_API bool [[bz_setPlayerShotType]]( int playerId, [[bz_eShotType]] shotType );

=== World Weapon Management ===
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, float *pos, float tilt, float direction, int shotID , float dt );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt);

=== Server Time ===
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );
BZF_API void [[bz_getLocaltime]] ( [[bz_localTime]] *ts );

=== Global Database Management (BZDB) ===
BZF_API double [[bz_getBZDBDouble]] ( const char* variable );
BZF_API [[bz_ApiString]] [[bz_getBZDBString]]( const char* variable );
BZF_API bool [[bz_getBZDBBool]]( const char* variable );
BZF_API int [[bz_getBZDBInt]]( const char* variable );
BZF_API int [[bz_getBZDBItemPerms]] ( const char* variable );
BZF_API bool [[bz_getBZDBItemPersistent]]( const char* variable );
BZF_API bool [[bz_BZDBItemExists]]( const char* variable );
BZF_API bool [[bz_setBZDBDouble]] ( const char* variable, double val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBString]]( const char* variable, const char *val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBBool]]( const char* variable, bool val, int perms = 0, bool persistent = false );
BZF_API bool [[bz_setBZDBInt]]( const char* variable, int val, int perms = 0, bool persistent = false );
BZF_API int [[bz_getBZDBVarList]]( bz_APIStringList *varList );
BZF_API void [[bz_resetBZDBVar]]( const char* variable );
BZF_API void [[bz_resetALLBZDBVars]]( void );

=== Logging ===
BZF_API void [[bz_debugMessage]] ( int level, const char* message );
BZF_API void [[bz_debugMessagef]]( int level, const char* fmt, ... )
BZF_API int [[bz_getDebugLevel]] ( void );

===Server Administration===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int playerIndex, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IDBanUser]] ( int playerIndex, const char* bzID , int duration, const char *reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );

BZF_API int [[bz_getLagWarn]]( void );
BZF_API bool [[bz_setLagWarn]]( int lagwarn );
BZF_API bool [[bz_pollActive]]( void );
BZF_API bool [[bz_pollVeto]]( void );

=== Reporting ===
BZF_API [[bz_APIStringList]]* bz_getReports( void );
BZF_API [[bool bz_fileReport]]( const char* message );

=== Timed Game Management===
BZF_API bool [[bz_setTimeLimit]]( float timeLimit );
BZF_API float [[bz_getTimeLimit]]( void );
BZF_API bool [[bz_isTimeManualStart]]( void );
BZF_API bool [[bz_isCountDownActive]]( void );
BZF_API bool [[bz_isCountDownInProgress]]( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

=== Custom Text Commands===
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

===Plug-in Management===
BZF_API int [[bz_getLoadedPlugins]]( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]]( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]]( const char* path );
BZF_API bool [[bz_registerCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );
BZF_API bool [[bz_removeCustomPluginHandler]] ( const char* extension, [[bz_APIPluginHandler]] * handler );

=== Public Server Information===
BZF_API bool [[bz_getPublic]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]]( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]]( void );
BZF_API void [[bz_updateListServer]] ( void );

===HTTP Transfer===
BZF_API bool [[bz_addURLJob]] ( const char* URL, [[bz_BaseURLHandler]]* handler = NULL, const char* postData = NULL );
BZF_API bool [[bz_removeURLJob]] ( const char* URL );
BZF_API bool [[bz_stopAllURLJobs]] ( void );

===Inter-Plug-in Communications===
BZF_API bool [[bz_clipFieldExists]] ( const char *name );
BZF_API const char* [[bz_getclipFieldString]] ( const char *name );
BZF_API float [[bz_getclipFieldFloat]] ( const char *name );
BZF_API int [[bz_getclipFieldInt]] ( const char *name );
BZF_API bool [[bz_setclipFieldString]] ( const char *name, const char* data );
BZF_API bool [[bz_setclipFieldFloat]] ( const char *name, float data );
BZF_API bool [[bz_setclipFieldInt]] ( const char *name, int data );
BZF_API bool [[bz_addClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );
BZF_API [[_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

===Game Recording===
BZF_API bool [[bz_saveRecBuf]]( const char * _filename, int seconds);
BZF_API bool [[bz_startRecBuf]]( void );
BZF_API bool [[bz_stopRecBuf]]( void );

===Map Management===
====Map Information====
BZF_API void [[bz_getWorldSize]]( float *size, float *wallHeight );
BZF_API int [[bz_getWorldObjectCount]]( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]]( void );
BZF_API void [[bz_releaseWorldObjectList]]( [[bz_APIWorldObjectList]]* list );

====Map Collisions====
[[bz_eAPIColType]] [[bz_cylinderInMapObject]] ( float pos[3], float height, float radius, [[bz_APIBaseWorldObject]] **object );
[[bz_eAPIColType]] [[bz_boxInMapObject]] ( float pos[3], float size[3], float angle, [[bz_APIBaseWorldObject]] **object );

====Custom Map Objects====
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

===Utility===
BZF_API const char *[[bz_MD5]](const char* str);
BZF_API const char *[[bz_MD5]](const void* data, size_t size);

===Misc===
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase, int killerID = -1, const char* flagID = NULL );
BZF_API bool [[bz_sendPlayCustomLocalSound]] ( int playerID, const char* soundName );
BZF_API [[bz_ApiString]] [[bz_filterPath]] ( const char* path );
BZF_API const char *[[bz_format]](const char* fmt, ...)_ATTRIBUTE12;
BZF_API const char *[[bz_toupper]](const char* val );
BZF_API const char *[[bz_tolower]](const char* val );
BZF_API const char *[[bz_urlEncode]](const char* val );
BZF_API [[bz_eGameType]] [[bz_getGameType]]( void );
BZF_API [[bz_eTeamType]] [[bz_checkBaseAtPoint]] ( float pos[3] );

===Server Side Players (Development)===
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

==See also==
[[BZFS API]]

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Template:Cite

2008-12-20T00:14:38Z

Javawizard2539:

<span id="{{{ref}}}" name="{{{ref}}}" class="citation">{{{author}}}, ''{{{title}}}'', [[{{{publisher}}}]], [[{{{date}}}]].</span><noinclude>
{{documentation}}
</noinclude>

Bz canPlayerSpawn

2008-12-15T07:43:26Z

Javawizard2539: New page: {{apicall | name = bz_canPlayerSpawn | description = Returns true if the specified player is allowed to spawn, false if they are not | param1 = playerID | param1type =...

{{apicall
| name = bz_canPlayerSpawn
| description = Returns true if the specified player is allowed to spawn, false if they are not
| param1 = playerID
| param1type = int
| param1desc = The player to check
| returntype = bool
| returns = True if the player is allowed to spawn, false otherwise
}}

Bz setPlayerOperator

2008-12-15T07:12:21Z

Javawizard2539: New page: {{apicall | name = bz_setPlayerOperator | description = Marks this player as a server operator. A player typically becomes a server operator by providing the correct password to...

{{apicall
| name = bz_setPlayerOperator
| description = Marks this player as a server operator. A player typically becomes a server operator by providing the correct password to the /password command.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to mark as an operator
}}

Bz isPlayerPaused

2008-12-15T07:06:26Z

Javawizard2539: New page: {{apicall | name = bz_isPlayerPaused | description = Returns true if the specified player is currently paused, false if they are not | param1 = playerID | param1type =...

{{apicall
| name = bz_isPlayerPaused
| description = Returns true if the specified player is currently paused, false if they are not
| param1 = playerID
| param1type = int
| param1desc = The id of the player to check
| returntype = bool
| returns = True if the player specified is paused; false otherwise
}}

Bz getPlayerCurrentState

2008-12-15T07:03:19Z

Javawizard2539: New page: {{apicall | name = bz_getPlayerCurrentState | description = Gets the specified player's current state. This includes information about how fast they're traveling, if they're in ...

{{apicall
| name = bz_getPlayerCurrentState
| description = Gets the specified player's current state. This includes information about how fast they're traveling, if they're in the air, if they're rotating, and more.

A player's state changes very frequently (since players are typically on the move, fighting, and jumping, just to name a few), so the data obtained from this method won't be valid for very long.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to get the state for
| param2 = state
| param2type = bz_PlayerUpdateState&
| param2desc = A bz_PlayerUpdateState to put the information of the player specified by <tt>playerID</tt> into
}}

Bz freePlayerRecord

2008-12-15T06:52:18Z

Javawizard2539: New page: {{apicall | name = bz_freePlayerRecord | description = Frees the player record specified. This should be called on each player record after it's no longer needed, to release the...

{{apicall
| name = bz_freePlayerRecord
| description = Frees the player record specified. This should be called on each player record after it's no longer needed, to release the memory used by that player record.
| param1 = playerRecord
| param1type = bz_BasePlayerRecord
| param1desc = The player record to free
}}

Bz getPlayerFlag

2008-12-15T06:41:45Z

Javawizard2539:

{{apicall
| name = bz_getPlayerFlag
| description = Gets the flag id of the flag that the specified player is currently holding.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to check
| returntype = const char*
| returns = The two-character flag id of the flag that the player specified is holding, or NULL if the player does not exist or is not currently holding a flag
}}

Bz getPlayerFlag

2008-12-15T06:41:29Z

Javawizard2539: New page: {{apicall | name = bz_getPlayerFlag | description = Gets the flag id of the flag that the specified player is currently holding. | param1 = playerID | param1type = int...

{{apicall
| name = bz_getPlayerFlag
| description = Gets the flag id of the flag that the specified player is currently holding.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to check
| returntype = const char*
| return = The two-character flag id of the flag that the player specified is holding, or NULL if the player does not exist or is not currently holding a flag
}}

Bz APIIntList

2008-12-15T06:18:03Z

Javawizard2539: New page: A list of integers. This is used for passing lists of integers from the bzfs api itself to the plugin that uses the api.

A list of integers. This is used for passing lists of integers from the bzfs api itself to the plugin that uses the api.

Bz getAdmin

2008-12-15T06:16:49Z

Javawizard2539: New page: {{apicall | name = bz_getAdmin | description = Returns true if the player specified is an administrator on this server. Returns false otherwise. | param1 = playerID | par...

{{apicall
| name = bz_getAdmin
| description = Returns true if the player specified is an administrator on this server. Returns false otherwise.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to check for admin status
| returntype = bool
| returns = True if the player specified is an administrator; false otherwise
}}

Bz revokePerm

2008-12-15T06:15:09Z

Javawizard2539: New page: {{apicall | name = bz_revokePerm | description = Revokes the specified permission on the specified player. The player then loses this permission. | param1 = playerID | pa...

{{apicall
| name = bz_revokePerm
| description = Revokes the specified permission on the specified player. The player then loses this permission.
| param1 = playerID
| param1type = int
| param1desc = The id of the player on which to perform this action
| param2 = perm
| param2type = const char*
| param2desc = The name of the permission to revoke
}}

Bz grantPerm

2008-12-15T06:14:13Z

Javawizard2539: New page: {{apicall | name = bz_grantPerm | description = Grants the specified player the specified permission. After this method has been called, calls to bz_hasPerm, passing in this...

{{apicall
| name = bz_grantPerm
| description = Grants the specified player the specified permission. After this method has been called, calls to [[bz_hasPerm]], passing in this player's id and the permission specified, will return true.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to grant the permission to
| param2 = perm
| param2type = const char*
| param2desc = The name of the permission to grant
}}

Bz hasPerm

2008-12-15T06:11:38Z

Javawizard2539: New page: {{apicall | name = bz_hasPerm | description = Checks to see if the player specified has the permission specified. | param1 = playerID | param1type = int | param1desc ...

{{apicall
| name = bz_hasPerm
| description = Checks to see if the player specified has the permission specified.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to check
| param2 = perm
| param2type = const char*
| param2desc = The name of the permission to check for
| returntype = bool
| returns = True if the player specified has the permission specified, false if they do not have the permission specified
}}

Bz updatePlayerData

2008-12-15T06:03:04Z

Javawizard2539: New page: {{apicall | name = bz_updatePlayerData | description = Updates the data in a bz_BasePlayerRecord to the current state of that player. The information in a base player record...

{{apicall
| name = bz_updatePlayerData
| description = Updates the data in a [[bz_BasePlayerRecord]] to the current state of that player. The information in a base player record instance is not kept up-to-date as the game progresses, so this method must be called to get the most up-to-date information.
| param1 = playerRecord
| param1type = bz_BasePlayerRecord*
| param1desc = The player record to update. This record will contain the current information for the player it represents after this method call returns.
}}

Bz getPlayerByIndex

2008-12-15T06:00:19Z

Javawizard2539: New page: {{apicall | name = bz_getPlayerByIndex | description = Gets the information for the player at the index specified. The index should be one of the elements of the list returned b...

{{apicall
| name = bz_getPlayerByIndex
| description = Gets the information for the player at the index specified. The index should be one of the elements of the list returned by [[bz_getPlayerIndexList]]. The returned player info won't update as the game progresses. If you need new updates on the player's info, you can call [[bz_updatePlayerData]].

After you're done with the player info returned from this method, you must release it by calling [[bz_freePlayerRecord]].
| param1 = index
| param1type = int
| param1desc = The index of the player in question, as obtained from bz_getPlayerIndexList
| returntype = bz_BasePlayerRecord*
| returns = an instance of [[bz_BasePlayerRecord]] that contains the player in question's information
}}

Template:Apicall/typelink

2008-12-15T05:55:25Z

Javawizard2539: Changed to {{{1}}} because the current contents were causing links to pointer types to link to an article with the pointer type embedded

{{{1}}}

Bz getPlayerIndexList

2008-12-15T05:54:05Z

Javawizard2539: New page: {{apicall | name = bz_getPlayerIndexList | description = Returns a list of players indexes. Same as bz_getPlayerIndexList(bz_APIIntList), but a new bz_APIIntList is created ...

{{apicall
| name = bz_getPlayerIndexList
| description = Returns a list of players indexes. Same as [[bz_getPlayerIndexList(bz_APIIntList)]], but a new bz_APIIntList is created and returned. This newly-created api int list must be deleted when it is no longer needed.
| returntype = bz_APIIntList*
| returns = A pointer to a newly-created bz_APIIntList that contains the player indexes
}}

Bz removeEvent

2008-12-15T05:27:00Z

Javawizard2539:

{{apicall
| name = bz_removeEvent
| description = Removes the specified event listener. The event listener must previously have been added by a call to [[bz_registerEvent]].
| param1 = eventType
| param1type = bz_eEventType
| param1desc = The type of event that this listener was previously registered to handle. This is so that if this listener is registered for multiple event types, only one of those will be removed.
| param2 = listener
| param2type = bz_EventHandler*
| param2desc = The listener to remove.
}}

Template:Apicall/typelink

2008-12-15T04:37:08Z

Javawizard2539:

{{#switch:{{lc:{{{1}}}}}|const char*={{{1}}}|const char *={{{1}}}|int={{{1}}}|bool={{{1}}}|float={{{1}}}|[[{{{1}}}]]}}<noinclude>{{documentation}}</noinclude>

Template:Apicall/doc

2008-12-15T04:24:26Z

Javawizard2539:

<b>This documentation needs to be updated, due to some changes I've made in the template.</b>

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}

Template:Apicall/doc

2008-12-15T04:17:13Z

Javawizard2539:

<b>This documentation needs to be updated, due to some changes I've made in the template.</b>

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = int
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}

Template:Apicall/doc

2008-12-15T04:15:54Z

Javawizard2539:

<b>This documentation needs to be updated, due to some changes I've made in the template.</b>

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
}}

Template:Apicall/doc

2008-12-15T04:14:59Z

Javawizard2539:

<b>This documentation needs to be updated, due to some changes I've made in the template.</b>

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = bz_APIString
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}

Template:Apicall/typelink

2008-12-15T04:14:20Z

Javawizard2539: Undo revision 5242 by Javawizard2539 (Talk)

{{#switch:{{lc:{{{1}}}}}|const char*={{{1}}}|const char *={{{1}}}|int={{{1}}}|bool={{{1}}}|float={{{1}}}|[[{{{1}}}]]}}

Template:Apicall/doc

2008-12-15T04:13:57Z

Javawizard2539:

<b>This documentation needs to be updated, due to some changes I've made in the template.</b>

This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.

The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.

To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:

<pre>{{apicall
| name = bz_testApiCall
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| nopagelink =
}}
If we wanted a description for our call, we could do something like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink =
}}
Now let's say that our function takes some parameters. We can add those like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}</pre>

This would result in the following:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| nopagelink =
}}
We can also add documentation on the function's return value. This can be done like this:

<pre>{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}</pre>

Which results in this:

{{apicall
| name = bz_testApiCall
| description = This function does nothing, except that it accepts two numbers as inputs.
| param1 = theFirstParameter
| param1type = int
| param1desc = This number is the first number. It doesn't do anything.
| param2 = theSecondParameter
| param2type = int
| param2desc = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype = int
| returns = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
}}

Template:Apicall/typelink

2008-12-15T04:13:12Z

Javawizard2539: Replacing page with '{{{1}}}'

{{{1}}}

Template:Apicall

2008-12-15T04:12:36Z

Javawizard2539:

<tt>{{#if:{{{returns|}}}|{{apicall/typelink|{{{returntype}}}}}|void}} {{{name}}} ({{apicall/ifsigparam|{{{param1type|}}}|{{{param1|}}}}}{{apicall/ifnsigparam|{{{param2type|}}}|{{{param2|}}}}}{{apicall/ifnsigparam|{{{param3type|}}}|{{{param3|}}}}})</tt><br/>
<div style="border-left: 30px solid white; border-top: 1px solid white">
{{{description|<i>No description</i>}}}
{{#if:{{{param1|}}}{{{param2|}}}{{{param3|}}}{{{param4|}}}{{{param5|}}}{{{param6|}}}{{{param7|}}}{{{param8|}}}{{{param9|}}}{{{param10|}}}{{{param11|}}}{{{param12|}}}{{{param13|}}}{{{param14|}}}{{{param15|}}}{{{param16|}}}{{{param17|}}}{{{param18|}}}{{{param19|}}}{{{param20|}}}|<div style="border-top: 4px solid white; border-bottom: 3px solid white"><b>Parameters: </b></div>}}
{{apicall/ifparam|{{{param1|}}}|{{{param1desc|}}}}}{{apicall/ifparam|{{{param2|}}}|{{{param2desc|}}}}}{{apicall/ifparam|{{{param3|}}}|{{{param3desc|}}}}}{{apicall/ifparam|{{{param4|}}}|{{{param4desc|}}}}}{{apicall/ifparam|{{{param5|}}}|{{{param5desc|}}}}}{{apicall/ifparam|{{{param6|}}}|{{{param6desc|}}}}}{{apicall/ifparam|{{{param7|}}}|{{{param7desc|}}}}}{{apicall/ifparam|{{{param8|}}}|{{{param8desc|}}}}}{{apicall/ifparam|{{{param9|}}}|{{{param9desc|}}}}}{{apicall/ifparam|{{{param10|}}}|{{{param10desc|}}}}}{{apicall/ifparam|{{{param11|}}}|{{{param11desc|}}}}}{{apicall/ifparam|{{{param12|}}}|{{{param12desc|}}}}}{{apicall/ifparam|{{{param13|}}}|{{{param13desc|}}}}}{{apicall/ifparam|{{{param14|}}}|{{{param14desc|}}}}}{{apicall/ifparam|{{{param15|}}}|{{{param15desc|}}}}}{{apicall/ifparam|{{{param16|}}}|{{{param16desc|}}}}}{{apicall/ifparam|{{{param17|}}}|{{{param17desc|}}}}}{{apicall/ifparam|{{{param18|}}}|{{{param18desc|}}}}}{{apicall/ifparam|{{{param19|}}}|{{{param19desc|}}}}}{{apicall/ifparam|{{{param20|}}}|{{{param20desc|}}}}}{{#if:{{{returns|}}}|<div style="border-top: 4px solid white"><b>Returns: </b></div><div style="border-left: 30px solid white; border-top: 4px solid white">{{{returns}}}</div><br/>}}
</div><br/>{{#ifeq:{{{nopagelink|_NOT_HERE_}}}|_NOT_HERE_|[[Functions(API)|Function List]]}}<br/>
<noinclude>{{Documentation}}</noinclude>
<includeonly>
[[Category:BZFS API Functions]]
</includeonly>

Template:Apicall/typelink

2008-12-15T04:11:35Z

Javawizard2539:

{{#switch:{{lc:{{{1}}}}}|const char*={{{1}}}|const char *={{{1}}}|int={{{1}}}|bool={{{1}}}|float={{{1}}}|[[{{{1}}}]]}}