BZFlagWiki - User contributions [en]

Bz eReportFiledEvent

2015-11-04T22:13:49Z

Alezakos: fix inaccurate property

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eReportFiledEvent''' is an API event that is called each time a
player or plugin files a report.

==Data==
'''bz_eReportFiledEvent''' returns the
'''bz_ReportFiledEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eReportFiledEvent
|-
|from
|[[bz_ApiString]]
|The callsign of the player that is filing the report.
|-
|message
|[[bz_ApiString]]
|The report message that is filed.
|-
|eventTime
|double
|Time of event.
|}

==Uses==
This event is a notification-only event, none of the data returned can
be changed.

[[Category:BZFS_API_Docs]]
[[Category:BZFS_API_Events]]

Server Variables

2015-09-30T09:18:44Z

Alezakos: Add notes about _reloadTime resets

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 <small>(run <code>/reset _reloadTime</code> after setting _shotRange to avoid this)</small>.
|-
| _shotSpeed || 100 || Speed of shots. If you're experiencing issues after changing the value of this variable (e.g. players not shooting or shots not killing), you should call <code>/reset _reloadTime</code>.
|-
| _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]]

Bz getCountdownRemaining

2015-09-25T09:16:11Z

Alezakos: Created page with "{{apicall | name = bz_getCountdownProgress | returns = The amount of time remaining in a match in seconds, or <code>-1</code> if a match is not currently in pro..."

{{apicall
| name = bz_getCountdownProgress
| returns = The amount of time remaining in a match in seconds, or <code>-1</code> if a match is not currently in progress.
| returntype = int
| description = Retrieves the time remaining in a running countdown.
}}

===Example===
Display the remaining time to a user upon joining.
case bz_ePlayerJoinEvent: {
int player = (bz_PlayerJoinPartEventData_V1*)eventData)->playerID;
if (bz_isCountDownActive()) {
bz_sendTextMessagef(BZ_SERVER, player,
"Welcome! The current match will finish in %d seconds!", bz_getCountdownProgress());
} else {
bz_sendTextMessage(BZ_SERVER, player,
"Welcome! No match is currently running.");
}
}break;

Functions (API)

2015-09-25T09:08:13Z

Alezakos: /* Timed Game Management */ Add new bz_getCountdownProgress() function

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future API functions.
}}

{{BZFS_API_Doc|keeptitle=1}}

== 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_isPlayerSpawnable]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
BZF_API bool [[bz_getPlayerSpawnAtBase]] ( int playerId );
BZF_API bool [[bz_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API void [[bz_setPlayerSpawnAtBase]] ( int playerId, bool base );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerBySlotOrCallsign]] ( const char* name );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

Unknown
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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_incrementTeamWins]] (bz_eTeamType team, int increment);
BZF_API void [[bz_incrementTeamLosses]] (bz_eTeamType team, int increment);
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 ===
2.3+
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 bool [[bz_incrementPlayerWins]] (int playerId, int increment)
BZF_API bool [[bz_incrementPlayerLosses]] (int playerId, int increment);
BZF_API bool [[bz_incrementPlayerTKs]] (int playerId, int increment);
BZF_API int [[bz_getPlayerWins]] ( int playerId );
BZF_API int [[bz_getPlayerLosses]] ( int playerId );
BZF_API int [[bz_getPlayerTKs]] ( int playerId );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

=== Latency Information ===
2.3+
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );
BZF_API int [[bz_getIdleTime]] ( int playerId );
BZF_API int [[bz_getPausedTime]] ( int playerId );

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_getShotMismatch]] ( void );
BZF_API void [[bz_setShotMismatch]] ( bool value );
BZF_API bool [[bz_isAutoTeamEnabled]] ( void );
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API int [[bz_getPlayerFlagID]] ( int playerID );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3] );
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 );

=== Shot Management ===
2.4.5+
BZF_API uint32_t [[bz_getShotMetaData]] (int fromPlayer, int shotID, const char* name);
BZF_API void [[bz_setShotMetaData]] (int fromPlayer, int shotID , const char* name, uint32_t value);
BZF_API bool [[bz_shotHasMetaData]] (int fromPlayer, int shotID , const char* name);
BZF_API uint32_t [[bz_getShotGUID]] (int fromPlayer, int shotID);

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

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

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

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

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

== See also ==
* [[BZFS API]]
* [[Event(API)|BZFS API Events]]
* [[Plug-ins]]

[[Category:BZFS_API_Functions]]

BZFS API

2015-08-22T10:19:54Z

Alezakos: Update links to API events/functions documentation

{{DoDoc|
Update to 2.4.x spec<br>
}}

The BZFS API (Application Programmers Interface) is a set of C++ functions, structures, and classes that is exported by [[BZFS]] to be used by [[Plug-ins]]. The API provides access to the various states and data structures of a running BZFS game and is the primary method of communication between a plug-in and the game server.

==Overview==
The BZFS API is defined entirely in the '''bzfsAPI.h''' header file that is part of the [[BZFlag Source]] code. The header is also included with each install of the BZFlag installer for Microsoft Windows.

Plug-ins include this file in their source code so that they may access the functions it contains.

==Naming Conventions==
All BZFS API code structures will begin with the prefix '''bz''' or '''bz_''' for clarification and to prevent conflicts with names of code structures inside BZFS or any plug-ins.

All wiki documentation references the newer BZFS 3.0 API.

==API Versions==
The API was added in version 2.0.4 of BZFlag. While working well for many users, it was found to be lacking in a number of features that would make make it difficult for plug-ins to run when the API itself was changed.

In version 3.0 of BZFlag, the entire API will be versioned and set up to use derived classes so that plug-ins written to use an older version of the API will work in newer versions of the software. Newer data structures will be put into further derived classes and would not be seen by the older plug-in. Due to this change a large number of API functions changed in name. This change causes all older 2.0.x plug-ins to no longer work with out minor source code changes. Once an older plug-in has been updated to the new API it will not work in 2.0.x but will work in all versions after 3.0.

==Entry Points==
There are 3 primary entry points into each plug-in. These entry points are the 3 core functions that every plug-in must implement.

BZF_PLUGIN_CALL int [[bz_Load]] ( const char* command );
BZF_PLUGIN_CALL int [[bz_Unload]] ( void );
BZF_PLUGIN_CALL int [[bz_GetVersion]] ( void );

All entry point functions must be preceded with the BZF_PLUGIN_CALL macro. This macro tells the compiler to export these functions so bzfs can find them when the plug-in is loaded.

[[bz_Load]] is called when the plug-in is first initialized. This is when the plug-in should register any [[Event(API)|event handlers]] needed and initialize any "one time" startup data.

[[bz_Unload]] is called when a plug-in is no longer needed and will be shut down. This is most commonly called when bzfs is shutting down, or when a plug-in is unloaded manualy.

[[bz_GetVersion]] is called by bzfs before any other functions are called. The function should return the version of the API that it is written for. This is to prevent bzfs from attempting to load plug-ins that use a newer incompatible API.

'''bzfsAPI.h''' defines a C MACRO to help ease the implementation of this function. All a plug-in must do is put the macro;

BZ_GET_PLUGIN_VERSION

somewhere in its sources, and then export the function. This will automatically return the API version that the plug-in was compiled with.

See the sample plug-ins for examples of each function. These will be the only 3 functions called by bzfs that are not tied to events or other actions installed by the plug-in after load.

==Types==

Due to how Microsoft Windows handles memory access between an application and dynamically loaded Libaries(DLLs), there are a few custom data types that are used in the API. These are used for common STL style containers, for strings and lists.

===bz_APIString===
Any text passed back from the API or events will come in the form of a [[bz_APIString]]. This is a class defined in the API that behaves much like a std::string. The 'c_str()' method can be used to get the text out as a normal 'const char*'. The class also supports many assignment functions for setting it's contents.

A plug-in should never need to make variables of its' own using the [[bz_APIString]] type, but should use a standard stl std::string instead, [[bz_APIString]] provides an appropriate assignment operator.

[[bz_APIString]] also includes some utility functions such as replace all and tokenize that are commonly needed by plug-ins.

{{main|bz_APIString}}

===bz_APILists===

A few API functions require lists of integers, strings, or floats. For these functions the plug-in will need to use one of the following list classes. These classes are similar to the std::vector in implementation. When a plug-in needs to allocate one of these lists, it must use the appropriate allocator function, so BZFS can make a new list for the plug-in to use. These will return a pointer to a new list for the plug-in to use. When the plug-in is finished with the list, it needs to tell BZFS to delete the list with a call to the appropriate delete function.
The lists types are;
{| border="1" cellpadding="3" cellspacing="0"
!List
!allocator function
!delete function
!contained type
|-
|[[bz_APIIntList]]
|[[bz_newIntList]]
|[[bz_deleteIntList]]
|int
|-
|[[bz_APIFloatList]]
|[[bz_newFloatList]]
|[[bz_deleteFloatList]]
|float
|-
|[[bz_APIStringList]]
|[[bz_newStringList]]
|[[bz_deleteStringList]]
|[[bz_APIString]]
|}

===Enumerations===
A number of enumerations exist in the API and are used by a number of API functions and events.
[[bz_eTeamType]]
[[Event(API)|bz_eEventType]]
[[bz_eShotType]]
[[bz_eGameType]]
[[bz_ePlayerStatus]]
[[bz_eWorldObjectType]]
[[bz_eAPIColType]]
[[bz_ePlayerType]]
[[bz_eRejectCodes]]
[[bz_ePlayerDeathReason]]

==Events==
Plug-ins can register callbacks so they can be notified of various actions and state changes in the current BZFS game. These events tell a plug-in when important things happen, such as when a player has spawned, or is killed. These events are the primary form of communication from the BZFS server into the plug-in.

{{main|Events (API)}}

==Functions==
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.

{{main|Functions (API)}}

==Wiki Documentation==
The documentation for the API provided on this wiki is mostly concerned with the current development version of the software. There have been changes over time to the API. Any changes to classes and functions will be noted in the new documentation under a ''History'' section. In general the initial API that was released with the 2.0.x product line was not consistent, and many of these inconsistencies are being worked out with newer versions of the API (3.0 and later)

API developers should use the bzfsAPI.h file as for exact spellings of methods and parameters in the version they wish to use.

==See Also==

* [[Events (API)|API Events]]
* [[Functions (API)|API Functions]]
* [[Plug-ins]]
* [[BZFS]]

[[Category:Development]]
[[Category:Plug-Ins]]

Event(API)

2015-08-22T10:18:42Z

Alezakos: Alezakos moved page Event(API) to Events (API)

#REDIRECT [[Events (API)]]

Events (API)

2015-08-22T10:18:42Z

Alezakos: Alezakos moved page Event(API) to Events (API)

{{BZFS_API_Doc|keeptitle=1}}
==Overview==
API events are callbacks that a [[Plug-ins|plug-in]] can install into [[BZFS]] to be called in response to specific actions or state changes in the server side game world. Events are the primary method of communication from BZFS to installed plug-ins. Specific events exist for nearly all logical actions that can happen during a game of BZFlag.

==Installation and Removal==
The callbacks for events are typically installed during the [[bz_Load]] (2.0.x) or [[Init]] (2.4+) entry point in a plug-in, so they can be active when a plug-in is first loaded.

The plug-in must call the function;

2.0.x
BZF_API bool [[bz_registerEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

2.4+
Register ( bz_eEventType );

The plug-in registers and event callback derived from [[bz_EventHandler]] (2.0.x) or [[bz_Plugin]] (2.4+) for each specific event types it wishes to monitor.

When a plug-in no longer needs to monitor an event, or when it is unloaded in the [[bz_Unload]] (2.0.x) or [[Cleanup]] (2.4+) entry point, the plug-in must remove the installed callback by calling the function;

2.0.x
BZF_API bool [[bz_removeEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

2.4+
Flush();

In BZFlag 2.4, events are no longer removed individually but instead they are all removed automatically by calling on the 'Flush()' method.

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] (2.0.x) or [[bz_Plugin]] (2.4+) and pass a pointer to an object of that class when ever it registers an event callback.

When ever a specific event is triggered, BZFS will call the 'process' (2.0.x) or 'Event' (2.4+) method of the installed callback class.

2.0.x
virtual void process ( bz_EventData *eventData ) = 0;

2.4+
virtual void Event ( bz_EventData *eventData ) = 0;

==Event Data==
With each call to the 'process' method of the installed event handler, BZFS will pass the plug-in a pointer to a class that contains all the data provided by the event. Each event derives a specific data class from [[bz_EventData]] that contains the specific member variables that contain the data. The base class [[bz_EventData]] contains the data member;
bz_eEventType eventType;
This data member allows a plug-in to identify the specific event and cast the 'bz_EventData' pointer to the appropriate specific data class. This is usefull for plug-ins that use the same 'bz_EventHandler' to process more then one specific message.

Please see the descriptions of each specific event for information and descriptions of the data classes for each event. Some specific events allow plug-ins to change the values of data members in the data class and will use the modified values instead.

Plug-ins should never delete or free the memory for a data class. BZFS will manage all pointers passed to plug-ins.

==Events==
The following list contains all the event types currently supported by BZFS version 2.99

[[bz_eAllowAutoPilotChangeEvent]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eAllowPlayer]]
[[bz_eAllowSpawn]]
[[bz_eAnointRabbitEvent]]
[[bz_eAutoPilotChangeEvent]]
[[bz_eBZDBChange]]
[[bz_eBanEvent]]
[[bz_eCaptureEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagResetEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameStartEvent|bz_eGameEndEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetWorldEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eHostBanNotifyEvent]]
[[bz_eIdBanEvent]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_eListServerUpdateEvent]]
[[bz_eLogingEvent]]
[[bz_eLuaDataEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eNetDataReceiveEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eNewRabbitEvent]]
[[bz_eNullEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_ePlayerCollision]]
[[bz_ePlayerCustomDataChanged]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_ePlayerPauseRequestEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_ePlayerSentCustomData]]
[[bz_ePlayerSpawnEvent]]
[[bz_ePlayerTeamChangeEvent]]
[[bz_ePlayerUpdateDoneEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eReloadEvent]]
[[bz_eReportFiledEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotEndedEvent]]
[[bz_eShotExpiredEvent]]
[[bz_eShotFiredEvent]]
[[bz_eShotRicochetEvent]]
[[bz_eShotStoppedEvent]]
[[bz_eShotTeleportEvent]]
[[bz_eSlashCommandEvent]]
[[bz_eTeleportEvent]]
[[bz_eTickEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eWorldFinalized]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]

The following list contains all the event types currently supported by BZFS version 2.4
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrab]]
[[bz_eAllowPlayer]]
[[bz_eAllowSpawn]]
[[bz_eBanEvent]]
[[bz_eBZDBChange]]
[[bz_eCaptureEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eGameEndEvent]]
[[bz_eGamePauseEvent]]
[[bz_eGameResumeEvent]]
[[bz_eGameStartEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eGetPlayerMotto]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetWorldEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_eListServerUpdateEvent]]
[[bz_eLoggingEvent]]
[[bz_eMsgDebugEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eNetDataReceiveEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_ePlayerAuthEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_ePlayerScoreChanged]]
[[bz_ePlayerSpawnEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_ePluginLoaded]]
[[bz_ePluginUnloaded]]
[[bz_eRawChatMessageEvent]]
[[bz_eReportFiledEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotEndedEvent]]
[[bz_eShotFiredEvent]]
[[bz_eSlashCommandEvent]]
[[bz_eTeamScoreChanged]]
[[bz_eTickEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eWorldFinalized]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]

There exists one additional event in the 'bz_eEventType' enumeration in 'bzfsAPI.h', ''bz_eLastEvent''. This event is simply used by BZFS to assist in the counting of the total number of events, it will never be called and can not be installed.

== See also ==
* [[BZFS API]]
* [[Functions(API)|BZFS API Functions]]
* [[Plug-ins]]

[[Category:BZFS_API_Functions]]

Functions(API)

2015-08-22T10:18:09Z

Alezakos: Alezakos moved page Functions(API) to Functions (API) over redirect

#REDIRECT [[Functions (API)]]

Functions (API)

2015-08-22T10:18:09Z

Alezakos: Alezakos moved page Functions(API) to Functions (API) over redirect

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future API functions.
}}

{{BZFS_API_Doc|keeptitle=1}}

== 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_isPlayerSpawnable]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
BZF_API bool [[bz_getPlayerSpawnAtBase]] ( int playerId );
BZF_API bool [[bz_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API void [[bz_setPlayerSpawnAtBase]] ( int playerId, bool base );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerBySlotOrCallsign]] ( const char* name );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

Unknown
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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_incrementTeamWins]] (bz_eTeamType team, int increment);
BZF_API void [[bz_incrementTeamLosses]] (bz_eTeamType team, int increment);
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 ===
2.3+
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 bool [[bz_incrementPlayerWins]] (int playerId, int increment)
BZF_API bool [[bz_incrementPlayerLosses]] (int playerId, int increment);
BZF_API bool [[bz_incrementPlayerTKs]] (int playerId, int increment);
BZF_API int [[bz_getPlayerWins]] ( int playerId );
BZF_API int [[bz_getPlayerLosses]] ( int playerId );
BZF_API int [[bz_getPlayerTKs]] ( int playerId );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

=== Latency Information ===
2.3+
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );
BZF_API int [[bz_getIdleTime]] ( int playerId );
BZF_API int [[bz_getPausedTime]] ( int playerId );

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_getShotMismatch]] ( void );
BZF_API void [[bz_setShotMismatch]] ( bool value );
BZF_API bool [[bz_isAutoTeamEnabled]] ( void );
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API int [[bz_getPlayerFlagID]] ( int playerID );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3] );
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 );

=== Shot Management ===
2.4.5+
BZF_API uint32_t [[bz_getShotMetaData]] (int fromPlayer, int shotID, const char* name);
BZF_API void [[bz_setShotMetaData]] (int fromPlayer, int shotID , const char* name, uint32_t value);
BZF_API bool [[bz_shotHasMetaData]] (int fromPlayer, int shotID , const char* name);
BZF_API uint32_t [[bz_getShotGUID]] (int fromPlayer, int shotID);

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

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
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 bool [[bz_isCountDownPaused]] ( void );
BZF_API void [[bz_pauseCountdown]] ( int playerID );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( int playerID );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, int playerID );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );
BZF_API void [[bz_cancelCountdown]] ( int playerID );
BZF_API void [[bz_cancelCountdown]] ( const char *canceledBy );

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

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

== See also ==
* [[BZFS API]]
* [[Event(API)|BZFS API Events]]
* [[Plug-ins]]

[[Category:BZFS_API_Functions]]

Plug-ins

2015-08-22T10:14:56Z

Alezakos: /* Third Party Plug-ins */ Update the guide to build 3rd-party plugins for 2.4.3

BZFS can be built to support the loading of external libraries as plug-ins. These plug-ins can alter or replace the logic applied by the server, as well as automate many common tasks.

Plug-ins are one of the more popular ways to apply modifications to the game. They do not require modifications of the BZFS application source code so it can be kept up to date with out the need to constantly apply patches. They have also proven to be a very simple method for distributing modifications from developers to players.

==Overview==
Plug-ins are compiled dynamic link libraries, that are built for the same OS/RuntimeEnvironment as the BZFS server that hosts them. On [http://www.microsoft.com/windows Microsoft Windows] they are built as [http://en.wikipedia.org/wiki/Dynamic-link_library DLL] files. On [http://www.linux.org Linux] and other [http://www.unix.org/ Unix]-like systems they are built as .so files.

==Use==
Plug-ins are loaded at startup by the '''-loadplugin''' option, or at run time with the ''/loadplugin'' command. If the full path to the plug-in is not specified, then [[BZFS]] will search a number of known sub directories for the plug-in as it attempts to load it. Using a valid path to the plug-in on load is highly recommended. While playing, all plug-ins loaded onto the server are visible with the /listplugins command.
===Parameters===
Some plug-ins take parameters that are passed to the plug-in on load. This is often a numeric value, or a path to a file. To pass a parameter to a plug-in, simply add a ',' after the plug-in name or path, and then add the parameter. Parameters can not have spaces, due to the way [[BZFS]] parses command line options and / commands.

On load, plug-ins install a number of callbacks and event handlers with the hosting [[BZFS]] that are called when specific events happen. This allows the plug-in to perform additional actions on these events, or if need be, alter the results of the default logic of the server.
===Search Paths===
[[BZFS]] searches for plug-ins in two standard locations: the config directory and the global plug-ins directory. The config directory is where the BZFlag config.cfg file is located, and the global plug-ins directory is $(prefix)/lib/bzflag/.

==BZFS API==
All plug-ins are linked to the [[BZFS API]]. This programing layer provides the interface to the BZFS application. All events and functions that a plug-in can call are in the [[BZFS API]].

==Standard plug-ins==
The [[BZFlag Source]] distribution contains a number of plug-ins that are maintained by the project [[:Category:Developer|developers]].
These plug-ins are located in the ''/plugins'' directory.

As of March 2013, [[BZFlag SVN|SVN]] TRUNK contains the following plug-ins:

*[[airspawn]]
*[[autoFlagReset]]
*[[bzfscron]]
*[[chathistory]]
*[[customflagsample]]
*[[fairCTF]]
*[[fastmap]]
*[[flagStay]]
*[[hiddenAdmin]]
*[[HoldTheFlag]]
*[[keepaway]]
*[[killall]]
*[[koth]]
*[[logDetail]]
*[[nagware]]
*[[Phoenix]]
*[[playHistoryTracker]]
*[[plugin_utils]]
*[[pushstats]]
*[[rabbitTimer]]
*[[rabidRabbit]]
*[[recordmatch]]
*[[regFlag]]
*[[RogueGenocide]]
*[[SAMPLE_PLUGIN]]
*[[serverControl]]
*[[serverSidePlayerSample]]
*[[shockwaveDeath]]
*[[superUser]]
*[[teamflagreset]]
*[[thiefControl]]
*[[timedctf]]
*[[TimeLimit]]
*[[webReport]]
*[[webstats]]
*[[wwzones]]

==Third Party Plug-ins==
A number of non-developers have created plug-ins for BZFS, and usually release them on the [http://my.bzflag.org/bb/ BZFlag Forums].

=== On Linux ===

Here are the steps to compile a hypothetical third party plug-in named "Example":

==== For versions older than 2.4.3 ====

# In the plugins directory of the BZFlag source tree run the command '''./newplug.sh Example'''
# Remove all of the files from the newly created plugins/Example directory (they were created by newplug.sh)
# Copy all of the distributed Example files into the plugins/Example directory
# In the top-level BZFlag source directory run '''autogen.sh''', '''configure''', and '''make''' as usual

==== For versions on or after 2.4.3 ====

# Store the distributed plugin files into the plugins/''Example'' directory
# In the top-level BZFlag source directory run:
<div style="margin-left: 45px;">
./autogen.sh
./configure --enable-custom-plugins=''Example''
./make

Note that you can use a comma-separated list to specify multiple plugins to be built:
./configure --enable-custom-plugins=''Example'',''AnotherExample'',''AnotherPlugin''
</div>
When that finishes successfully the plug-in should be ready to use as described above.

=== On Mac OS X ===

In Xcode on Mac OS X, follow these instructions:

# Create a new target for your plug-in.
#* '''Xcode 5 (and below)''': Click on the BZFlag project name in the project navigator. Click Add Target, and create a new C/C++ Library. Name the plugin, and select "Dynamic" for type.
#* '''Xcode 6''': Click on the BZFlag project in the project navigator. Go the File > New > Target. When prompted for the template for the target, under the "OS X" section, select the "Framework & Library" section and finally select "Library." In the next dialog, select "None (Plain C/C++ Library)" for the Framework and "Dynamic" for the type.
# In the project navigator, move the new library target from the bottom of the screen into the "Targets" group.
# Click on the BZFlag project name in the project navigator again. In the list of targets, select the BZFlag application target. In the Build Phases tab, in the Target Dependencies pane, add your new library target as a dependency of the application target. Also add it to the Copy Files phase for the PlugIns directory.
# Select your new library target. Select the Build Settings tab, and locate the Other Linker Flags option. Add the option "-undefined dynamic_lookup"
# Find the Architecture build setting for your new library. Make sure it is the same architecture as the main codebase, or click Levels, click the Architecture setting under your library target, click Other, and delete the setting. This will make it assume the overall project build architecture.
# Find the Executable Prefix build setting for your new library, and delete the "lib" setting.
# Add your source file(s) to the project, and make them members of your library target.
# Build as usual.

==Preparing a Linux BZFS==

In order to run plugins in BZFS, you need to recompile it with the --enable-shared option on the configure script.

''Note that as of 2.4.0 the BZFlag configuration has --enable-shared automatically enabled.''

$ ./configure --enable-shared --disable-client;
make;
make install;

==Plug-in Development==
{{DoDoc|Describe the basics of plug-in development.}}

==History==
The plug-in system was added in BZFlag V. 2.0.4 and was initially met with a lukewarm reception by some of the core developers and the maintainer. The community has since embraced the concept and built a multitude of useful modifications, many that have been incorporated into the project as standard plug-ins.

For Version 3.0 major changes to the [[BZFS API]] have been made to increase its lifespan.

[[Category:Server]]
[[Category:Development]]
[[Category:Plug-Ins]]

Template:Apicall

2015-08-22T09:27:45Z

Alezakos: Show the function's underscore on the title

<includeonly>{{DISPLAYTITLE:{{{name}}}}}</includeonly><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:{{{deprecated|}}}|<b>Deprecated API Version:</b> {{{deprecated|}}} <br>}}
{{#if:{{{removed|}}}|<b>Removed API Version:</b> {{{removed|}}} <br>}}
{{#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>
<noinclude>{{Documentation}}</noinclude>
<includeonly>
[[Category:BZFS API Functions]]
</includeonly>

Events (API)

2015-08-22T09:26:30Z

Alezakos: /* See also */ fix red link

Events (API)

2015-08-22T09:25:09Z

Alezakos: /* See also */ Add link to functions

{{BZFS_API_Doc|keeptitle=1}}
==Overview==
API events are callbacks that a [[Plug-ins|plug-in]] can install into [[BZFS]] to be called in response to specific actions or state changes in the server side game world. Events are the primary method of communication from BZFS to installed plug-ins. Specific events exist for nearly all logical actions that can happen during a game of BZFlag.

==Installation and Removal==
The callbacks for events are typically installed during the [[bz_Load]] (2.0.x) or [[Init]] (2.4+) entry point in a plug-in, so they can be active when a plug-in is first loaded.

The plug-in must call the function;

2.0.x
BZF_API bool [[bz_registerEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

2.4+
Register ( bz_eEventType );

The plug-in registers and event callback derived from [[bz_EventHandler]] (2.0.x) or [[bz_Plugin]] (2.4+) for each specific event types it wishes to monitor.

When a plug-in no longer needs to monitor an event, or when it is unloaded in the [[bz_Unload]] (2.0.x) or [[Cleanup]] (2.4+) entry point, the plug-in must remove the installed callback by calling the function;

2.0.x
BZF_API bool [[bz_removeEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

2.4+
Flush();

In BZFlag 2.4, events are no longer removed individually but instead they are all removed automatically by calling on the 'Flush()' method.

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] (2.0.x) or [[bz_Plugin]] (2.4+) and pass a pointer to an object of that class when ever it registers an event callback.

When ever a specific event is triggered, BZFS will call the 'process' (2.0.x) or 'Event' (2.4+) method of the installed callback class.

2.0.x
virtual void process ( bz_EventData *eventData ) = 0;

2.4+
virtual void Event ( bz_EventData *eventData ) = 0;

==Event Data==
With each call to the 'process' method of the installed event handler, BZFS will pass the plug-in a pointer to a class that contains all the data provided by the event. Each event derives a specific data class from [[bz_EventData]] that contains the specific member variables that contain the data. The base class [[bz_EventData]] contains the data member;
bz_eEventType eventType;
This data member allows a plug-in to identify the specific event and cast the 'bz_EventData' pointer to the appropriate specific data class. This is usefull for plug-ins that use the same 'bz_EventHandler' to process more then one specific message.

Please see the descriptions of each specific event for information and descriptions of the data classes for each event. Some specific events allow plug-ins to change the values of data members in the data class and will use the modified values instead.

Plug-ins should never delete or free the memory for a data class. BZFS will manage all pointers passed to plug-ins.

==Events==
The following list contains all the event types currently supported by BZFS version 2.99

[[bz_eAllowAutoPilotChangeEvent]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eAllowPlayer]]
[[bz_eAllowSpawn]]
[[bz_eAnointRabbitEvent]]
[[bz_eAutoPilotChangeEvent]]
[[bz_eBZDBChange]]
[[bz_eBanEvent]]
[[bz_eCaptureEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagResetEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameStartEvent|bz_eGameEndEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetWorldEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eHostBanNotifyEvent]]
[[bz_eIdBanEvent]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_eListServerUpdateEvent]]
[[bz_eLogingEvent]]
[[bz_eLuaDataEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eNetDataReceiveEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eNewRabbitEvent]]
[[bz_eNullEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_ePlayerCollision]]
[[bz_ePlayerCustomDataChanged]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_ePlayerPauseRequestEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_ePlayerSentCustomData]]
[[bz_ePlayerSpawnEvent]]
[[bz_ePlayerTeamChangeEvent]]
[[bz_ePlayerUpdateDoneEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eReloadEvent]]
[[bz_eReportFiledEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotEndedEvent]]
[[bz_eShotExpiredEvent]]
[[bz_eShotFiredEvent]]
[[bz_eShotRicochetEvent]]
[[bz_eShotStoppedEvent]]
[[bz_eShotTeleportEvent]]
[[bz_eSlashCommandEvent]]
[[bz_eTeleportEvent]]
[[bz_eTickEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eWorldFinalized]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]

The following list contains all the event types currently supported by BZFS version 2.4
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrab]]
[[bz_eAllowPlayer]]
[[bz_eAllowSpawn]]
[[bz_eBanEvent]]
[[bz_eBZDBChange]]
[[bz_eCaptureEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eGameEndEvent]]
[[bz_eGamePauseEvent]]
[[bz_eGameResumeEvent]]
[[bz_eGameStartEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eGetPlayerMotto]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetWorldEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_eListServerUpdateEvent]]
[[bz_eLoggingEvent]]
[[bz_eMsgDebugEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eNetDataReceiveEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_ePlayerAuthEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_ePlayerScoreChanged]]
[[bz_ePlayerSpawnEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_ePluginLoaded]]
[[bz_ePluginUnloaded]]
[[bz_eRawChatMessageEvent]]
[[bz_eReportFiledEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotEndedEvent]]
[[bz_eShotFiredEvent]]
[[bz_eSlashCommandEvent]]
[[bz_eTeamScoreChanged]]
[[bz_eTickEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eWorldFinalized]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]

There exists one additional event in the 'bz_eEventType' enumeration in 'bzfsAPI.h', ''bz_eLastEvent''. This event is simply used by BZFS to assist in the counting of the total number of events, it will never be called and can not be installed.

== See also ==
* [[BZFS API]]
* [[Function(API)|BZFS API Functions]]
* [[Plug-ins]]

[[Category:BZFS_API_Functions]]

Functions (API)

2015-08-22T09:24:05Z

Alezakos: /* See also */ Add link to events

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future API functions.
}}

{{BZFS_API_Doc|keeptitle=1}}

== 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_isPlayerSpawnable]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
BZF_API bool [[bz_getPlayerSpawnAtBase]] ( int playerId );
BZF_API bool [[bz_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API void [[bz_setPlayerSpawnAtBase]] ( int playerId, bool base );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerBySlotOrCallsign]] ( const char* name );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

Unknown
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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_incrementTeamWins]] (bz_eTeamType team, int increment);
BZF_API void [[bz_incrementTeamLosses]] (bz_eTeamType team, int increment);
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 ===
2.3+
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 bool [[bz_incrementPlayerWins]] (int playerId, int increment)
BZF_API bool [[bz_incrementPlayerLosses]] (int playerId, int increment);
BZF_API bool [[bz_incrementPlayerTKs]] (int playerId, int increment);
BZF_API int [[bz_getPlayerWins]] ( int playerId );
BZF_API int [[bz_getPlayerLosses]] ( int playerId );
BZF_API int [[bz_getPlayerTKs]] ( int playerId );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

=== Latency Information ===
2.3+
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );
BZF_API int [[bz_getIdleTime]] ( int playerId );
BZF_API int [[bz_getPausedTime]] ( int playerId );

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_getShotMismatch]] ( void );
BZF_API void [[bz_setShotMismatch]] ( bool value );
BZF_API bool [[bz_isAutoTeamEnabled]] ( void );
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API int [[bz_getPlayerFlagID]] ( int playerID );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3] );
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 );

=== Shot Management ===
2.4.5+
BZF_API uint32_t [[bz_getShotMetaData]] (int fromPlayer, int shotID, const char* name);
BZF_API void [[bz_setShotMetaData]] (int fromPlayer, int shotID , const char* name, uint32_t value);
BZF_API bool [[bz_shotHasMetaData]] (int fromPlayer, int shotID , const char* name);
BZF_API uint32_t [[bz_getShotGUID]] (int fromPlayer, int shotID);

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

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
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 bool [[bz_isCountDownPaused]] ( void );
BZF_API void [[bz_pauseCountdown]] ( int playerID );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( int playerID );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, int playerID );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );
BZF_API void [[bz_cancelCountdown]] ( int playerID );
BZF_API void [[bz_cancelCountdown]] ( const char *canceledBy );

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

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
BZF_API int [[bz_addServerSidePlayer]] ( [[bz_ServerSidePlayerHandler]] *handler );
BZF_API bool [[bz_removeServerSidePlayer]] ( int playerID, [[bz_ServerSidePlayerHandler]] *handler );

== See also ==
* [[BZFS API]]
* [[Event(API)|BZFS API Events]]
* [[Plug-ins]]

[[Category:BZFS_API_Functions]]

Template:BZFS API Doc

2015-08-22T09:22:16Z

Alezakos: Remove rogue bracket

<includeonly>{{#if:{{{keeptitle|}}}||{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:|}}{{lcfirst:{{PAGENAME}}}}}}}}</includeonly>
{|style="width:100%;margin-top:+.7em;"
||'''BZFS API Documentation''' This page contains part of the [[BZFS API]] documentation for use by [[Plug-ins]] on the [[BZFS]] server.
|}
<includeonly>[[Category:BZFS_API_Docs]]</includeonly>
<noinclude><br>Adding this template to a page will automatically add the page to the [[:Category:BZFS_API_Docs|Category:BZFS_API_Docs]] page. To use this template add '''<nowiki>{{BZFS_API_Doc}}</nowiki>''' at the top of the page you are creating/editing.</noinclude>

Events (API)

2015-08-22T09:21:14Z

Alezakos: Properly capitalise the title of the page

{{BZFS_API_Doc|keeptitle=1}}
==Overview==
API events are callbacks that a [[Plug-ins|plug-in]] can install into [[BZFS]] to be called in response to specific actions or state changes in the server side game world. Events are the primary method of communication from BZFS to installed plug-ins. Specific events exist for nearly all logical actions that can happen during a game of BZFlag.

==Installation and Removal==
The callbacks for events are typically installed during the [[bz_Load]] (2.0.x) or [[Init]] (2.4+) entry point in a plug-in, so they can be active when a plug-in is first loaded.

The plug-in must call the function;

2.0.x
BZF_API bool [[bz_registerEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

2.4+
Register ( bz_eEventType );

The plug-in registers and event callback derived from [[bz_EventHandler]] (2.0.x) or [[bz_Plugin]] (2.4+) for each specific event types it wishes to monitor.

When a plug-in no longer needs to monitor an event, or when it is unloaded in the [[bz_Unload]] (2.0.x) or [[Cleanup]] (2.4+) entry point, the plug-in must remove the installed callback by calling the function;

2.0.x
BZF_API bool [[bz_removeEvent]] ( bz_eEventType eventType, [[bz_EventHandler]]* eventHandler );

2.4+
Flush();

In BZFlag 2.4, events are no longer removed individually but instead they are all removed automatically by calling on the 'Flush()' method.

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] (2.0.x) or [[bz_Plugin]] (2.4+) and pass a pointer to an object of that class when ever it registers an event callback.

When ever a specific event is triggered, BZFS will call the 'process' (2.0.x) or 'Event' (2.4+) method of the installed callback class.

2.0.x
virtual void process ( bz_EventData *eventData ) = 0;

2.4+
virtual void Event ( bz_EventData *eventData ) = 0;

==Event Data==
With each call to the 'process' method of the installed event handler, BZFS will pass the plug-in a pointer to a class that contains all the data provided by the event. Each event derives a specific data class from [[bz_EventData]] that contains the specific member variables that contain the data. The base class [[bz_EventData]] contains the data member;
bz_eEventType eventType;
This data member allows a plug-in to identify the specific event and cast the 'bz_EventData' pointer to the appropriate specific data class. This is usefull for plug-ins that use the same 'bz_EventHandler' to process more then one specific message.

Please see the descriptions of each specific event for information and descriptions of the data classes for each event. Some specific events allow plug-ins to change the values of data members in the data class and will use the modified values instead.

Plug-ins should never delete or free the memory for a data class. BZFS will manage all pointers passed to plug-ins.

==Events==
The following list contains all the event types currently supported by BZFS version 2.99

[[bz_eAllowAutoPilotChangeEvent]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eAllowPlayer]]
[[bz_eAllowSpawn]]
[[bz_eAnointRabbitEvent]]
[[bz_eAutoPilotChangeEvent]]
[[bz_eBZDBChange]]
[[bz_eBanEvent]]
[[bz_eCaptureEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagResetEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameStartEvent|bz_eGameEndEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetWorldEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eHostBanNotifyEvent]]
[[bz_eIdBanEvent]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_eListServerUpdateEvent]]
[[bz_eLogingEvent]]
[[bz_eLuaDataEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eNetDataReceiveEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eNewRabbitEvent]]
[[bz_eNullEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_ePlayerCollision]]
[[bz_ePlayerCustomDataChanged]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_ePlayerPauseRequestEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_ePlayerSentCustomData]]
[[bz_ePlayerSpawnEvent]]
[[bz_ePlayerTeamChangeEvent]]
[[bz_ePlayerUpdateDoneEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eReloadEvent]]
[[bz_eReportFiledEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotEndedEvent]]
[[bz_eShotExpiredEvent]]
[[bz_eShotFiredEvent]]
[[bz_eShotRicochetEvent]]
[[bz_eShotStoppedEvent]]
[[bz_eShotTeleportEvent]]
[[bz_eSlashCommandEvent]]
[[bz_eTeleportEvent]]
[[bz_eTickEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eWorldFinalized]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]

The following list contains all the event types currently supported by BZFS version 2.4
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrab]]
[[bz_eAllowPlayer]]
[[bz_eAllowSpawn]]
[[bz_eBanEvent]]
[[bz_eBZDBChange]]
[[bz_eCaptureEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eGameEndEvent]]
[[bz_eGamePauseEvent]]
[[bz_eGameResumeEvent]]
[[bz_eGameStartEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eGetPlayerMotto]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetWorldEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_eListServerUpdateEvent]]
[[bz_eLoggingEvent]]
[[bz_eMsgDebugEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eNetDataReceiveEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_ePlayerAuthEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_ePlayerScoreChanged]]
[[bz_ePlayerSpawnEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_ePluginLoaded]]
[[bz_ePluginUnloaded]]
[[bz_eRawChatMessageEvent]]
[[bz_eReportFiledEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotEndedEvent]]
[[bz_eShotFiredEvent]]
[[bz_eSlashCommandEvent]]
[[bz_eTeamScoreChanged]]
[[bz_eTickEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eWorldFinalized]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]

There exists one additional event in the 'bz_eEventType' enumeration in 'bzfsAPI.h', ''bz_eLastEvent''. This event is simply used by BZFS to assist in the counting of the total number of events, it will never be called and can not be installed.

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

[[plug-ins]]

[[Category:BZFS_API_Events]]

Functions (API)

2015-08-22T09:20:39Z

Alezakos: Properly capitalise the title of the page

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future API functions.
}}

{{BZFS_API_Doc|keeptitle=1}}

== 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_isPlayerSpawnable]] ( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
BZF_API bool [[bz_getPlayerSpawnAtBase]] ( int playerId );
BZF_API bool [[bz_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API void [[bz_setPlayerSpawnAtBase]] ( int playerId, bool base );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerBySlotOrCallsign]] ( const char* name );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

Unknown
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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_incrementTeamWins]] (bz_eTeamType team, int increment);
BZF_API void [[bz_incrementTeamLosses]] (bz_eTeamType team, int increment);
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 ===
2.3+
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 bool [[bz_incrementPlayerWins]] (int playerId, int increment)
BZF_API bool [[bz_incrementPlayerLosses]] (int playerId, int increment);
BZF_API bool [[bz_incrementPlayerTKs]] (int playerId, int increment);
BZF_API int [[bz_getPlayerWins]] ( int playerId );
BZF_API int [[bz_getPlayerLosses]] ( int playerId );
BZF_API int [[bz_getPlayerTKs]] ( int playerId );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

=== Latency Information ===
2.3+
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );
BZF_API int [[bz_getIdleTime]] ( int playerId );
BZF_API int [[bz_getPausedTime]] ( int playerId );

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_getShotMismatch]] ( void );
BZF_API void [[bz_setShotMismatch]] ( bool value );
BZF_API bool [[bz_isAutoTeamEnabled]] ( void );
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
BZF_API int [[bz_getPlayerFlagID]] ( int playerID );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3] );
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 );

=== Shot Management ===
2.4.5+
BZF_API uint32_t [[bz_getShotMetaData]] (int fromPlayer, int shotID, const char* name);
BZF_API void [[bz_setShotMetaData]] (int fromPlayer, int shotID , const char* name, uint32_t value);
BZF_API bool [[bz_shotHasMetaData]] (int fromPlayer, int shotID , const char* name);
BZF_API uint32_t [[bz_getShotGUID]] (int fromPlayer, int shotID);

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

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
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 bool [[bz_isCountDownPaused]] ( void );
BZF_API void [[bz_pauseCountdown]] ( int playerID );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( int playerID );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, int playerID );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );
BZF_API void [[bz_cancelCountdown]] ( int playerID );
BZF_API void [[bz_cancelCountdown]] ( const char *canceledBy );

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

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
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:BZFS API Doc

2015-08-22T09:19:56Z

Alezakos: Allow pages to keep a title unchanged

<includeonly>{{#if:{{{keeptitle|}}}||{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:|}}{{lcfirst:{{PAGENAME}}}}}}}}}</includeonly>
{|style="width:100%;margin-top:+.7em;"
||'''BZFS API Documentation''' This page contains part of the [[BZFS API]] documentation for use by [[Plug-ins]] on the [[BZFS]] server.
|}
<includeonly>[[Category:BZFS_API_Docs]]</includeonly>
<noinclude><br>Adding this template to a page will automatically add the page to the [[:Category:BZFS_API_Docs|Category:BZFS_API_Docs]] page. To use this template add '''<nowiki>{{BZFS_API_Doc}}</nowiki>''' at the top of the page you are creating/editing.</noinclude>

Bz incrementPlayerLosses

2015-05-29T13:39:28Z

Alezakos:

{{apicall
| name = bz_incrementPlayerLosses
| description = Increments the losses of a player.
| param1 = playerID
| param1type = int
| param1desc = The player who is affected by the loss change.
| param2 = increment
| param2type = int
| param2desc = The losses to add to the player. (0 to leave the losses unchanged, negative number to decrement the losses)
| returntype = bool
| return = Whether the player exists.
}}

Bz incrementPlayerWins

2015-05-29T13:39:20Z

Alezakos:

{{apicall
| name = bz_incrementPlayerWins
| description = Increments the wins of a player.
| param1 = playerID
| param1type = int
| param1desc = The player who is affected by the win change.
| param2 = increment
| param2type = int
| param2desc = The wins to add to the player. (0 to leave the wins unchanged, negative number to decrement the wins)
| returntype = bool
| return = Whether the player exists.
}}

Bz incrementPlayerTKs

2015-05-29T13:39:10Z

Alezakos: Created page with "{{apicall | name = bz_incrementPlayerTKs | description = Increments the team-kill count of a player. | param1 = playerID | param1type = int | param1desc..."

{{apicall
| name = bz_incrementPlayerTKs
| description = Increments the team-kill count of a player.
| param1 = playerID
| param1type = int
| param1desc = The player who is affected by the team-kill count change.
| param2 = increment
| param2type = int
| param2desc = The team-kills to add to the player. (0 to leave the team-kills unchanged, negative number to decrement the team-kills)
| returntype = bool
| return = Whether the player exists.
}}

Bz incrementPlayerLosses

2015-05-29T13:38:21Z

Alezakos:

{{apicall
| name = bz_incrementPlayerLosses
| description = Increments the losses of a player.
| param1 = playerID
| param1type = int
| param1desc = The player who is affected by the loss change.
| param2 = losses
| param2type = int
| param2desc = The losses to add to the player. (0 to leave the losses unchanged, negative number to decrement the losses)
| returntype = bool
| return = Whether the player exists.
}}

Bz incrementPlayerLosses

2015-05-29T13:37:56Z

Alezakos: Created page with "{{apicall | name = bz_incrementPlayerLosses | description = Increments the losses of a player. | param1 = playerID | param1type = int | param1desc = Th..."

{{apicall
| name = bz_incrementPlayerLosses
| description = Increments the losses of a player.
| param1 = playerID
| param1type = int
| param1desc = The player who is affected by the loss change.
| param2 = wins
| param2type = int
| param2desc = The losses to add to the player. (0 to leave the wings unchanged, negative number to decrement the wins)
| returntype = bool
| return = Whether the player exists.
}}

Bz incrementPlayerWins

2015-05-29T13:37:34Z

Alezakos: Created page with "{{apicall | name = bz_incrementPlayerWins | description = Increments the wins of a player. | param1 = playerID | param1type = int | param1desc = The pl..."

{{apicall
| name = bz_incrementPlayerWins
| description = Increments the wins of a player.
| param1 = playerID
| param1type = int
| param1desc = The player who is affected by the win change.
| param2 = wins
| param2type = int
| param2desc = The wins to add to the player. (0 to leave the wings unchanged, negative number to decrement the wins)
| returntype = bool
| return = Whether the player exists.
}}

Zone

2015-03-26T13:10:22Z

Alezakos: fix typo

A Zone is a rectangular [[BZW]] map structure for spawn or flag zones. The zone lets you create a specific area for a certain flag or a certain team to spawn.

==Code==
The code for a zone is as follows:
zone
name example_zone
position 0.0 0.0 0.0
size 1.0 1.0 1.0
rotation 0.0
# Add two GM, one OO
zoneflag GM 2
zoneflag OO
# cause laser, shockwave
# good and bad flags to spawn in the zone
flag L
flag SW
flag good
flag bad
team 0 1 2 3 4
safety 1 2 3 4
end
Valid parameters for the zone are:
;position: Defines the position of the zone in the word (x/y/z)
;size: Defines the size of the zone (rectangular prism)
;rotation: Defines a rotation around the Z axis for the box, in degrees.
;zoneflag: Generates the flag listed inside this zone (adding "flag n" for the quantity). The flag will be generated specifically for the zone, regardless of BZFS options. One flag per call. Remember to use the -fb option in the option object.
;flag: Listed flag will spawn in the zone. The flags must be specified for the server via BZFS options. One flag per call.
;team: Team players will spawn (0 - Rogue, 1 - Red, 2 - Green, 3 - Blue, 4 - Purple).
;safety: Team flags listed here will fly to the closest safety zone when dropped (1 - Red, 2 - Green, 3 - Blue, 4 - Purple)

==Function==
Zones are used to define spawn positions in within the XY volume of the Zone. The Z value for the spawn position will be the lower bounds of the volume in Z. Normal spawn rules still apply for spawns generated by zones and may disqualify a spawn from happening in a zone (Z clearance, shots, players, etc..). When multiple zones of the same type are defined, a random one is used for each spawn, if possible.

==Appearance==
Zones have no appearance in a map other than what they define (ex: flags or tank spawns).

==History==
Zones were added to BZFlag in version 2.0.0.

==Editor Support==
The zone object is not supported by any known editors.
==Notes==
Working with flag zones make sure you have enough clearance for flags, default flag height is 10 world units. A dropped flag will stay in a short tunnel if _flagHeight is less than 1.

If the zone is not on the ground, be sure to set -fb or -sb, or your spawns will always be on the ground.
[[Category:Map Making]]
[[Category:Map_Objects]]

Server Permissions

2015-02-15T19:12:35Z

Alezakos: Add new listPlugins permission

Permissions can be assigned to groups and individual players on a server.
These permissions control what a player may do on the server. Many of the permissions control which [[Client_Commands|commands]] can be used by players.

{|{{Prettytable}}
|-
| {{Hl3}} |'''Permission'''
| {{Hl3}} |'''Description'''
|-
| actionMessage || Allowed to use '''''/me'''''
|-
| adminMessageReceive || Player receives messages sent to the admin channel
|-
| adminMessageSend || Player may send messages to the admin channel
|-
| antiban || Player is immune to '''''/ban'''''
|-
| antideregister || Player cannot be deregistered with '''''/deregister'''''
|-
| antikick || Player is immune to '''''/kick'''''
|-
| antikill || Player is immune to '''''/kill'''''
|-
| antipoll || Player is immune to '''''/poll'''''
|-
| antipollban || Player is immune banning with '''''/poll''''' With the number of followers he/she/it has, it looks like it might be a compromised Twitter account trying to run some bots against people who tweet back.... maybe? I don't know.
|-
| antipollkick || Player is immune kicking with '''''/poll'''''
|-
| antipollkill || Player is immune killing with '''''/poll'''''
|-
| ban || Player may ban other players with '''''/ban'''''
|-
| banlist || Player may list active bans with '''''/banlist'''''
|-
| clientquery || Player may issue '''''/clientquery''''', available in version 2.4.3+.
|-
| countdown || Player may issue '''''/countdown'''''
|-
| date || Player may query the date and time from the server with '''''/date'''''
|-
| endGame || Player may issue '''''/gameover'''''
|-
| flagHistory || Player allowed to use '''''/flag history'''''
|-
| flagMaster || Player allowed to use all '''''/flag''''' commands
|-
| flagMod || Player allowed to use '''''/flag reset''''', '''''/flag show''''' and '''''/flag history'''''. Using '''''/flag reset''''' to reset an individual flag requires ''flagMaster''
|-
| hideAdmin || Player doesn't show @
|-
| idlestats || Player allowed to use '''''/idlestats'''''
|-
| info ||
|-
| jitterwarn || Player may use '''''/jitterwarn''''' and '''''/jitterdrop'''''' to query or set jitterwarn/jitterdrop variable
|-
| kick || Player allowed to use '''''/kick'''''
|-
| kill || Player allowed to use '''''/kill'''''
|-
| lagstats || Player may use '''''/lagstats''''' to query the latency of players
|-
| lagwarn || Player may use '''''/lagwarn''''' and '''''/lagdrop''''' to query or set lagwarn/lagdrop variable
|-
| listPerms || Player may use '''''/showperms''''' to show the current permissions of the user/selected player.
|-
| listPlugins || Player may use '''''/listplugins'''''
|-
| loadPlugin || Player may use '''''/loadplugin'''''
|-
| masterban || Player may use '''''/masterban'''''
|-
| modcount || Player may use '''''/modcount'''''
|-
| mute || Player may use '''''/mute'''''
|-
| packetlosswarn || Player may use '''''/packetlosswarn''''' and '''''/packetlossdrop''''' to query or set packetlosswarn/packetlossdrop variable
|-
| playerList || Player may use '''''/playerlist'''''
|-
| plugins || Player may use '''''/listplugins''''', '''''/loadplugin''''' and '''''/unloadplugin'''''. Requires bzflag to be built with the optional plug-in support, available in version 2.0.10+.
|-
| poll || Player may use '''''/poll'''''
|-
| pollBan || Player may use '''''/poll ban'''''
|-
| pollFlagReset || Player may use '''''/poll flagreset'''''
|-
| pollKick || Player may use '''''/poll kick'''''
|-
| pollKill || Player may use '''''/poll kill'''''
|-
| pollSet || Player may use '''''/poll set'''''
|-
| privateMessage || Player may send private messages with '.'
|-
| record || Player may use '''''/record'''''
|-
| rejoin || Allows instant rejoin, regardless of '''''_rejoinTime'''''
|-
| removePerms || May remove permissions from players
|-
| replay || Player allowed to use '''''/replay'''''
|-
| report || Player allowed to use '''''/report'''''
|-
| requireIdentify || Registered callsigns must identify before they are allowed to spawn
|-
| say || Player allowed to use '''''/say'''''
|-
| sendHelp || Player allowed to use '''''/sendhelp'''''
|-
| setAll || Grants all set* perms, allows use of '''''/reload''''' and '''''/serverdebug'''''
|-
| setPerms || May grant permissions to players
|-
| setVar || Player allowed to use '''''/set'''''
|-
| shortBan || Allowed bans with limited durations only
|-
| showAdmin || Gives a player an @ regardless of having the "shortban" or "ban" permission. ''The hideAdmin permission supersedes the showAdmin permission.''
|-
| showOthers || May use '''''/showgroup''''' and '''''/showperms''''' on other callsigns
|-
| shutdownServer || Player allowed to use '''''/shutdownserver'''''
|-
| spawn || Join game as a player. Observers don't need this permission.
|-
| superkill || Player allowed to use '''''/superkill'''''
|-
| talk || Allows player to send messages.
|-
| unban || Player may use '''''/unban'''''
|-
| unloadPlugin || Player may use '''''/unloadplugin'''
|-
| unmute || Player may use '''''/unmute'''''
|-
| veto || Player may use '''''/veto'''''
|-
| viewReports || Player may use '''''/viewreports'''''
|-
| vote || Player may use '''''/vote'''''
|}

[[Category:Server]]

Functions (API)

2014-12-21T09:32:03Z

Alezakos: /* Timed Game Management */ Add bz_cancelCountdown()

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

Unknown
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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 ===
2.3+
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 );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

=== Latency Information ===
2.3+
BZF_API int [[bz_getPlayerLag]] ( int playerId );
BZF_API int [[bz_getPlayerJitter]] ( int playerId );
BZF_API float [[bz_getPlayerPacketloss]] ( int playerId );
BZF_API int [[bz_getIdleTime]] ( int playerId );
BZF_API int [[bz_getPausedTime]] ( int playerId );

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_getShotMismatch]] ( void );
BZF_API void [[bz_setShotMismatch]] ( bool value );
BZF_API bool [[bz_isAutoTeamEnabled]] ( void );
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( int flag );
BZF_API bool [[bz_resetFlag]] ( int flag );
BZF_API int [[bz_flagPlayer]] ( int flag );
BZF_API int [[bz_getPlayerFlagID]] ( int playerID );
BZF_API bool [[bz_getFlagPosition]] ( int flag, float* pos );
BZF_API bool [[bz_moveFlag]] ( int flag, float pos[3] );
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 );

=== Shot Management ===
2.4.5+
BZF_API uint32_t [[bz_getShotMetaData]] (int fromPlayer, int shotID, const char* name);
BZF_API void [[bz_setShotMetaData]] (int fromPlayer, int shotID , const char* name, uint32_t value);
BZF_API bool [[bz_shotHasMetaData]] (int fromPlayer, int shotID , const char* name);
BZF_API uint32_t [[bz_getShotGUID]] (int fromPlayer, int shotID);

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

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
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 bool [[bz_isCountDownPaused]] ( 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 );
BZF_API void [[bz_cancelCountdown]] ( const char *canceledBy );

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

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
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]]

Bz cancelCountdown

2014-12-21T09:29:13Z

Alezakos: Created page with "{{apicall | name = bz_cancelCountdown | returns = | returntype = void | description = Stops the countdown before a match has been started. | param1 =..."

{{apicall
| name = bz_cancelCountdown
| returns =
| returntype = void
| description = Stops the countdown before a match has been started.
| param1 = canceledBy
| param1type = const char*
| param1desc = The name of the player stopping the countdown. Note that this value does not have to be a callsign of a player in the server, it can be any string or <code>null</code>.
}}

DevelopmentPlans/2.4.2

2014-11-19T13:57:01Z

Alezakos:

==Overview==
2.4.2 was the first maintenance release of the 2.4.x compatibility line. Its primary function was to be pushed out in order to get a complete debian package and having a new version number helps with that.

The release was completed in July 2012 as the [[BZFlag_2.4.2]] release

==Tasks==
Many tasks were postponed to a later release in order to get the debian package out and due to general development apathy.

===Bug To Be Fixed===

====Introduced in previous release====
* <strike>"ST" autopilot 'issue' https://sourceforge.net/tracker/?func=detail&aid=3368248&group_id=3248&atid=103248</strike>
* The bzadmin client in the 2.4.0 Windows installer (32-bit, and probably 64-bit) was not built with PDCurses

=====Primary=====
* <strike>Flag Spawning After Death https://sourceforge.net/tracker/?func=detail&aid=3021884&group_id=3248&atid=103248</strike>

=====Secondary=====
* <strike>Observer movement controls seems to get locked-up https://sourceforge.net/tracker/?func=detail&aid=3368413&group_id=3248&atid=103248</strike>
* <strike>timeout does not work with multiple team flags https://sourceforge.net/tracker/?func=detail&aid=3368409&group_id=3248&atid=103248</strike> (fixed in 2.4.4)
* '''time limiter and agility https://sourceforge.net/tracker/?func=detail&aid=3368408&group_id=3248&atid=103248 (Canceled 1/16/12, pushed to 2.4.4)'''
*''' z buffer issues https://sourceforge.net/tracker/?func=detail&aid=3368245&group_id=3248&atid=103248 (Canceled 1/16/12, pushed to 2.4.4)'''
* <strike>line numbers in drawinfo errors https://sourceforge.net/tracker/?func=detail&aid=2139541&group_id=3248&atid=103248</strike> (fied in 2.4.4)
* <strike>stats not tracking https://sourceforge.net/tracker/?func=detail&aid=1433676&group_id=3248&atid=103248</strike> (fixed in 2.4.4)
*''' eval "configure should test and enable the fudged acosf atanf asinf" from old TODO. (Canceled 1/16/12, pushed to 2.4.4)

===Features===
* '''BZFScron (implement as backport from 2.99) (BTH) (Canceled 1/16/12, pushed to 2.4.4)'''
* Fastmap ( Fixed : 7/30/11 JAM )
* '''Push Stats ( finish backend ) (Canceled 1/16/12, pushed to 2.4.4)'''
* '''Joystick fixes (DTR?) (Canceled 1/16/12, pushed to 2.4.4)'''
* '''CIDR/subnet bans from Filter.cxx (Make a common ban check/resolution function/class?) (Canceled 1/16/12, pushed to 2.4.4)'''

==Known Bugs==

[[Category:Development Plans]]

DevelopmentPlans/2.4.2

2014-11-19T13:54:26Z

Alezakos: mark fixed issues

==Overview==
2.4.2 was the first maintenance release of the 2.4.x compatibility line. Its primary function was to be pushed out in order to get a complete debian package and having a new version number helps with that.

The release was completed in July 2012 as the [[BZFlag_2.4.2]] release

==Tasks==
Many tasks were postponed to a later release in order to get the debian package out and due to general development apathy.

===Bug To Be Fixed===

====Introduced in previous release====
* <strike>"ST" autopilot 'issue' https://sourceforge.net/tracker/?func=detail&aid=3368248&group_id=3248&atid=103248</strike>
* The bzadmin client in the 2.4.0 Windows installer (32-bit, and probably 64-bit) was not built with PDCurses

=====Primary=====
* <strike>Flag Spawning After Death https://sourceforge.net/tracker/?func=detail&aid=3021884&group_id=3248&atid=103248</strike>

=====Secondary=====
* <strike>Observer movement controls seems to get locked-up https://sourceforge.net/tracker/?func=detail&aid=3368413&group_id=3248&atid=103248</strike>
* <strike>timeout does not work with multiple team flags https://sourceforge.net/tracker/?func=detail&aid=3368409&group_id=3248&atid=103248</strike>
* '''time limiter and agility https://sourceforge.net/tracker/?func=detail&aid=3368408&group_id=3248&atid=103248 (Canceled 1/16/12, pushed to 2.4.4)'''
*''' z buffer issues https://sourceforge.net/tracker/?func=detail&aid=3368245&group_id=3248&atid=103248 (Canceled 1/16/12, pushed to 2.4.4)'''
* <strike>line numbers in drawinfo errors https://sourceforge.net/tracker/?func=detail&aid=2139541&group_id=3248&atid=103248</strike>
* <strike>stats not tracking https://sourceforge.net/tracker/?func=detail&aid=1433676&group_id=3248&atid=103248</strike>
*''' eval "configure should test and enable the fudged acosf atanf asinf" from old TODO. (Canceled 1/16/12, pushed to 2.4.4)

===Features===
* '''BZFScron (implement as backport from 2.99) (BTH) (Canceled 1/16/12, pushed to 2.4.4)'''
* Fastmap ( Fixed : 7/30/11 JAM )
* '''Push Stats ( finish backend ) (Canceled 1/16/12, pushed to 2.4.4)'''
* '''Joystick fixes (DTR?) (Canceled 1/16/12, pushed to 2.4.4)'''
* '''CIDR/subnet bans from Filter.cxx (Make a common ban check/resolution function/class?) (Canceled 1/16/12, pushed to 2.4.4)'''

==Known Bugs==

[[Category:Development Plans]]

Bz eGetPlayerSpawnPosEvent

2014-09-08T21:38:25Z

Alezakos: fix typo

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetPlayerSpawnPosEvent''' is an API event that is called each time the server needs a new spawn position.

==Data==
'''bz_eGetPlayerSpawnPosEvent''' returns the '''bz_GetPlayerSpawnPosEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetPlayerSpawnPosEventData
|-
|playerID
|int
|ID of the player that is requesting the spawn position.
|-
|team
|bz_eTeamType
|The team the player is currently in.
|-
|handled
|bool
|The current state representing if other plug-ins have modified the spawn position. Plug-ins that modify the spawn position should set this value to true to inform other plug-ins that have not processed yet.
|-
|pos
|float[3]
|Position where the player will be spawned. This value is initialized to the server computed spawn position using the current spawn rules.
|-
|rot
|float
|The rotational direction that the player will be spawned at. This value is initialized to the server computed spawn rotation using the current spawn rules.
|-
|eventTime
|double
|The server time at which the event occurred (in seconds).
|}

==Uses==
This is a modification event, plug-ins may change the pos and rot fields to effect changes in the spawn position that is used for the player.

Server Permissions

2014-08-03T06:16:53Z

Alezakos: Add new REPORT permission

Permissions can be assigned to groups and individual players on a server.
These permissions control what a player may do on the server. Many of the permissions control which [[Client_Commands|commands]] can be used by players.

{|{{Prettytable}}
|-
| {{Hl3}} |'''Permission'''
| {{Hl3}} |'''Description'''
|-
| actionMessage || Allowed to use '''''/me'''''
|-
| adminMessageReceive || Player receives messages sent to the admin channel
|-
| adminMessageSend || Player may send messages to the admin channel
|-
| antiban || Player is immune to '''''/ban'''''
|-
| antideregister || Player cannot be deregistered with '''''/deregister'''''
|-
| antikick || Player is immune to '''''/kick'''''
|-
| antikill || Player is immune to '''''/kill'''''
|-
| antipoll || Player is immune to '''''/poll'''''
|-
| antipollban || Player is immune banning with '''''/poll''''' With the number of followers he/she/it has, it looks like it might be a compromised Twitter account trying to run some bots against people who tweet back.... maybe? I don't know.
|-
| antipollkick || Player is immune kicking with '''''/poll'''''
|-
| antipollkill || Player is immune killing with '''''/poll'''''
|-
| ban || Player may ban other players with '''''/ban'''''
|-
| banlist || Player may list active bans with '''''/banlist'''''
|-
| clientquery || Player may issue '''''/clientquery''''', available in version 2.4.3+.
|-
| countdown || Player may issue '''''/countdown'''''
|-
| date || Player may query the date and time from the server with '''''/date'''''
|-
| endGame || Player may issue '''''/gameover'''''
|-
| flagHistory || Player allowed to use '''''/flag history'''''
|-
| flagMaster || Player allowed to use all '''''/flag''''' commands
|-
| flagMod || Player allowed to use '''''/flag reset''''', '''''/flag show''''' and '''''/flag history'''''. Using '''''/flag reset''''' to reset an individual flag requires ''flagMaster''
|-
| hideAdmin || Player doesn't show @
|-
| idlestats || Player allowed to use '''''/idlestats'''''
|-
| info ||
|-
| kick || Player allowed to use '''''/kick'''''
|-
| kill || Player allowed to use '''''/kill'''''
|-
| lagstats || Player may use '''''/lagstats''''' to query the latency of players
|-
| lagwarn || Player may use '''''/lagwarn''''' to query or set lagwarn variable
|-
| listPerms || Player may use '''''/showperms''''' to show the current permissions of the user/selected player.
|-
| loadPlugin || Player may use '''''/loadplugin'''
|-
| masterban || Player may use '''''/masterban'''''
|-
| modcount || Player may use '''''/modcount'''''
|-
| mute || Player may use '''''/mute'''''
|-
| playerList || Player may use '''''/playerlist'''''
|-
| plugins || Player may use '''''/loadplugin''''' and '''''/unloadplugin'''''. Requires bzflag to be built with the optional plug-in support, available in version 2.0.10+.
|-
| poll || Player may use '''''/poll'''''
|-
| pollBan || Player may use '''''/poll ban'''''
|-
| pollFlagReset || Player may use '''''/poll flagreset'''''
|-
| pollKick || Player may use '''''/poll kick'''''
|-
| pollKill || Player may use '''''/poll kill'''''
|-
| pollSet || Player may use '''''/poll set'''''
|-
| privateMessage || Player may send private messages with '.'
|-
| record || Player may use '''''/record'''''
|-
| rejoin || Allows instant rejoin, regardless of '''''_rejoinTime'''''
|-
| removePerms || May remove permissions from players
|-
| replay || Player allowed to use '''''/replay'''''
|-
| report || Player allowed to use '''''/report'''''
|-
| requireIdentify || Registered callsigns must identify before they are allowed to spawn
|-
| say || Player allowed to use '''''/say'''''
|-
| sendHelp || Player allowed to use '''''/sendhelp'''''
|-
| setAll || Grants all set* perms
|-
| setPerms || May grant permissions to players
|-
| setVar || Player allowed to use '''''/set'''''
|-
| shortBan || Allowed bans with limited durations only
|-
| showOthers || May use '''''/showgroup''''' and '''''/showperms''''' on other callsigns
|-
| shutdownServer || Player allowed to use '''''/shutdownserver'''''
|-
| spawn || Join game as a player. Observers don't need this permission.
|-
| superkill || Player allowed to use '''''/superkill'''''
|-
| talk || Allows player to send messages.
|-
| unban || Player may use '''''/unban'''''
|-
| unloadPlugin || Player may use '''''/unloadplugin'''
|-
| unmute || Player may use '''''/unmute'''''
|-
| veto || Player may use '''''/veto'''''
|-
| viewReports || Player may use '''''/viewreports'''''
|-
| vote || Player may use '''''/vote'''''
|}

[[Category:Server]]

BZFS Command Line Options

2014-06-11T21:06:18Z

Alezakos: Add documentation for the -maxidle option

BZFS supports a number of command line options that let you set the various modes and parameters for the game.

==Use==
Any command line option can be passed to BZFS in the command line, or placed in a text file (a [[server configuration files|server configuration file]]) passed in with the -conf parameter.

==Server configuration files==
A server configuration file is simply a text file with a list of command line options, one per line. This file can be the parameter to the -conf command line option. BZFS will load all options in the config file as if they had been passed in as runtime options. Note that a config file may itself include the -conf option, allowing one config file to "include" another. This could be useful if a group of servers (hosted on the same machine) want to share common settings.

It may be helpful to start with a [[Sample conf|Sample]] config file.

==Standard Options==

*'''-a''' ''linear angular''
Sets the maximum linear and angular accelerations. The units are somewhat arbitrary so you'll have to experiment to find suitable values. Positive values will set limits to the acceleration and lower they are, greater is the inertia. Zero or negative values disable acceleration limits. '''-a 50 38''' is recommended for standard-speed servers.

*'''-admsg''' ''message''
Define a message which will be broadcast to all players every 15 minutes. This option can be used multiple times to define a multi-line message.

*'''-adminlagannounce''' ''milliseconds''
Announce players that lag more than ''milliseconds'' to admins.

*'''-advertise''' ''groupname,groupname,...''
Allows control of who can see this server on the server list. Use -advertise NONE to make a private server (no one will see the server, but global logins can be used). The default, if -advertise is not specified, is to allow everyone to see the server. Otherwise, your server will only be listed to members of the groups which you specify with -advertise.

*'''-autoTeam'''
Instructs the server to automatically assign joining players to the team that needs more players, overriding user preference. For specifics on operation, see [[Auto Team]].

*'''-b'''
When -c is supplied, this option randomly rotates the buildings.

*'''-badwords''' ''badwordfile''
Specify a file that contains bad words that will be used when either -filterCallsigns or -filterChat is enabled.

*'''-ban''' ''ip{,ip}*''
Prohibits connections from the listed IP addresses. Trailing 255 bytes are treated as mask bytes.

*'''-banfile''' ''filename''
Specifies the name of a file where bzfs will store the banlist. It will load the banlist from this file when it starts (if the file exists), and write the banlist back to the file when someone gets banned or unbanned. If this option isn't given the banlist will not be saved.

*'''-banTime'''
Default number of minutes player should be banned (unspecified, the default is 300).

*'''-c'''
Enables the capture-the-flag style game. By default this allocates one team flag per team. This can be modified see '''+f''' ''team''. By default, the free-for-all style is used.

*'''-cache''' ''worldCacheURL''
Specifies the URL for the world cache file. This is a binary file that clients will attempt to download before getting the world from the bzfs server.

*'''-cacheout''' ''filename''
Save the currently specified world into a binary cache file and exit.

*'''-conf''' ''configfilename''
Specifies the name of a configuration file to be used to set all of the bzfs options, rather than setting them on the command line.

*'''-cr'''
Enables the capture-the-flag style game with random map. You can optionally specify a building density by providing a number (default is 5). One team flag per team is provided, but more can be added through '''+f''' ''team''. By default, the free-for-all style is used.

*'''-d'''
Increase debugging level. If more '''-d''' is given, more debugging info is obtained.

*'''-density''' ''num''
Specify density for buildings, i.e. the higher the integer number, the more buildings you will get. This applies to automatically generated maps only.

*'''-disableBots'''
Prevent clients from using the ROGER autopilot or from using robots.

*'''+f''' ''{good|bad|teamflag-id}[{count}]''
Forces the existence of the given flag. If specified multiple times for the same flag-id, then that many flags will appear. The good argument is equivalent to specifying '''+f''' once for each kind of good flag. Same goes for the bad argument. The teamflag-id must match one of the predefined [[FlagCode|Flag Codes]].

*'''-f''' ''{flag-id}''
Restricts a certain flag from existing.

*'''-fb'''
Allow flags on box buildings.

*'''-filterCallsigns'''
Turn on the filtering of callsigns and email addresses. Callsigns and addresses are compared against bad words provided via '''-badwords'''.

*'''-filterChat'''
Turn on the filtering of chat messages. Messages that contain words listed via a '''-badwords''' file are replaced with !@#$%^&* characters.

*'''-filterSimple'''
By default, all filtering is aggressive, matching much more than what is strictly listed in a '''-badwords''' file for convenience. Providing this option will make the '''-filterCallsigns''' and '''-filterChat''' comparisons exact match only.

*'''-g'''
Quit after serving one game.

*'''-groupdb''' ''file''
Load groups from file

*'''-h'''
Buildings are given varying heights if the map is random. Has no effect on map files.

*'''-handicap'''
Players are given a handicap advantage based on their ability in relation to the other players. Handicapped players will have faster tanks and shots. The handicap is determined by the player's score in relation to other players.

*'''-help'''
Shows a help page and lists all the valid flag id's.

*'''-helpmsg''' ''file name''
Create a help message accessible by /help name, which prints the contents of file. Restricted to 10 lines per help message.

*'''-i''' ''interface''
Server will listen for and respond to ''pings'' (sent via broadcast) on the given interface. Clients use this to find active servers on the network. This is the TCP/UDP/IP address the server will listen on.

*'''-j'''
Allows jumping.

*'''-jitterdrop''' ''warn-count''
Kicks players after ''warn-count'' jitter warnings.

*'''-jitterwarn''' ''time/ms''
Send warnings to players that jitter more than ''time''.

*'''-lagannounce''' ''milliseconds''
Announce players that lag more than ''milliseconds'' in public.

*'''-lagdrop''' ''warn-count''
Kicks players after ''warn-count'' lag warnings.

*'''-lagwarn''' ''time/ms''
Send warnings to players that lag more than ''time''.

*'''-loadplugin''' ''/filename''
Load plugin. See more at [[Plug-ins|Plugins]]

*'''-masterBanURL''' ''URL''
Specify alternate URLs for the master ban file to be pulled from. This argument may be provided multiple times.

*'''-maxidle''' ''seconds''
Kick players that did not play longer than ''second''s. Pausing players are not kicked. If a player uttered a word recently, he will be kicked after thrice the given time.

*'''-mp''' ''total | rogue,red,green,blue,purple,observer''
Sets the maximum number of players, total or per team.A single value sets the total number of players allowed. Five comma separated values set the maximum for each team. If a count is left blank then no limit is set for that team, except for the limit on the total number of players. Both forms may be provided.

*'''-mps''' ''max-score''
Sets a maximum score for individual players. The first player to reach this score is declared the winner and the game is over.

*'''-ms ''shots''
Allows up to shots simultaneous shots for each player. This is 1 by default.

*'''-mts''' ''max-score''
Sets a maximum score for teams. The first team to reach this score is declared the winner and the game is over.

*'''-noMasterBanlist'''
Server will not attempt to load the [[Master Ban]] list from the internet.

*'''-noTeamKills'''
Players on the same team are immune to each other's shots. Rogue is excepted.

*'''-offa'''
Enables the Open-Free-for-All style game. This is a teamless mode, similar to the classic deathmatch in other games.

*'''-p''' ''port''
Listen for game connections on port instead of the default port.Use '''-help''' to print the default port, or use '''-d''' debug printing.

*'''-packetlossdrop''' ''warn-count''
Kicks players after ''warn-count'' packetloss warnings.

*'''-packetlosswarn''' ''percent''
Send warnings to players that lag more than ''percent'' packetloss.

*'''-passdb''' ''file''
Load passwords from file

*'''-passwd''' ''password''
Specify a server administrator password for use in remote administration such as /kick, /ban, /mute, etc messages.

*'''-pidfile''' ''filename''
Specify a file where the server will write its process ID so it may be used for remote administration.

*'''-poll''' ''variable=value''
Configure several aspects of the in-game polling system.

*'''-printscore''' ''variable=value''
Write score to stdout whenever it changes

*'''-publictitle''' (-public in 2.0.x and earlier)
Causes the server to register itself with a list server, which clients can query to get a list of bzfs servers. By default, a server will respond to broadcast queries, allowing clients to find servers running on the standard port on the local subnet.

*'''-publicaddr''' ''address[:port]''
Advertise this server with the given address and port. Only has an effect when used with '''-public'''. Normally a server advertises itself at the local address and port. Some servers are not accessible from the internet at this address (for example servers behind a firewall using Network Address Translation). Use this option to specify the address and/or port that internet users should use to access this server.

*'''-publiclist''' ''url''
Advertise this server on the list servers listed at url. Only has an effect when used with '''-public'''. A built-in url is used by default. The BZFlag clients use the same built-in url so, by default, clients will see public servers automatically. This argument may be provided multiple times to publicize a server to multiple list servers.

*'''-publickey''' ''key''
Advertise this server on the public list server using the specified identification key. Required in Version 2.4 and later..

*'''-q'''
If specified, the server will not listen for nor respond to ``pings''. BZFlag sends out these pings to give the user a list of available servers.This effectively makes the server private, especially if the '''-p''' option is also used.

*'''+r'''
Makes most shots ricochet. Super bullets, shock waves, and guided missiles do not.

*'''-rabbit''' ''[score|killer|random]''
Enables the rabbit-hunt style game. By default, the free-for-all style is used. You must specify the algorithm used to pick a new rabbit when the old one dies. The score algorithm uses a modified wins/(wins+losses) score and picks the top scoring player to be the new rabbit. The killer algorithm specifies a reverse tag game where whomever kills the rabbit becomes the new rabbit. The random algorithm randomly picks a new rabbit without regard to score. (The score algorithm is the original behavior.)

*'''-recbuf''' ''size''
Start with the recording buffer active, with the specified size (in megabytes).

*'''-recbufonly'''
Disable recording straight to files

*'''-recdir''' ''directory''
Specify the directory for record and replay files.

*'''-replay'''
Start the server in replay mode.

*'''-reportfile''' ''filename''
Enable the /report command and log all reports to ''filename''.

*'''-reportpipe''' ''command''
Enable the /report command and execute ''command'' when a report is filed. This can be used together with, or instead of the '''-reportfile''' option.

*'''-requireudp'''
Require clients to use parallel UDP. If players fire before opening a UDP channel, kick them off the server.

*'''+s''' ''num-flags''
The server will have an extra num-flags random super flags available at all times. The '''-f''' option can be used to restrict which types of flags will be added. Required flags given by the '''+f''' option are not included in the num-flags total.

*'''-s''' ''num-flags''
The server will have up to num-flags random super flags available at any time.The '''-f''' option can be used to restrict which types of flags will be added. Required flags given by the '''+f''' option are not included in the ''num-flags'' total.

*'''-sa'''
Antidote flags are provided for players with bad flags.

*'''-sb'''
Allow spawns on box buildings.

*'''-set''' ''name value''
Set BZDB variable name to value

*'''-sl''' ''id num''
Restrict flag id to num shots.

*'''-spamtime''' ''time''
Minimum ''time'' between player chat messages that are alike.

*'''-spamwarn''' ''warnLimit''
Number of warnings a player/spammer gets, who violates '''-spamtime'''.

*'''-speedtol''' ''factor''
Override the default speed auto kick factor. The factor should not be less then 1.0. The factor is a multiplier.

*'''-srvmsg''' ''message''
Define a server welcome message. This option can be used multiple times to define a multiline message.

*'''-st''' ''time''
Bad flags are automatically dropped after time seconds.

*'''-sw''' ''count''
Bad flags are automatically dropped after count wins. Capturing a team flag does not count as a win.

*'''-synclocation'''
Forces all clients to use the same sun and stars location.

*'''-synctime'''
Forces all clients to use the same time of day. The current time is determined by the server's clock. This disables the + and - keys on the clients.

*'''-t'''
Adds teleporters to random maps. Has no effect on map files.

*'''-time'''
Starts a countdown immediately when the server starts.

*'''-timemanual'''
The countdown has to be started manually using the /countdown command. This is useful for matches.

*'''-tk'''
Changes the default behavior where a player dies when he kills a teammate. When using this option, he will just get a -1 score penalty for the kill but not be killed in game.

*'''-tkannounce'''
Announces team kills to the admin channel

*'''-tkkr''' ''percent''
Kicks players whose team killing to normal kill ratio is greater than percent [1-100]. A start up grace period is given to players.

*'''-ts''' ''[micros]''
Include timestamp information in DEBUG output useful for logging. If micros is specified, microseconds will be added to the timestamp.

*'''-userdb''' ''file''
Load group associations from file

*'''-utc'''
Log timestamps in UTC (Coordinated Universal Time)

*'''-vars''' ''file''
Loads values for game configurable variables from file. Entries are one per line in the form: set variable value. For a list of variables that are configurable, in the BZFlag client, send a message with /set as the text.

*'''-version'''
Prints the version number of the executable.

*'''-vetoTime'''
Max seconds authorized user has to abort poll(default is 20).

*'''-votePercentage'''
Percentage of players required to affirm a poll (unspecified, the default is 50.1%).

*'''-voteRepeatTime'''
Minimum seconds required before a player may repeat a vote.

*'''-world''' ''world-file''
Reads a specific BZFlag .bzw world file in [[BZW]] format as the game map.

*'''-worldsize''' ''world-size''
Changes the size for random maps

==See also==
[[BZW|BZW world format]]

[[Category:Server]]

Command Line Options

2014-06-10T21:44:26Z

Alezakos: Redirected page to BZFS Command Line Options

#REDIRECT[[BZFS Command Line Options]]

MapChange Server

2013-07-16T14:21:37Z

Alezakos: This is mapchange, not shockwaveDeath

Mapchange is a standard [[Plug-ins|plug-in]] that is shipped with the [[BZFlag Source]] code. It allows a server to run more than one map per running Process.

Mapchange is not included in any BZFlag package by default. You must download the source from the forums: [http://my.bzflag.org/bb/download/file.php?id=5651 Mapchange.zip]
More help can be found on the forums here [http://my.bzflag.org/bb/viewtopic.php?t=9903 Mapchange]

==Usage==
Creates an extra ".conf" which allows you to call *in game* any other configuration file with the commands:
/maplist
/mapchange
/maprandom

==History==
Mapchange was created by Gnurdux

[[Category:Development]]
[[Category:Plug-Ins]]

User:Alezakos

2013-06-25T21:33:07Z

Alezakos: Do not capitalise the first letter of my name

{{DISPLAYTITLE:User:alezakos}}
You might be able to find me under the username alezakos or kongr45gpen on IRC.

Bz setShotMismatch

2013-06-25T19:23:57Z

Alezakos: Created page with "{{apicall | name = bz_setShotMismatch | description = Enable or disable the check for a shot mismatch | param1 = value | param1type = bool | param1desc = True to..."

{{apicall
| name = bz_setShotMismatch
| description = Enable or disable the check for a shot mismatch
| param1 = value
| param1type = bool
| param1desc = True to kick players whose shots mismatch, false to do otherwise
| returntype = void
| version = 2.4.3 (r22821) or later
}}

Template:Apicall

2013-06-25T19:17:47Z

Alezakos: Do not capitalise the first letter of BZFS API Function pages

<includeonly>{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:|}}{{lcfirst:{{PAGENAME}}}}}}</includeonly><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>

Bz getShotMismatch

2013-06-25T19:16:21Z

Alezakos: Created page with "{{apicall | name = bz_getShotMismatch | description = Returns true if the server checks for shot mismatches | param1type = void | returntype = bool | returns = Tr..."

{{apicall
| name = bz_getShotMismatch
| description = Returns true if the server checks for shot mismatches
| param1type = void
| returntype = bool
| returns = True if server kicks clients who are using wrong shot types, false if otherwise
| version = 2.4.3 (r22821) or later
}}

Functions (API)

2013-06-25T19:13:57Z

Alezakos: /* Server Management */ Add 2 new API functions

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

Unknown
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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 ===
2.3+
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 );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

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

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_getShotMismatch]] ( void );
BZF_API void [[bz_setShotMismatch]] ( bool value );
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( 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] );
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 ===
2.3+
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt, bz_eTeamType shotTeam = eRogueTeam );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt, bz_eTeamType shotTeam = eRogueTeam );

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
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)

2013-06-25T19:12:59Z

Alezakos: /* Server Management */ Add 2 new API functions

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

Unknown
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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 ===
2.3+
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 );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

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

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
BZF_API bool [[bz_getShotMismatch]] ( void );
BZF_API void [[bz_setShotMismatch]] ( bool value);
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( 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] );
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 ===
2.3+
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt, bz_eTeamType shotTeam = eRogueTeam );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt, bz_eTeamType shotTeam = eRogueTeam );

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
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]]

DevelopmentPlans/2.4.4

2013-06-17T20:31:59Z

Alezakos: /* Feature Requests to Eval */

==Overview==
2.4.4 will be the second maintenance release of the 2.4.x compatibility line. It may never happen but, here is what we didn't do in 2.4.2
==Tasks==

===Bugs To Be Fixed===

=====Primary=====
* <strike>The bzadmin client in the 2.4.0 and 2.4.2 Windows installer was not built with PDCurses</strike> (Fixed as of r22627)
* <strike>timeout does not work with multiple team flags https://sourceforge.net/tracker/?func=detail&aid=3368409&group_id=3248&atid=103248</strike> (Fixed 26/01/12 DTR)
* <strike>line numbers in drawinfo errors https://sourceforge.net/tracker/?func=detail&aid=2139541&group_id=3248&atid=103248</strike> (Fixed as of r22646)
* <strike>stats not tracking https://sourceforge.net/tracker/?func=detail&aid=1433676&group_id=3248&atid=103248</strike> (Fixed as of r22668)
* time limiter and agility https://sourceforge.net/tracker/?func=detail&aid=3368408&group_id=3248&atid=103248
* z buffer issues https://sourceforge.net/tracker/?func=detail&aid=3368245&group_id=3248&atid=103248
* eval "configure should test and enable the fudged acosf atanf asinf" from old TODO.

=====Secondary=====

===Features===
* <strike>Graphic tank on radar at high zoom</strike> (Fixed as of r22664)
* BZFScron (implement as backport from 2.99) (BTH)
* Push Stats ( finish backend )
* Joystick fixes (DTR?)
* CIDR/subnet bans from Filter.cxx (Make a common ban check/resolution function/class?)

==Known Bugs==

==Feature Requests to Eval==
* <strike>Pause the console https://sourceforge.net/tracker/index.php?func=detail&aid=3464640&group_id=3248&atid=353248</strike> (Fixed as of r22811)

[[Category:Development Plans]]

Template:BZFS API Doc

2013-06-12T18:51:00Z

Alezakos: Do not capitalise the first letter of BZFS API Doc pages

<includeonly>{{DISPLAYTITLE:{{#if:{{NAMESPACE}}|{{NAMESPACE}}:|}}{{lcfirst:{{PAGENAME}}}}}}</includeonly>
{|style="width:100%;margin-top:+.7em;"
||'''BZFS API Documentation''' This page contains part of the [[BZFS API]] documentation for use by [[Plug-ins]] on the [[BZFS]] server.
|}
<includeonly>[[Category:BZFS_API_Docs]]</includeonly>
<noinclude><br>Adding this template to a page will automatically add the page to the [[:Category:BZFS_API_Docs|Category:BZFS_API_Docs]] page. To use this template add '''<nowiki>{{BZFS_API_Doc}}</nowiki>''' at the top of the page you are creating/editing.</noinclude>

Bz getFlagName

2013-06-12T16:16:22Z

Alezakos: Use the proper function name

{{BZFS_API_Doc}}
{{BZFS_API_Funcs}}
==Prototype==
BZF_API const [[bz_ApiString]] bz_getFlagName( int flag );
==Parameters==
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|flag
|int
|the flag to return
|}

==Description==
This API function returns the flag code for the specified flag.

BZFlag 2.4.0

2013-06-06T17:13:00Z

Alezakos: /* Upgrades */ fix typo

BZFlag version 2.4.0 '''"Wake the Dead"''', is the current maintenance version of the BZFlag game for Windows, Apple OSX, and Linux. It was released on 07/03/2011 after a long period of development inactivity.

This new version is incompatible with previous versions of the game. The primary goals of the release were to fix a number of bugs that required changes to the gaming protocol and clients as well as to get development moving again. It should be noted that this is the first version of BZFlag that had a development plan and release schedule.

The version contains a number of new features.

==Change Log==
Some of the major features include:

*The ability to turn off teamkilling on the server
*The OpenFFA game mode which is a teamless FFA, meaning you can shoot anyone regardless of color
*Per-object ricochet, which lets map authors selectively enable ricochet for individual objects
*Removal of local authentication
*Ability for the server to force flags to be hidden on the radar
*Fog can not be turned off
*The screenshot code does not lag the client badly anymore
*The ID flag identification was moved to the server
*Public servers must have a -publickey
*Polls only count users that are able to vote

The full changelog can be found at https://bzflag.svn.sourceforge.net/svnroot/bzflag/tags/v2_4_0/ChangeLog

==Upgrades==
2.4 requires server owners to take note of a few upgrade steps in order to move from 2.0.x to 2.4.

A general overview of the upgrade procedure can be found on the [[BZFS 2.4 Upgrade]] page.

===API===
The [[BZFS API]] received a major overhaul in 2.4 and is incompatible with older plug-ins, upgrade information can be found on the [[BZFS API 2.4 Upgrade]] page.

[[Category:Versions]]
[[Category:Releases]]

DevelopmentPlans/2.6.0

2013-06-06T10:41:13Z

Alezakos: Add page to the Development Plans category

==Overview==

2.6.0 will be a new breaking release that is not compatible with the 2.4.x line. A strong focus of this release should be improving the user experience and improving the flexibility of the user interface.

==Goals==

This list covers the major goals of this release, and the features related to each goal.

* Tutorial Mode (1.1.1, 1.1.2, 4.1, 4.2, 4.3, 5.1, 5.2, 5.3, 6.1, 6.2, 6.3, 7.1, 7.2)
* Easier polling system (1.1.2, 2.1, 2.2)
* Useful MOTD (1.1.1, 3.1, 3.2)
* Better localized messages (4.1, 4.2, 4.3, 5.1, 7.1)
* Additional mapping features (5.1, 5.2, 5.3)

==Features==

# Add new UI elements
## [[DevelopmentPlans/Dialogs|Dialogs]]
### Modal dialogs are featured front and center, and require being dismissed by the user. They support hotkeys, server-specified buttons, or freeform menu items. Keyboard, mouse (including clicking items), and joystick interaction is supported.
### Unobtrusive dialogs show up as smaller semi-transparent boxes towards the edge of the screen and support only hotkeys (keyboard, mouse button, joystick button) for interaction.
# Revamp the poll system
## Add an actual message type to the protocol for the poll system (MsgPoll and MsgVote, perhaps, or just build it with generic dialog message types)
## Add an unobtrusive dialog for polls with support for both the old style /vote command and polling/dialog key bindings.
# Revamp the MOTD
## Update client MOTD code to send the client version and other system information (operating system and similar) to the server. The MOTD server would then use this information to send appropriate MOTD entries.
## Have the MOTD code detect when there is a new MOTD and pop up a modal dialog. Include a MOTD menu item for later access.
# Font system and language support
## New font system (FTGL or similar)
## Add the additional fonts and better translations from 2.99.x.
## Send the client locale to the server so that the server could localize messages sent to the client
# Map features
## Text object (from 2.99.x)
## BZDB controlled attributes
## Mesh bases/teleporters
## Better define/group support
### Links (with relative and absolute names)
### World weapons and entry zones (with transforms)
### Physics drivers (with transforms and copying)
### Texture matrices, dynamic colors, transforms, materials
# Server Side Players
## Server-side shot path tracking
## Shared client logic library used in both the client and server.
## Ability to spawn and control SSPs from a plugin.
# Other
## Add a per-player name/value pair system. This would be used for data like:
##* Motto
##* Locale
## Implement MsgAllow from 2.99.x (or should this be part of the per-player name/value pair system?)
## [[DevelopmentPlans/ShotIDCleanup|Shot ID cleanup]]
## Make client aware of shot limit so it can display count and can know when the flag is going to drop
## Allow switching teams without rejoining
## Rework the joining process
### Handle all ban checks (including DNS resolution and hostban checks) before allowing the player to pull the world or enter.
### Move team selection to after the join (start off in observer, and have a dialog)
## List server indication of game options that are per object or zone ( rico, jump, etc..)
## Generic server-controlled marker and hunt system.
## Use BZID for all saved user identifiers not names.

[[Category:Development Plans]]

Acceptable Use Policy

2013-05-14T14:26:45Z

Alezakos: CVS --> SVN

The BZFlag project provides several resources, including:
* The #bzflag IRC channel.
* The BZFlag web page, including the wiki.
* The BZFlag online forums at http://my.bzflag.org/bb/
* The list server
* Sourceforge resources, including SVN, trackers, forums and mailing lists

Access to these resources is granted purely at the discretion of the
developers and project administrators. We're nice people, but since
we're working to foster a community, there are a few rules we have to
enforce in order to maintain it. If you behave, the BZFlag community can
be a tremendously fun and friendly group to associate with.

The BZFlag community is also exceptionally good at protecting themselves from harmful users. If you're acting up, we ''will'' get complaints. Any behavior
seen as severely detrimental to the community will be dealt with. We'll make
a reasonable effort to talk to you before taking any action.

Things we won't tolerate:
* Derogatory statements with regard to race, color, creed, gender or other bigotry
* Extreme profanity
* Using bzflag resources as a personal political soapbox
* Threats of any kind against us or any member of the community

These resources are for the most part provided at our own expense with
our own money and time. This means that we do not owe you ''anything.''
The BZFlag community is very good at reporting to us when someone is
being a problem. If we ask you to stop doing something, stop doing it.
If not, eventually you will be banned. In extreme cases, we may exclude
you completely from the community.

If you do manage to get yourself banned, you won't help your case by threatening
to sue or inflict bodily harm, throwing a tantrum or performing attacks such
as denial-of-service. It's almost unheard of for someone to be banned for
a lifetime, and after a while, we'll give you another chance. Threats will
only extend the length of your ban.

We're reasonable people, but it takes only a couple abusive players to ruin
the game for everyone. If you think we're being unreasonable about something,
you're free to argue your case, but we've dealt with a lot of problems, so
it's unlikely you'll convince us.

This document is an attempt to clarify our position on use of the resources
provided by the BZFlag project. It is not a binding legal document, nor is
it an exhaustive list of the things that can get you banned. This document
may change without notice at any time.

Game servers are run at the discretion of their respective operators, who
may or may not observe these policies.

[[Category:Support]]

Global Registration

2013-05-06T12:20:31Z

Alezakos: /* Third party sites */ Update link to the new SVN repo

==Overview==

Global Registration is the link between the [[BZFlag Forums]] and the BZFlag [[List Server]]. This link allows players to use their forum users names as call signs in game, and receive a number of in game services tied to that account, such as;

* exclusive use of the name on most servers
* the ability to remove or "ghost" unregistered users attempting to use your existing name.
* access to public groups that many servers use to grant in game permissions.

==Registration and Account Management==
Currently registration and account management is handled by the [[BZFlag Forums]], but may be split off to a separate system at a later date. Users wishing to create a global account should visit the forums and create a new account. Each user account will require a unique e-mail address.

=== Activation ===
After registration is complete, the user will receive a verification e-mail to ensure that all contact information is correct. The user must follow the instruction in the e-mail before the account will be made active and can be used.

===Username and Password Changes===
The user can use the "profile" page on the fourms to modify any of the information about the account, including username and password. It his highly recomended that users keep their passwords secure.

===Password Retrieval===
In the unfortunate event that a user forgets their password, they can use the "forgot password" link on the fourm login page to have the system e-mail them a new password.

==Security==
Passwords are encrypted and stored only in the registration system's database, they are never sent out to game servers, or any other player. The list server uses a temporary token system when communicating with game servers to protect the user's private information.

Weak passwords based on simple numeric strings (1234) or dictionary words (dog, god, mom ) are easily guessable and are not recommended. Users are responsible for keeping their own passwords secure.

'''NOTE:'''

By default, BZFlag saves your game settings when you exit the program. If you entered your password in the "Join Game" menu, it will be saved in plain text in the configuration file along with other settings. If you share this configuration file with anyone (for debugging, etc) they will have your password!

==In Game services==

===Usage===
To use your global account in game, a user must enter their forum username as the callsign, and enter their forum password into the appropriate fields in the "Join Game" menu in the game client.

===Callsign Markers===
In-game, when a registered callsign has been authenticated, the callsign is prefixed with a '+' symbol as displayed on the user's screen.

If a registered callsign is used, but failed authentication for any reason, it is displayed with a '-' symbol prefixed.

The callsign of the game server's administrator ( with kick, ban and other powers ) is prefixed with a '@' symbol when they are logged into the game.

Examples:

tankdriver1 : a player with an unregistered callsign
+tankdriver2 : a player with a registered callsign that has been authenticated
-tankdriver3 : a player with a registered callsign that has ''not'' been authenticated
@tankdriver4 : a player who has administrative rights on the game server

==Third party sites==
BZFlag provides a service to allow third party sites to use bzflag login info to authenticate users. This can be very useful and allows many sites the ability to do lots of cool things. When using one of these sites, it must send you first to the bzflag.org site to login. This prevents the website from being able to capture your password. A third party site should never ask a user for a global password directly. When entering in login information, users can check the address bar of the page they are using and check to see that it is my.bzflag.org. No other addresses will keep passwords secure.
In order to allow users to authenticate on your website using the official BZFlag service, you can utilize the [http://sourceforge.net/p/bzflag/code/HEAD/tree/trunk/bzflag/misc/checkToken.php checkToken.php] script.

==See also==
[[List Server Usage Policy]]

[[List Server]]

[[BZFS]]

[[Category:Public Services]]

Bz resetFlags

2013-03-23T21:03:38Z

Alezakos: add the new keepTeamFlags parameter

{{BZFS_API_Doc}}
{{BZFS_API_Funcs}}
==Prototype==
BZF_API void bz_resetFlags ( bool onlyUnused, bool keepTeamFlags = false );
==Parameters==
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|onlyUnused
|bool
|only reset non-player flags
|-
|keepTeamFlags
|bool
|don't reset team flags (defaults to ''false'')
|}

==Description==
This API function will force all flags to be reset and respawned. If the onlyUnused parameter is true, then flags carried by players will not be reset, otherwise all flags will be reset. If the keepTeamFlags parameter is true, then team flags will not be reset.

Functions (API)

2013-03-23T21:01:09Z

Alezakos: /* Flag Management */

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.3.x<br>
Verify future 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 ===
2.0.x
BZF_API bool [[bz_registerEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
BZF_API bool [[bz_removeEvent]] ( [[Event(API)|bz_eEventType]] eventType, [[Event(API)|bz_EventHandler]]* eventHandler );
2.3+
BZF_API bool [[Register]] ( [[Event(API)|bz_eEventType]] eventType );
virtual void Cleanup() {Flush();}

=== Non-Player Connections ===
2.3+
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 );
BZF_API unsigned int [[bz_getNonPlayerConnectionOutboundPacketCount]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionIP]] ( int connectionID );
BZF_API const char* [[bz_getNonPlayerConnectionHost]] ( int connectionID );

=== Player Information ===
==== Player Information ====
2.3+
BZF_API bool [[bz_hasPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_getAdmin]] ( int playerID );
BZF_API bz_eTeamType [[bz_getPlayerTeam]] ( int playerID );
BZF_API const char* [[bz_getPlayerCallsign]] ( int playerID );
BZF_API const char* [[bz_getPlayerIPAddress]] ( int playerID );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );
?
BZF_API const char* [[bz_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );

==== Player State Information ====
2.3+
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
?
BZF_API bool [[bz_getPlayerPosition]] ( int playerID, float pos[3], bool extrapolate );
BZF_API bool [[bz_getPlayerRotation]] ( int playerID, float *rot, bool extrapolate );
BZF_API bool [[bz_getPlayerVelocity]] ( int playerID, float vel[3] );
BZF_API bool [[bz_getPlayerAngVel]] ( int playerID, float *angvel );
BZF_API bool [[bz_getPlayerPhysicsDriver]] ( int playerID, int* phydrv );

==== Player Lists and Records ====
2.3+
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByIndex]] ( int index );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByCallsign]] ( const char* name );
BZF_API [[bz_BasePlayerRecord]] *[[bz_getPlayerByBZID]] ( int BZID );
BZF_API bool [[bz_updatePlayerData]] ( [[bz_BasePlayerRecord]] *playerRecord );
BZF_API bool [[bz_freePlayerRecord]] ( [[bz_BasePlayerRecord]] *playerRecord );

BZF_API [[bz_APIIntList]] *[[bz_newIntList]] ( void );
BZF_API [[bz_APIIntList]] *[[bz_getPlayerIndexList]] ( void );
BZF_API bool [[bz_getPlayerIndexList]] ( [[bz_APIIntList]] *playerList );
BZF_API void [[bz_deleteIntList]] ( [[bz_APIIntList]] *l);

==== Player Management ====
2.3+
BZF_API bool [[bz_grantPerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_revokePerm]] ( int playerID, const char* perm );
BZF_API bool [[bz_validAdminPassword]] ( const char* passwd );
BZF_API bool [[bz_setPlayerOperator]] ( int playerId );
?
BZF_API bool [[bz_setPlayerSpawnable]]( int playerID, bool spawn );
BZF_API bool [[bz_setPlayerLimboMessage]]( int playerID, const char* text );
BZF_API bool [[bz_setPlayerCustomData]] (int playerID, const char* key, const char* data );

=== Team Management ===
2.3+
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 ===
2.3+
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 );
BZF_API float [[bz_getPlayerRank]] ( int playerId );

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

=== Permission Group Management ===
2.3+
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 ===
2.3+
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 );
BZF_API bool [[bz_sendJoinServer]] ( int playerID, const char* address, int port, int team, const char* referrer, const char* message );
BZF_API bool [[bz_sendLuaData]] ( int dstPlayerID, int dstScriptID, int statusBits, const char* data, int len,
int srcPlayerID = 0, int srcScriptID = 0 );

=== Server Management ===
2.3+
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]] ();
BZF_API int [[bz_getPlayerCount]] ( void );
?
BZF_API bool [[bz_anyPlayers]] ( void );

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

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

=== Flag Management ===
2.3+
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, bool keepTeamFlags = false );
BZF_API unsigned int [[bz_getNumFlags]] ( void );
BZF_API const [[bz_ApiString]] [[bz_getFlagName|bz_getName]] ( 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] );
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 ===
2.3+
BZF_API bool [[bz_fireWorldWep]] ( const char* flagType, float lifetime, int fromPlayer, float *pos, float tilt, float direction, int shotID , float dt, bz_eTeamType shotTeam = eRogueTeam );
BZF_API int [[bz_fireWorldGM]] ( int targetPlayerID, float lifetime, float *pos, float tilt, float direction, float dt, bz_eTeamType shotTeam = eRogueTeam );

=== Server Time ===
2.3+
BZF_API double [[bz_getCurrentTime]] ( void );
BZF_API void [[bz_getLocaltime]] ( [[bz_Time]] *ts );
BZF_API void [[bz_getUTCtime]] ( [[bz_Time]] *ts );

?
BZF_API float [[bz_getMaxWaitTime]] ( void );
BZF_API void [[bz_setMaxWaitTime]] ( float maxTime );

=== Global Database Management (BZDB) ===
2.3+
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_getBZDBItemPesistent]] ( 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 ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( int bannedByIndex, const char* ip, int duration, const char* reason );
BZF_API bool [[bz_HostBanUser]] ( int bannedByIndex, const char* hostmask, int duration, const char* reason );
BZF_API bool [[bz_IPUnbanUser]] ( const char* ip );
BZF_API bool [[bz_IDUnbanUser]] ( const char* bzID );
BZF_API bool [[bz_HostUnbanUser]] ( const char* hostmask );

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 );

?
BZF_API bool [[bz_IDBanUser]] ( int bannedByIndex, const char* bzID , int duration, const char *reason );

=== Reporting ===
2.3+
BZF_API [[bz_APIStringList]]* [[bz_getReports]] ( void );
?
BZF_API unsigned int [[bz_getReportCount]] ( void );
BZF_API const char* [[bz_getReportSource]] ( unsigned int id );
BZF_API const char* [[bz_getReportBody]] ( unsigned int id );
BZF_API const char* [[bz_getReportTime]] ( unsigned int id );
BZF_API bool [[bz_clearReport]] ( unsigned int id );
BZF_API bool [[bz_clearAllReports]] ( void );
BZF_API bool [[bz_fileReport]] ( const char* message, const char* from );

=== Timed Game Management ===
2.3+
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 ===
2.3+
BZF_API bool [[bz_registerCustomSlashCommand]] ( const char* command, [[bz_CustomSlashCommandHandler]] *handler );
BZF_API bool [[bz_removeCustomSlashCommand]] ( const char* command );

=== Plug-in Management ===
2.3+
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 const char* [[bz_pluginBinPath]] ( void );
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 ===
2.3+
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API int [[bz_getPublicPort]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

=== HTTP Transfer ===
2.3+
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 );

=== Callback Functions ===
?
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_registerCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallback]] *callback );
BZF_API bool [[bz_removeCallBack]] ( const char* name, [[bz_GenericCallbackFunc]] callback );
BZF_API bool [[bz_callCallback]] ( const char* name, void *param );
BZF_API bool [[bz_callbackExists]] ( const char* name );

=== Inter-Plug-in Communications ===
2.3+
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 bool [[bz_removeClipFieldNotifier]] ( const char *name, [[bz_ClipFiledNotifier *cb );

=== Game Recording ===
2.3+
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 unsigned int [[bz_getWorldObjectCount]] ( void );
BZF_API [[bz_APIWorldObjectList]]* [[bz_getWorldObjectList]] ( void );
BZF_API void [[bz_releaseWorldObjectList]] ( [[bz_APIWorldObjectList]] *list );
BZF_API unsigned int [[bz_findWorldObject]] ( const char *name );
BZF_API [[bz_APIBaseWorldObject]]* [[bz_getWorldObjectByID]] ( unsigned int id );
BZF_API bool [[bz_getTeleLinkIDs]] ( const char* teleName, int* frontLink, int* backLink );
BZF_API const char* [[bz_getLinkTeleName]] ( int linkIndex );
BZF_API int [[bz_getPhyDrvID]] ( const char* phyDrvName );
BZF_API const char* [[bz_getPhyDrvName]] ( unsigned int phyDrvID );
BZF_API bool [[bz_SetWorldObjectTangibility]] ( int id, const [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API bool [[bz_GetWorldObjectTangibility]] ( int id, [[bz_SolidObjectPassableAtributes]] &atribs );
BZF_API void [[bz_ResetWorldObjectTangibilities]] ( void );

==== 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 ====
2.3+
BZF_API bool [[bz_registerCustomMapObject]] ( const char* object, [[bz_CustomMapObjectHandler]] *handler );
BZF_API bool [[bz_removeCustomMapObject]] ( const char* object );

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

=== Misc ===
2.3+
BZF_API bool [[bz_getStandardSpawn]] ( int playerID, float pos[3], float *rot );
BZF_API bool [[bz_killPlayer]] ( int playerID, bool spawnOnBase);
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] );
BZF_API int [[bz_APIVersion]] ( void );
?
BZF_API bool [[bz_allowJumping]] ( void );

=== Server Side Players (Development) ===
? (In API for 2.3+, but will crash a server)
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]]