BZFlagWiki - User contributions [en]

Web Services

2011-05-16T23:06:01Z

Mrapple: Add link for home page

===Possible services layout===

* [[Web_Services/Home_Page|Home Page]] (bzflag.org)
** Portal to all other sites
** News postings
* Wiki (wiki.bzflag.org)
* [[Web_Services/Player_Portal|Player Portal]]
** User management
*** Registration
*** User profile
*** Enable various other services (forum, wiki, API) (?)
** Weblogin System
** Group management
*** Create/modify/remove groups
*** View where groups are being used (?)
*** View group membership
** Server key management
* Social site (social.bzflag.net)
** Group/clan/team pages/mini-forums
** Blog-like posting
** Social networking
** League hosting (?)
* Player stats site (stats.bzflag.org)
** Stats for registered players only
** Stats would be pushed to the site
*** Built into 3.x.x
*** Available as a plugin for 2.0.x
* API (api.bzflag.org)
** Player registration (?)
** Player stats
** Server list
** Group management
* Forum (forum.bzflag.org)
** Mainly for support topics
* Map resource hosting (resources.bzflag.org)
** Replacement for images.bzflag.org

Config File

2011-03-13T01:22:41Z

Mrapple: This could confuse some people

BZFlag uses an ASCII configuration file to store user settings. The file is called "config.cfg."
==Location==
The location of the config file depends on your operating system.
===Windows===
'''XP''': C:\Documents and Settings\[user]\My Documents\My BZFlag Files\2.0\config.cfg <br />
'''Vista''': C:\Users\[user]\Documents\My BZFlag Files\2.0\config.cfg

(Of course, replace [user] with your username)

===Mac OS X===
~/Library/Application Support/BZFlag/2.0/config.cfg
set list http://my.bzflag.org:81/db

===Linux and unix platforms===
~/.bzf/2.0/config.cfg

Note: "~" is your home directory
==Editing the Config File==
As the config file is a text file, it is possible to directly edit it via text-editor instead of through the built-in GUI. Most things can be edited through the in-game GUI, however, there are some things that you can only add via text-editor. Settings that can only be set by editing the config file directly will be discussed here. (Note: these can also be set in-game with the /localset or /bind commands).

===Localset Options===
set highlightPattern "laser"
set highlightPattern "laser|genocide"
set highlightPattern "(Team Flag|Team's Flag|Genocide)"
''highlightPattern'' highlights lines with the selected words when they appear in the console(chat box).
*When highlighting one word, just type the word in quotes, such as "laser."
*If one wants to highlight two or more words, the words must be separated with a '|', such as "laser|genocide" (highlights lines with laser OR genocide).
*If any of the words have spaces, all the words must be surrounded in parentheses, such as "(Team Flag|Team's Flag|Genocide)" (highlights lines with "Team Flag," "Team's Flag," OR "Genocide").

set linedradarshots 10
set linedradarshots 65
''linedradarshots'' sets how long shots are on the radar. While this option ''is'' set-able through the in-game GUI, you can only set this setting up to 10 via the GUI. You can hand-edit your config to give you longer shot lengths.

set latitude 45
set longitude 71
''latitude'' and ''longitude'' set the latitude and longitude for BZFlag's sky rendering system.

''Hint: To always have a black sky set latitude 90 (north pole) or -90 (south pole) for winter/summer respectively.''

===Binding Custom Keys===
One can bind custom keys outside of those given in the in-game GUI.

The standard format for binding a key is as follows:
bind <event> <press> <action>

The event is the key or button that was pressed (or a combination of keys) such as F or "Shift+Page Up". The double quotes are necessary if there are spaces. The press will be one of up, down, or both. If it is set to up, for example, if will only trigger when they key or button is released. And finally, the action is what will be triggered.

For example, the following binding sets ''displayRadarRange'', or how far the radar is zoomed, to 0.12, when the key '`' is pressed.
bind ` down "set displayRadarRange 0.12"

One can use this template to set any of the options in the config file. However, some of the options, like ''radarsize'' need an additional function call that is only called via the options menu, and as such cannot be altered with this method.

One can also use the toggle keyword instead of set to have a key toggle two options:
bind F down "toggle linedradarshots 65"
bind F down "toggle linedradarshots 65 10"
The first line toggles the length of shots on the radar between 65 and an implied 0. The second line toggles ''linedradarshots'' between 65 and 10. This is much easier than having two keys to switch between two options.

''(Don't do this.)''
bind F down "set linedradarshots 65"
bind G down "set linedradarshots 10"

You can also bind one key with two funtions:

bind E down fire
bind E up identify

This will make it so you can fire and lock-on with GM with the same button.

To un-bind a key, just place a hash(#) at the front of the line, or remove the line completely. For example, to if one is tired of unintentionally hitting F12, he or she can simply disable it.
#bind F12 down quit


[[Category:Client]]

Weapon (object)

2010-11-04T21:26:23Z

Mrapple: /* Appearance */

A weapon object is a [[BZW]] map structure that defines a fixed weapon effect. This is also called a '''world weapon'''.

==Code==
The code for a weapon object is as follows
{|
|
weapon
name example_weapon
position 0.0 0.0 0.0
rotation 0.0
color 0
tilt 0.0
initdelay 10.0
delay 10.0 3.0 5.0 3.0
type SW
trigger oncap
eventteam 1
end
|}
Valid parameters for a weapon object are:
<properties>
name=the name of the weapon, generally unused.
position =the position in world units for the effect to begin at
rotation =the orientation in degrees for the effect to fire in.
color =the color the weapon should be. 0: rogue, 1: red, 2: green, 3: blue, 4: purple 5: observer, 6: rabbit - note there is no observer super bolt texture
tilt =the vertical tilt in degrees for the effect to fire in.
initdelay =the delay to wait after the server starts before the effect is triggered.
delay =a list of delays to loop through after the startup delay. (optional)
type = the [[FlagCode]] for the flag effect to use for the weapon. Using V or A for example would create a high speed bullet while using SW would create a shockwave.
trigger =if a delay is not used, when to trigger the flag, currently only oncap is valid.
eventteam =the team to use when looking at oncap weapons. Use numeric values 1 - red 2 - green 3 - blue 4 - purple. Explodes when the flag of that team is captured.
</properties>
The weapon object can be used as many times as desired on a map.
The flag for the weapon must be specified in options. If a worldweapon is desired, without a corresponding flag on the ground, it can be specified without a quantity. +f <flag>

==Appearance==
The weapon object will produce a weapon effect that is exactly the same as similar effects produced by players.

Be sure to note that if you specify an observer shot color and set the shot type to SB (SuperBullet) a white box will appear because there is no texture for an observer super bolt.

==History==
The weapon object was added in [[BZFlag 2.0.0|v2.0.0]].

==Editor Support==
The weapon object is only fully supported by the [[BZWTools]] blender plug-in.

[[Category:Map Making]]
[[Category:Map Objects]]

Weapon (object)

2010-11-04T21:24:56Z

Mrapple: /* Code */

A weapon object is a [[BZW]] map structure that defines a fixed weapon effect. This is also called a '''world weapon'''.

==Code==
The code for a weapon object is as follows
{|
|
weapon
name example_weapon
position 0.0 0.0 0.0
rotation 0.0
color 0
tilt 0.0
initdelay 10.0
delay 10.0 3.0 5.0 3.0
type SW
trigger oncap
eventteam 1
end
|}
Valid parameters for a weapon object are:
<properties>
name=the name of the weapon, generally unused.
position =the position in world units for the effect to begin at
rotation =the orientation in degrees for the effect to fire in.
color =the color the weapon should be. 0: rogue, 1: red, 2: green, 3: blue, 4: purple 5: observer, 6: rabbit - note there is no observer super bolt texture
tilt =the vertical tilt in degrees for the effect to fire in.
initdelay =the delay to wait after the server starts before the effect is triggered.
delay =a list of delays to loop through after the startup delay. (optional)
type = the [[FlagCode]] for the flag effect to use for the weapon. Using V or A for example would create a high speed bullet while using SW would create a shockwave.
trigger =if a delay is not used, when to trigger the flag, currently only oncap is valid.
eventteam =the team to use when looking at oncap weapons. Use numeric values 1 - red 2 - green 3 - blue 4 - purple. Explodes when the flag of that team is captured.
</properties>
The weapon object can be used as many times as desired on a map.
The flag for the weapon must be specified in options. If a worldweapon is desired, without a corresponding flag on the ground, it can be specified without a quantity. +f <flag>

==Appearance==
The weapon object will produce a weapon effect that is exactly the same as similar effects produced by players.

==History==
The weapon object was added in [[BZFlag 2.0.0|v2.0.0]].

==Editor Support==
The weapon object is only fully supported by the [[BZWTools]] blender plug-in.

[[Category:Map Making]]
[[Category:Map Objects]]

Packetloss

2010-10-02T22:13:16Z

Mrapple: Oops

Packetloss is a term used in networking to describe an event where some of the data sent between computers does not reach the intended destination.

This loss of data can have detrimental effects on software that is expecting the data. In the case of BZFlag this data loss causes player tanks to not show correctly on remote clients and causes the game play mechanics to fail.

Many BZFlag game servers will force a user to disconnect if his/her packetloss is too high in order to ensure a playable game for the rest of the players.

=Display=
BZFlag can display a '''packet loss percentage''' in its lagstats. This represents an approximation of the current data loss for the user. The number is computed by keeping track of how many lagping (MsgLagPing) packets are sent and how many are received. This ratio is the packetloss.

=Causes=
All packetloss happens in the network layer of a connection. The most common cause is a weak or intermittent network connection on a client's network. Low frame rate can cause [[Lag]] but not packetloss.

==Wireless networks==
By far the most common reason for both high packetloss and high [[Jitter]] is poor wireless networking at the client end. Wireless networks are easily interrupted by interference from other radio signals. This includes both WIFI, cellular, and satellite connections. Many of these connection technologies are not suited for high speed gaming.

===Common Solutions===
The most basic thing to try when attempting to resolve WIFI related issues is to connect client directly to the internet over an Ethernet cable. If that is not possible then changing the channel that the WIFI uses may help to reduce interference. Other issues are often are often not repairable by the end user, or just a limitation of the connection technology (i.e. satellite).

==Internet Route==
The route from the client to the server can also have packetloss, especially if the server is a long physical distance from the client, or the internet route is complex. These types of issues generally can not be resolved by the end user and are simply the nature of internet data transmissions.

Packetloss

2010-10-02T22:10:47Z

Mrapple: Error

Packetloss is a term used in networking to describe an event where some of the data sent between computers does not reach the intended destination.

This loss of data can have detrimental effects on software that is expecting the data. In the case of BZFlag this data loss causes player tanks to not show correctly on remote clients and causes the game play mechanics to fail.

Many BZFlag game servers will force a user to disconnect if his/her packetloss is too high in order to ensure a playable game for the rest of the players.

=Display=
BZFlag can display a '''packet loss percentage''' in its lagstats. This represents an approximation of the current data loss for the user. The number is computed by keeping track of how many packets are sent and how many are received. This ratio is the packetloss.

=Causes=
All packetloss happens in the network layer of a connection. The most common cause is a weak or intermittent network connection on a client's network. Low frame rate can cause [[Lag]] but not packetloss.

==Wireless networks==
By far the most common reason for both high packetloss and high [[Jitter]] is poor wireless networking at the client end. Wireless networks are easily interrupted by interference from other radio signals. This includes both WIFI, cellular, and satellite connections. Many of these connection technologies are not suited for high speed gaming.

===Common Solutions===
The most basic thing to try when attempting to resolve WIFI related issues is to connect client directly to the internet over an Ethernet cable. If that is not possible then changing the channel that the WIFI uses may help to reduce interference. Other issues are often are often not repairable by the end user, or just a limitation of the connection technology (i.e. satellite).

==Internet Route==
The route from the client to the server can also have packetloss, especially if the server is a long physical distance from the client, or the internet route is complex. These types of issues generally can not be resolved by the end user and are simply the nature of internet data transmissions.

Bz ePlayerCollision

2010-09-26T22:47:14Z

Mrapple: /* Data */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerCollision''' is an API event that is called each time two players collide.
==Data==
'''bz_ePlayerCollision''' returns the '''bz_PlayerCollisionEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerCollision
|-
|players
|int[2]
|The players that have collided
|-
|pos
|float[3]
|The position of the collision
|-
|handled
|bool
|Whether or not the plug-in has handled the data
|}

==Usage==
It appears this event is in BZFlag 2.99.x but has not been fully implemented and will probably never return data.

Functions (API)

2010-09-26T22:41:31Z

Mrapple: /* Player State Information */

{{DoDoc|
Fill in articles for all API Functions<br>
Finish updating to 2.99.x
}}

{{BZFS_API_Doc}}

== Overview ==

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

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

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

=== Non-Player Connections ===
BZF_API bool [[bz_registerNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_removeNonPlayerConnectionHandler]] ( int connectionID, [[bz_NonPlayerConnectionHandler]]* handler );
BZF_API bool [[bz_sendNonPlayerData]] ( int connectionID, const void *data, unsigned int size );
BZF_API bool [[bz_disconectNonPlayerConnection]] ( int connectionID );
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 ====
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_getPlayerReferrer]] ( int playerID );
BZF_API const char* [[bz_getPlayerCustomData]] (int playerID, const char* key );
BZF_API const char* [[bz_getPlayerFlag]] ( int playerID );

==== Player State Information ====
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 );
BZF_API bool [[bz_isPlayerPaused]] ( int playerID );
BZF_API bool [[bz_canPlayerSpawn]]( int playerID );
BZF_API bool [[bz_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );

==== Player Lists and Records ====
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 ====
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 ===
BZF_API unsigned int [[bz_getTeamPlayerLimit]] ( bz_eTeamType team )
BZF_API int [[bz_getTeamCount]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamScore]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamWins]] ([[bz_eTeamType]] team );
BZF_API int [[bz_getTeamLosses]] ([[bz_eTeamType]] team );
BZF_API void [[bz_setTeamWins]] ([[bz_eTeamType]] team, int wins );
BZF_API void [[bz_setTeamLosses]] ([[bz_eTeamType]] team, int losses );
BZF_API void [[bz_resetTeamScore]] ([[bz_eTeamType]] team );
BZF_API void [[bz_resetTeamScores]] ( void );
BZF_API void [[bz_changeTeam]]( int player, [[bz_eTeamType]] team );

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

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

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

=== Chat Messages ===
BZF_API bool [[bz_sendTextMessage]] (int from, int to, const char* message);
BZF_API bool [[bz_sendTextMessage]] (int from, [[bz_eTeamType]] to, const char* message);
BZF_API bool [[bz_sendTextMessagef]] (int from, int to, const char* fmt, ...);
BZF_API bool [[bz_sendTextMessagef]] (int from, [[bz_eTeamType]] to, const char* fmt, ...);
BZF_API bool [[bz_sendFetchResMessage]] ( int playerID, const char* URL );
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 ===
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 ===
BZF_API void [[bz_setClientWorldDownloadURL]] ( const char* URL );
BZF_API const [[bzApiString]] [[bz_getClientWorldDownloadURL]] ( void );
BZF_API bool [[bz_saveWorldCacheFile]] ( const char* file );

=== Flag Management ===

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

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

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

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

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

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

=== Server Administration ===
BZF_API bool [[bz_kickUser]] ( int playerIndex, const char* reason, bool notify );
BZF_API bool [[bz_IPBanUser]] ( const char* ipAddress, const char* ip, int durration, const char* reason );
BZF_API bool [[bz_IDBanUser]] ( const char* bzid, const char* bzID , int duration, const char *reason );
BZF_API bool [[bz_HostBanUser]] ( const char* hostmask, const char* source, 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 );

=== Reporting ===
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 ===
BZF_API bool [[bz_setTimeLimit]] ( float timeLimit );
BZF_API float [[bz_getTimeLimit]] ( void );
BZF_API bool [[bz_isTimeManualStart]] ( void );
BZF_API bool [[bz_isCountDownActive]] ( void );
BZF_API bool [[bz_isCountDownInProgress]] ( void );
BZF_API void [[bz_pauseCountdown]] ( const char *pausedBy );
BZF_API void [[bz_resumeCountdown]] ( const char *resumedBy );
BZF_API void [[bz_startCountdown]] ( int delay, float limit, const char *byWho );

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

=== Plug-in Management ===
BZF_API int [[bz_getLoadedPlugins]] ( bz_APIStringList * list );
BZF_API bool [[bz_loadPlugin]] ( const char* path, const char* params );
BZF_API bool [[bz_unloadPlugin]] ( const char* path );
BZF_API 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 ===
BZF_API bool [[bz_getPublic]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicAddr]] ( void );
BZF_API [[bz_ApiString]] [[bz_getPublicDescription]] ( void );
BZF_API void [[bz_updateListServer]] ( void );

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

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

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

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

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

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

[[plug-ins]]

[[Category:BZFS_API_Functions]]

Bz ePlayerStatus

2010-09-26T22:38:22Z

Mrapple: bz_ePlayerStatus

{{BZFS_API_Doc}}

==Overview==
The bz_ePlayerStatus is used to define the current status of a player.

==Definition==
{| border="1" cellpadding="20" cellspacing="0"
!name
!value description
|-
|eDead
|Player is not alive, not paused, (not not) responding, etc
|-
|eAlive
|Player is alive
|-
|ePaused
|Player is paused
|-
|eExploding
|Player is exploding
|-
|eTeleporting
|Teleported recently
|-
|eInBuilding
|has OO and is in a building
|}

Bz PlayerUpdateState

2010-09-26T22:30:37Z

Mrapple: bz_PlayerUpdateState

{{BZFS_API_Doc}}
==Overview==
bz_PlayerUpdateState contains useful information that allow plugins to determine a player's state.

==Types==
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|falling
|bool
|Not driving on the ground or an obstacle
|-
|crossingWall
|bool
|crossing an obstacle wall
|-
|inPhantomZone
|bool
|zoned or not
|-
|pos
|float[3]
|position of the tank
|-
|velocity
|float[3]
|velocity of the tank
|-
|rotation
|float
|orientation of the tank
|-
|angVel
|float
|angular velocity of the tank
|-
|phydrv
|int
|physics driver the tank is on
|}

Bz setPlayerSpawnable

2010-09-26T21:16:49Z

Mrapple: typo

{{apicall
| name = bz_setPlayerSpawnable
| description = Marks this player as allowed to spawn or not allowed to spawn.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to mark as spawnable.
| param2 = spawn
| param2type = bool
| param2desc = Mark them as able to spawn or not spawn
}}

Bz setPlayerSpawnable

2010-09-26T21:16:04Z

Mrapple: bz_setPlaerSpawnable

{{apicall
| name = bz_setPlaerSpawnable
| description = Marks this player as allowed to spawn or not allowed to spawn.
| param1 = playerID
| param1type = int
| param1desc = The id of the player to mark as spawnable.
| param2 = spawn
| param2type = bool
| param2desc = Mark them as able to spawn or not spawn
}}

Bz eShotTeleportEvent

2010-09-25T19:05:47Z

Mrapple: bz_eShotTeleportEvent

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eShotTeleportEvent''' is an API event that is called each time a shot teleports via a teleporter.
==Data==
'''bz_eShotTeleportEvent''' returns the '''bz_ShotTeleportEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eShotTeleportEvent
|-
|playerID
|int
|ID of the player whos shot was teleported
|-
|shotID
|int
|ID of the shot that teleported
|-
|type
|[[bz_APIString]]
|What type the shot was
|-
|pos
|float[3]
|Where the shot teleported
|-
|linkSrcID
|int
|ID of the teleporter the shot went into
|-
|linkDstID
|int
|ID of the teleporter the shot came out of
|}
==Usage==
Data returned can not be modified.

Bz eShotStoppedEvent

2010-09-25T19:02:56Z

Mrapple: bz_eShotStoppedEvent

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eShotStoppedEvent''' is an API event that is called each time a shot stops.
==Data==
'''bz_eShotStoppedEvent''' returns the '''bz_ShotStoppedEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eShotStoppedEvent
|-
|playerID
|int
|ID of the player whos shot stopped
|-
|shotID
|int
|ID of the shot that stopped
|-
|type
|[[bz_APIString]]
|What type the shot was
|-
|pos
|float[3]
|Where the shot stopped
|-
|obstacleGUID
|unsigned int
|ID of what obstacle the shot stopped on
|}
==Usage==
Data returned can not be modified.

Bz ePlayerSentCustomData

2010-09-25T18:59:57Z

Mrapple: bz_ePlayerSentCustomData

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerSentCustomData''' is an API event that is called each time a player is sent custom data.
==Data==
'''bz_ePlayerSentCustomData''' returns the '''bz_PlayerCustomData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerSentCustomData
|-
|playerID
|int
|ID of the player receiving the change
|-
|key
|const char*
|The BZDB variable being changed
|-
|data
|const char*
|The value its changing too
|}
==Usagae==
Data can be changed.

Bz eShotRicochetEvent

2010-09-25T18:53:51Z

Mrapple: bz_eShotRicochetEvent

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eShotRicochetEvent''' is an API event that is called each time a shot ricochetes.
==Data==
'''bz_eShotRicochetEvent''' returns the '''bz_ShotRicochetEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eShotRicochetEvent
|-
|playerID
|int
|ID of the player whos shot ricocheted
|-
|shotID
|int
|ID of the shot that ricocheted
|-
|type
|[[bz_APIString]]
|What type the shot was
|-
|pos
|float[3]
|Where the shot ricocheted
|-
|obstacleGUID
|unsigned int
|ID of what obstacle the shot ricocheted off of
|}
==Usage==
Data returned can not be modified.

Bz eShotExpiredEvent

2010-09-25T18:50:13Z

Mrapple: bz_eShotExpiredEvent

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eShotExpiredEvent''' is an API event that is called each time a shot expires.
==Data==
'''bz_eShotExpiredEvent''' returns the '''bz_ShotExpiredEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eShotExpiredEvent
|-
|playerID
|int
|ID of the player who fired the shot
|-
|shotID
|int
|ID of the shot that expired
|-
|type
|[[bz_APIString]]
|What type the shot was
|-
|pos
|float[3]
|Where the shot expired
|}
==Usage==
Data returned can not be modified.

Bz ePlayerUpdateDoneEvent

2010-09-25T18:47:12Z

Mrapple: bz_ePlayerUpdateDoneEvent

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerUpdateDoneEvent''' is an API event that is called each time a player update finishes.
==Data==
'''bz_ePlayerUpdateDoneEvent''' returns the '''bz_PlayerUpdateDoneEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerUpdateDoneEvent
|-
|playerID
|int
|ID of the player whos update finished
|-
|stateTime
|double
|The time the update finished
|}
==Usage==
Data returned can not be modified.

Bz ePlayerTeamChangeEvent

2010-09-25T18:44:51Z

Mrapple: bz_ePlayerTeamChangeEvent

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerTeamChangeEvent''' is an API event that is called each time a player switches teams via bz_changeTeam().
==Data==
'''bz_ePlayerTeamChangeEvent''' returns the '''bz_PlayerTeamChangeData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerTeamChangeEvent
|-
|playerID
|int
|ID of the player whos team was switched
|-
|oldTeam
|[[bz_eTeamType]]
|The team the player used to be on
|-
|newTeam
|[[bz_eTeamType]]
|The new team the player is on
|}
==Usagae==
Data returned can not be modified.

Bz ePlayerPauseRequestEvent

2010-09-25T18:42:01Z

Mrapple: /* Data */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerPauseRequestEvent''' is an API event that is called each time a player wants to pause.
==Data==
'''bz_ePlayerPauseRequestEvent''' returns the '''bz_PlayerPauseRequestData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerPauseRequestEvent
|-
|playerID
|int
|ID of the player who wants to pause
|-
|allow
|bool
|Wether or not to allow the pause
|-
|reason
|[[bz_APIString]]
|The reason if pause request is denied. Default: pause request denied
|}

==Usage==
Data retured can be modified.

Bz ePlayerPauseRequestEvent

2010-09-25T18:41:14Z

Mrapple: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_ePlayerPauseRequestEvent''' is an API event that is called each time a player wants to pause. ==Data== '''bz_ePlayerPauseReques...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerPauseRequestEvent''' is an API event that is called each time a player wants to pause.
==Data==
'''bz_ePlayerPauseRequestEvent''' returns the '''bz_PlayerPauseRequestData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerPauseRequestEvent
|-
|playerID
|int
|ID of the player who wants to pause
|-
|allow
|bool
|Wether or not to allow the pause
|-
|reason
|bz_ApiString
|The reason if pause request is denied. Default: pause request denied
|}
==Usage==
Data retured can be modified.

Bz ePlayerCustomDataChanged

2010-09-25T18:37:02Z

Mrapple: /* bz_ePlayerCustomDataChanged */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerCustomDataChanged''' is an API event that is called each time bz_setPlayerCustomData() is run.
==Data==
'''bz_ePlayerCustomDataChanged''' returns the '''bz_PlayerCustomData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerCustomDataChanged
|-
|playerID
|int
|ID of the player receiving the change
|-
|key
|const char*
|The BZDB variable being changed
|-
|value
|const char*
|The value its changing too
|}
==Usagae==
All data retured is only for notification purposes.

Bz eLuaDataEvent

2010-09-25T18:32:25Z

Mrapple: /* Overview */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eLuaDataEvent''' is an API event that is called each time a BZDB variable is changed.

==Data==
'''bz_eLuaDataEvent''' returns the '''bz_LuaDataEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eLuaDataEvent
|-
|srcPlayerID
|int
|ID of the player sending the data
|-
|dstPlayerID
|int
|ID of the player receiving the data
|-
|srcScriptID
|int
|ID of the sending script
|-
|dstScriptID
|int
|ID of the receiving script
|-
|status
|int
|Status of the data
|-
|data
|const char*
|The data being sent
|-
|doNotSend
|bool
|Whether or not to send the data
|}
==Usagae==
All data retured is only for notification purposes except for doNotSend.

Bz eLuaDataEvent

2010-09-25T18:31:53Z

Mrapple: forgot bz_

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The ''bz_'eLuaDataEvent''' is an API event that is called each time a BZDB variable is changed.
==Data==
'''bz_eLuaDataEvent''' returns the '''bz_LuaDataEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eLuaDataEvent
|-
|srcPlayerID
|int
|ID of the player sending the data
|-
|dstPlayerID
|int
|ID of the player receiving the data
|-
|srcScriptID
|int
|ID of the sending script
|-
|dstScriptID
|int
|ID of the receiving script
|-
|status
|int
|Status of the data
|-
|data
|const char*
|The data being sent
|-
|doNotSend
|bool
|Whether or not to send the data
|}
==Usagae==
All data retured is only for notification purposes except for doNotSend.

Bz eLuaDataEvent

2010-09-25T18:30:10Z

Mrapple: /* eLuaDataEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''eLuaDataEvent''' is an API event that is called each time a BZDB variable is changed.
==Data==
'''eLuaDataEvent''' returns the '''bz_LuaDataEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|eLuaDataEvent
|-
|srcPlayerID
|int
|ID of the player sending the data
|-
|dstPlayerID
|int
|ID of the player receiving the data
|-
|srcScriptID
|int
|ID of the sending script
|-
|dstScriptID
|int
|ID of the receiving script
|-
|status
|int
|Status of the data
|-
|data
|const char*
|The data being sent
|-
|doNotSend
|bool
|Whether or not to send the data
|}
==Usagae==
All data retured is only for notification purposes except for doNotSend.

Bz eBZDBChange

2010-09-25T18:21:54Z

Mrapple: /* bz_eBZDBChange */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eBZDBChange''' is an API event that is called each time a BZDB variable is changed.
==Data==
'''bz_eBZDBChange''' returns the '''bz_BZDBChangeData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eBZDBChange
|-
|key
|[[Bz_APIString]]
|The variable that was changed
|-
|value
|[[Bz_APIString]]
|What the variable was changed too
|}

Bz eAutoPilotChangeEvent

2010-09-25T18:17:11Z

Mrapple: /* Data */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eAutoPilotChangeEvent''' is an API event that is called each time a player is about to change autopilot.
==Data==
'''bz_eAutoPilotChangeEvent''' returns the '''bz_eAutoPilotChangeData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAutoPilotChangeEvent
|-
|playerID
|int
|Who is changing their autopilot
|-
|autopilot
|bool
|Whether the player is turning auto pilot on / off
|-
|allow
|bool
|Whether or not to allow the change
|}

Bz eAutoPilotChangeEvent

2010-09-25T18:16:47Z

Mrapple: /* bz_eAutoPilotChangeEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eAutoPilotChangeEvent''' is an API event that is called each time a player is about to change autopilot.
==Data==
'''bz_eAutoPilotChangeEvent''' returns the '''bz_eAutoPilotChangeEvent''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAutoPilotChangeEvent
|-
|playerID
|int
|Who is changing their autopilot
|-
|autopilot
|bool
|Whether the player is turning auto pilot on / off
|-
|allow
|bool
|Whether or not to allow the change
|}

Bz eAllowAutoPilotChangeEvent

2010-09-25T18:13:08Z

Mrapple: /* bz_eAllowAutoPilotChangeEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''eAllowAutoPilotChangeEvent''' is an API event that is called each time a player is about to change autopilot.
==Data==
'''eAllowAutoPilotChangeEvent''' returns the '''bz_AutoPilotChangeData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|eAllowAutoPilotChangeEvent
|-
|allow
|bool
|Whether or not to allow the change
|}

Events (API)

2010-09-25T18:08:14Z

Mrapple: OK its right this time

{{BZFS_API_Doc}}
==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]] 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;

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

The plug-in registers and event callback derived from [[bz_EventHandler]] 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]] entry point, the plug-in must remove the installed callback by calling the function;

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

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] 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' method of the installed callback class.

virtual void process ( 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_eNetDataReceveEvent]]
[[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]]

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]]

Events (API)

2010-09-25T18:06:54Z

Mrapple: /* Alphabetical? */

{{BZFS_API_Doc}}
==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]] 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;

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

The plug-in registers and event callback derived from [[bz_EventHandler]] 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]] entry point, the plug-in must remove the installed callback by calling the function;

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

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] 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' method of the installed callback class.

virtual void process ( 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_eNetDataReceveEvent]]
[[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]]

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]]

Events (API)

2010-09-25T18:04:43Z

Mrapple: Alphabetically Sorted (yay)

{{BZFS_API_Doc}}
==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]] 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;

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

The plug-in registers and event callback derived from [[bz_EventHandler]] 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]] entry point, the plug-in must remove the installed callback by calling the function;

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

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] 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' method of the installed callback class.

virtual void process ( 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_eNetDataReceveEvent]]
[[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]]

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]]

Bz eZoneExitEvent

2010-09-25T17:56:15Z

Mrapple: Shouldn't be a stub. What more is there to say?

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eZoneExitEvent''' is an API event that is called each time a player leaves a [[zone]] on a [[BZW]] map. The event is unused and has no data.

Administrator

2010-09-25T17:54:25Z

Mrapple: Expanded Article

An [[administrator]] is usually an owner of the server, or are trusted friends of the owner who enforce server rules to make the most of the game. They are there to protect the good players, and get rid of rule breakers, depending on the server rules.

An [[administrator]] can also mean an adminsistrator on the [http://my.bzflag.org/bb/ forums]. Along with server admins, there are also forum admins which moderate the forums. Most of them are also project admins for the project on sourceforge.net.

The [[administrator]] may be able to start/shutdown the server and edit the many options of it, depending on their [[Server Permissions|permissions]].

==Display==
On the [[scoreboard]], most admins have an '''@''' sign next to their name. There is a way, through permissions, for an admin to appear as only a regular registered user with a '''+''' and these are called ''Hidden Admins''.
For a person to become a ''Hidden Admin'' they must have the "hideAdmin" permission. This can be assigned by the owner in the server's group file. Note that for a person to have an "@" they must have either shortBan or Ban permissions, otherwise they will not have an "@" sign.

There is also a plugin called [[ShowAdmin]] that allows server owners to show a player as an admin even if they don't have shortBan or Ban.

==Permissions==
Administrators can run many [[Slash Commands | commands]] on the server depending on the [[Server Permissions|permissions]] given to them by the server owner, they may include the following:
*/kick
*/ban
*/banlist
*/mute
*/say
*/set
*/flag (reset,give/take)
*The list continues... more in [[Slash Commands]]

Terms have appeared for administrators with various permissions. In general, ones with only a few permissions are called "cop". People referred to as cops often don't have permissions such as ban or flagMaster. Administrators with the hideAdmin permission are often referred as "hidden admin" or "hidden cop". Administrators with more permissions than cops and hidden admins are normally called simply "admin". Sometimes, a server owner will reserve certain permissions for himself only, such as shutdownServer, to protect his server from disappearing off the list server.

Other time server owners will also setup a /password via the -passwd option. This allows them, at any time, to gain full access to the server. If they forget their bzbb password or are using a different account, this can come in handy.

==Becoming an Admin==
Perhaps the number one rule of becoming a server admin is to '''never ask to become one'''. Most owners frown upon this and will not consider you for future promotions. You do not need to bring anything to their attention, if they need an admin, they will ask someone if they would like to become one.

One way to increase your chances of becoming an admin is to register on the [http://my.bzflag.org/bb/ forums] and participate in the community. Post responses to people's questions. Help out with what you're capable of doing. Getting involved and being noticed as a helpful and good addition to the community is a good way to increase your chances of becoming an admin.

Trust is also an important value to have in an admin. If you are not trustworthy, then being a server admin probably isn't for you. Server owners usually only let trusted people become server admins. If you do something behind the server owner's back or are always trying to get promoted, chances are you will be removed or possibly even banned.

==Being a Good Admin==
A good admin exhibits several traits. A good admin enforces and follows the rules set by the server owner, and does not interfere with honest game play. They also are always vigilant for [[Known Cheats|cheaters]]. The admin supports the server and promotes good and courteous gameplay. When you find a disruptive player, don't kick or ban right away. If they are using abusive language, then mute them, don't kick them. If they log out, and then back in to avoid the mute, then kick them. Be sure to only kick, mute, or ban someone if they are breaking the specific server rules.

Being a good admin also means participating in the community! If you have worked hard and participated in the community and are admin on a few servers, don't stop there. Keep participating and help others when you can. Always having a positive attitude can make the difference.

==Things to Remember==
'''One bad decision can stay with you forever.''' Most server owners keep logs of their servers. If they see you repeatedly goofing off, making rash decisions, or supporting rule-breaking behavior, you may be removed as an admin. Make sure that you always do what you think is right. If you're not quite sure, ask the owner.

'''The magic order: warn, kick, short ban, long ban.''' This always comes in handy is usually the way to handle misbehavior. Don't ban them right away if they do something wrong unless it was meaningful and completely rash. Usually giving them a warning will resolve some issues. However, if they continue to misbehave, kick them and let them know it was their final warning. If they continue to do wrong, ban them for a short period of time. If you see them again at a different time performing the same bad behavior, re-do the ban with a longer ban length. If a user is using bad language, mute them and give them a warning.

'''Use common sense.''' Whenever making tough decisions, do what you think is right and go with your gut. If you perform without thinking, you may be making a mistake. If you have to think over banning a person, it may not be the right thing to do. All questions should be directed to the server owner, however, if there is another admin on they may be able to help out.

Bz eWorldFinalized

2010-09-25T02:58:12Z

Mrapple: /* Overview */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eWorldFinalized''' is an API event that is called when the world is done loading.

==Usage==
bz_eWorldFinalized is only a notification.

Events (API)

2010-09-25T01:58:41Z

Mrapple: Added more events that were missing

{{BZFS_API_Doc}}
==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]] 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;

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

The plug-in registers and event callback derived from [[bz_EventHandler]] 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]] entry point, the plug-in must remove the installed callback by calling the function;

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

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] 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' method of the installed callback class.

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

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]]

Events (API)

2010-09-25T01:52:37Z

Mrapple: Remove extra spacing

{{BZFS_API_Doc}}
==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]] 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;

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

The plug-in registers and event callback derived from [[bz_EventHandler]] 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]] entry point, the plug-in must remove the installed callback by calling the function;

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

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] 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' method of the installed callback class.

virtual void process ( 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_eNullEvent]]
[[bz_eCaptureEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerSpawnEvent]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eAllowPlayer]]
[[bz_eTickEvent]]
[[bz_eGetWorldEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eAllowSpawn]]
[[bz_eListServerUpdateEvent]]
[[bz_eBanEvent]]
[[bz_eHostBanNotifyEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eIdBanEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameStartEvent|bz_eGameEndEvent]]
[[bz_eSlashCommandEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotFiredEvent]]
[[bz_eAnointRabbitEvent]]
[[bz_eNewRabbitEvent]]
[[bz_eReloadEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNetDataReceveEvent]]
[[bz_eLogingEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eShotEndedEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_ePlayerCollision]]
[[bz_eFlagResetEvent]]
[[bz_eWorldFinalized]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eReportFiledEvent]]
[[bz_eTeleportEvent]]

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]]

Events (API)

2010-09-25T01:52:08Z

Mrapple: All articles for all API events have been completed

{{BZFS_API_Doc}}

==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]] 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;

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

The plug-in registers and event callback derived from [[bz_EventHandler]] 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]] entry point, the plug-in must remove the installed callback by calling the function;

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

==Event Handler==
The plug-in must define a class that is derived from [[bz_EventHandler]] 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' method of the installed callback class.

virtual void process ( 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_eNullEvent]]
[[bz_eCaptureEvent]]
[[bz_ePlayerDieEvent]]
[[bz_ePlayerSpawnEvent]]
[[bz_eZoneEntryEvent]]
[[bz_eZoneExitEvent]]
[[bz_ePlayerJoinEvent]]
[[bz_ePlayerPartEvent]]
[[bz_eRawChatMessageEvent]]
[[bz_eFilteredChatMessageEvent]]
[[bz_eUnknownSlashCommand]]
[[bz_eGetPlayerSpawnPosEvent]]
[[bz_eGetAutoTeamEvent]]
[[bz_eAllowPlayer]]
[[bz_eTickEvent]]
[[bz_eGetWorldEvent]]
[[bz_eGetPlayerInfoEvent]]
[[bz_eAllowSpawn]]
[[bz_eListServerUpdateEvent]]
[[bz_eBanEvent]]
[[bz_eHostBanNotifyEvent]]
[[bz_eHostBanModifyEvent]]
[[bz_eIdBanEvent]]
[[bz_eKickEvent]]
[[bz_eKillEvent]]
[[bz_ePlayerPausedEvent]]
[[bz_eMessageFilteredEvent]]
[[bz_eGameStartEvent]]
[[bz_eGameStartEvent|bz_eGameEndEvent]]
[[bz_eSlashCommandEvent]]
[[bz_ePlayerAuthEvent]]
[[bz_eServerMsgEvent]]
[[bz_eShotFiredEvent]]
[[bz_eAnointRabbitEvent]]
[[bz_eNewRabbitEvent]]
[[bz_eReloadEvent]]
[[bz_ePlayerUpdateEvent]]
[[bz_eNetDataSendEvent]]
[[bz_eNetDataReceveEvent]]
[[bz_eLogingEvent]]
[[bz_eFlagTransferredEvent]]
[[bz_eFlagGrabbedEvent]]
[[bz_eFlagDroppedEvent]]
[[bz_eShotEndedEvent]]
[[bz_eNewNonPlayerConnection]]
[[bz_eIdleNewNonPlayerConnection]]
[[bz_ePlayerCollision]]
[[bz_eFlagResetEvent]]
[[bz_eWorldFinalized]]
[[bz_eAllowCTFCaptureEvent]]
[[bz_eAllowFlagGrabEvent]]
[[bz_eAllowKillCommandEvent]]
[[bz_eReportFiledEvent]]
[[bz_eTeleportEvent]]

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]]

Bz eAllowKillCommandEvent

2010-09-25T01:51:31Z

Mrapple: /* bz_eAllowKillCommandEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eAllowKillCommandEvent''' is an API event that is called each the /kill command is executed.
==Data==
'''bz_eAllowKillCommandEvent''' returns the '''bz_eAllowKillCommandEvent_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAllowKillCommandEvent
|-
|playerKilling
|int
|The ID of the player who is issuing the /kill command
|-
|playerToKill
|int
|The ID of the player that will be killed
|-
|allow
|bool
|Whether or not to allow the /kill
|}

Bz eAllowFlagGrab

2010-09-25T01:49:24Z

Mrapple: /* bz_eAllowFlagGrabEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eAllowFlagGrabEvent''' is an API event that is called each time a player is about to grab a flag.
==Data==
'''bz_eAllowFlagGrabEvent''' returns the '''bz_eAllowFlagGrabEvent_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAllowFlagGrabEvent
|-
|playerID
|int
|The ID of the player who is grabbing the flag
|-
|pos
|float[3]
|The position of the player about to grab the flag
|-
|flagID
|int
|The ID of the flag that is going to be grabbed
|-
|flagType
|const char*
|The type of the flag about to be grabbed
|-
|allow
|bool
|Whether or not to allow the flag grab
|}

Bz eWorldFinalized

2010-09-25T01:45:34Z

Mrapple: /* Overview */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eWorldFinalized''' is an API event that is not implmented, but, it is defined in BZFlag 2.99.x. This page will be updated when progress is made.

Bz eWorldFinalized

2010-09-25T01:44:53Z

Mrapple: /* bz_eWorldFinalized */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eWorldFinalized''' is an API event that is not yet implmented yet but is defined in BZFlag 2.99.x. This page will be updated when progress is made.

Bz ePlayerCollision

2010-09-25T01:40:37Z

Mrapple: /* bz_ePlayerCollision */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_ePlayerCollision''' is an API event that is called each time two players collide.
==Data==
'''bz_ePlayerCollision''' returns the '''bz_ePlayerCollision_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_ePlayerCollision
|-
|players
|int[2]
|The players that have collided
|-
|pos
|float[3]
|The position of the collision
|-
|handled
|bool
|Whether or not the plug-in has handled the data
|}
==Usage==
It appears this event is in BZFlag 2.99.x but has not been fully implemented and will probably never return data.

Bz eIdleNewNonPlayerConnection

2010-09-25T01:36:18Z

Mrapple: /* bz_eIdleNewNonPlayerConnection */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eIdleNewNonPlayerConnection''' is an API event that is called each time there is an idle connection.
==Data==
'''bz_eIdleNewNonPlayerConnection''' returns the '''bz_eIdleNewNonPlayerConnection_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eNewNonPlayerConnection
|-
|connectionID
|int
|The ID of the connection
|}

Bz eNewNonPlayerConnection

2010-09-25T01:35:27Z

Mrapple: /* Data */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eNewNonPlayerConnection''' is an API event that is called each time there is a connection to the server not from a player.
==Data==
'''bz_eNewNonPlayerConnection''' returns the '''bz_eNewNonPlayerConnection_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eNewNonPlayerConnection
|-
|connectionID
|int
|The ID of the connection
|-
|data
|void*
|The packet data
|-
|size
|unsigned int
|The size of the packet
|}

Bz eNewNonPlayerConnection

2010-09-25T01:32:41Z

Mrapple: /* bz_eNewNonPlayerConnection */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eNewNonPlayerConnection''' is an API event that is called each time there is a connection to the server not from a player.
==Data==
'''bz_eNewNonPlayerConnection''' returns the '''bz_eNewNonPlayerConnection''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eNewNonPlayerConnection
|-
|connectionID
|int
|The ID of the connection
|-
|data
|void*
|The packet data
|-
|size
|unsigned int
|The size of the packet
|}

Bz eReloadEvent

2010-09-25T01:29:25Z

Mrapple: New page: {{BZFS_API_Doc}} {{BZFS_API_Events}} ==Overview== The '''bz_eReloadEvent''' is an API event that is called each time a player reloads. ==Data== '''bz_eReloadEvent''' returns the '''bz_eRe...

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eReloadEvent''' is an API event that is called each time a player reloads.
==Data==
'''bz_eReloadEvent''' returns the '''bz_eReloadEvent_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eReloadEvent
|-
|playerID
|int
|The ID of the player reloading
|}

Bz eNewRabbitEvent

2010-09-25T01:27:11Z

Mrapple: /* Bz_eNewRabbitEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''Bz_eNewRabbitEvent''' is an API event that is called each time a new rabbit is selected.
==Data==
'''Bz_eNewRabbitEvent''' returns the '''Bz_eNewRabbitEvent_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|Bz_eNewRabbitEvent
|-
|newRabbit
|int
|The ID of the new rabbit
|}

Bz eAnointRabbitEvent

2010-09-25T01:25:59Z

Mrapple: /* Bz_eAnointRabbitEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''Bz_eAnointRabbitEvent''' is an API event that is called each time a new rabbit is to be selected.
==Data==
'''Bz_eAnointRabbitEvent''' returns the '''Bz_eAnointRabbitEvent''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|Bz_eAnointRabbitEvent
|-
|newRabbit
|int
|The ID of the new rabbit
|-
|swap
|bool
|?
|}

Bz eAllowCTFCaptureEvent

2010-09-25T01:18:55Z

Mrapple: /* bz_eAllowCTFCaptureEvent */

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eAllowCTFCapEvent''' is an API event that is called each time a flag is about to be captured.
==Data==
'''bz_eAllowCTFCapEvent''' returns the '''bz_eAllowCTFCapEvent''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eAllowCTFCapEvent
|-
|playerCapping
|int
|The ID of the player making the capture
|-
|teamCapped
|[[bz_eTeamType]]
|The team making the capture
|-
|teamCapping
|[[bz_eTeamType]]
|The team whose flag is being captured
|-
|pos
|float[3]
|The position of the player
|-
|rot
|float
|The direction the player is facing
|-
|allow
|bool
|Whether or not to allow the capture
|-
|time
|double
|The server time at which the event occurred (in seconds).
|}