BZFlagWiki - User contributions [en]

Events (API)

2017-01-27T09:18:04Z

Allejo: Add new poll events

{{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_eAllowPollEvent]]
[[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_ePollStartEvent]]
[[bz_ePollVoteEvent]]
[[bz_ePollVetoEvent]]
[[bz_ePollEndEvent]]
[[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]]

Bz eGetPlayerInfoEvent

2017-01-05T04:04:09Z

Allejo: Fix typos

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGetPlayerInfoEvent''' is an API event that is called each time the server sends out a player info update message to a remote player.

==Data==
'''bz_eGetPlayerInfoEvent''' returns the '''bz_GetPlayerInfoEventData_V1''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGetPlayerInfoEvent
|-
|playerID
|int
|The playerID the record refers too.
|-
|callsign
|[[bz_ApiString]]
|The callsign for the player.
|-
|ipAddress
|[[bz_ApiString]]
|The IPv4 address for the player. (not set in 2.4.0, fixed in 2.4.1.)
|-
|team
|[[bz_eTeamType]]
|The team the player is current only.
|-
|admin
|bool
|The admin permission state of the player, indicating if they will be displayed with an '@' symbol in the scoreboard.
|-
|verified
|bool
|The authentication state of the player, indicating if they will be displayed with an '+' symbol in the scoreboard.
|-
|registered
|bool
|The state of the player's username. This value is true if the username is registered. If the user is not verified, but registered then they will be displayed with an '-' symbol in the scoreboard.
|-
|eventTime
|double
|The local server time of the event.
|}

==Uses==
This is a modification event. The state members can be changed ( admin, verified, and registered ). Changes to these values only change the data sent to the remote user, they do not change any internal permission states or access permissions. This event is only to allow plug-ins to overide the logic used for the display of the various scoreboard symbols.

Leagues United

2016-10-29T03:51:57Z

Allejo: Rectify incorrect information

'''Leagues United''' is the successor to both [[Ducati League]] and [[GU League]]

==History==
The Leagues United is currently the most successful and active league is BZFlag. It launched on February 21, 2016. There are currently [http://leaguesunited.org/teams 32 teams], 5 of which are active. There is a massive number of [http://leaguesunited.org/players players] in Leagues United.

Leagues United offers challenging competition and includes some of the top BZFlag players.

Be sure to visit the [https://forums.bzflag.org/viewforum.php?f=114 official Leagues United forum] and read the "sticky" threads at the top of the page. They contain a lot of important information.

=Playing in Leagues United=

For players that are new to BZFlag, it is recommended to check out the [[Getting_Started|Getting Started]] page. A [[Getting_Started#Registering_a_callsign.28Optional.29|globally registered name]] is required for league play.

A player can then visit [http://leaguesunited.org/ to register in the league] using the same name. One of the [http://leaguesunited.org/admins League Council] members needs to contacted to be added to the spawn list.
==Rules and Guidelines==

The league has a high standard of behavior and sportsmanship. So check these rules before doing anything else:

*Match disturbance, player harassment, language, cheat accusations in public (1 day -7 days ban)
*Using cheats on public servers or in other leagues (6-9 months)
*Using cheats in the league (1 year to life)

These are subject to change, so please always check the [http://leaguesunited.org/2 Official Rules page] directly.

===Matching in Leagues United===

A good way to get started in the league is to play fun matches (typically abbreviated as 'fm'). These types of matches are very popular. Only official matches are entered into the website, so there is less pressure during a fun match. Players do not have to be in a team to fm, and players from specific league teams don't have to play on the same color.

Fun matches can also have additional players join during play. Make sure that the current players don't mind before joining a match. Players should '''self-kill''' by shooting while facing a wall or self-destructing with the delete key. This ensures there is not an unfair advantage due to initially spawning on the team base. The phrase "sk please" is used quite often to request that someone self-kills.

Fun matches are not reported.

===Teams, Matching & Reporting===

Once you're registered and want to get some action. Firstly you're going to need a team. You can join a team by visiting the [http://leaguesunited.org/teams teams] page and hitting the "Join" button next to the team, that is, if the team is open to anyone. Most teams however, are closed and can only be joined by invitation sent from the team leader.
Usually you will always find some teams that are interested in new and active players. If you want to contact the leader of a team or the team itself, use the "BZMail" option that can be found at the top or bottom of any Team/Player profile page.
Don't be discouraged if the first couple of requests get turned down, most teams like to get to know the players before they accept them into their team. But it's easy to establish yourself within the Leagues community. You can get to know players best by playing fun matches, spending time on the various public servers and talking to others in Observer during matches. It's a learning by doing system.

Once you've found and joined a team you like you can immediately start matching! There are some rules you should take into account before doing so though.

===Official Matches===

Basic commands needed during official matches:

* '''/official''' or '''/fm''' - Start either an official match or a fun match, respectively
* '''/timelimit''' - Change the duration of the match; durations may only be 15, 20, or 30 minutes. This must be set ''before'' the match starts.
* '''/pause''' - Pause the match timer. Should not be abused and should only be used when necessary. (E.g. a player has to stop for a moment, etc.)
* '''/resume''' - Resume the match timer and allow the match to continue.
* '''/finish or /cancel''' - This will abruptly end the match at any given time. (Do not abuse! Ending a match with out any notice will most certainly lead to a ban.)
* '''/mapchange''' - This changes the map that is currently on a server.(Currently supported maps are Babel, Ducati, DucatiMini, DuPi, HiX, Pillbox.) Typing '/mapchange Babel' Upon rejoining the server, you will find the Babel map loaded.

Guidelines:

* Do not start the match timer before all participating players are ready and make sure everyone has agreed on playing an official match.
* Make sure all players agree with opponents lag before starting the match. It is frowned upon to start a match and realize half way in that the lag is unplayable.
* Everyone participating should either able to finish the match or have a substitute available in case.
* Make sure the server is an official Leagues United match server.
* If a player goes [NR] (which means they are 'Not Responding', thus have lost their connection to the server somehow), pause the match and wait for a substitute or for the player to rejoin
* Make sure everyone is ready for a substitute before it happens to prevent major chaos in the match.
* If two more players want to join from the respective teams, make sure everyone is prepared and has said yes to the addition of players.
* Pick a server closest to the majority of players. If it is a half/half case, just agree on one.

If for some reason a match has to be canceled, use the '''/finish''' command to report the partial official match to the league website or use '''/cancel''' to not report an official match or cancel a fun match.

==Official league servers==

It is very important that you only play official matches on the official league servers.

Here is a list of the servers and their respective locations.

'''Europe:'''
* brad.leaguesunited.org:5196 (London, England)
* brad.leaguesunited.org:5197 (London, England)
* brad.leaguesunited.org:5198 (London, England)

'''America:'''

* allejo.leaguesunited.org:5196 (New Jersey, USA)
* allejo.leaguesunited.org:5197 (New Jersey, USA)
* allejo.leaguesunited.org:5198 (New Jersey, USA)
* BRL.ARPA.NET:5196 (California, USA)
* BRL.ARPA.NET:5197 (California, USA)
* BRL.ARPA.NET:5198 (California, USA)

The replay servers can be found on port 5195

If a match is not played on one of these servers, than it cannot be counted as official.

===Replays===

Every match, official or fun, is automatically recorded and saved to the respective replay server. Some servers have websites where the replay file, time, date and players are posted.

You can find help on how to get a replay start and running on the servers but here's a quick summary:

#Find the replay file you want by either using the above mentioned web-sites or by using
##/replay list -n (if possible, will display a list of recent replays in chronological order)
##/replay list *10042009* (will show you all replays played on April 10th, 2009)

#Once you've found your replay file
##/replay load #index number

Use /replay skip + or - <amount of seconds> to navigate within a replay
Use /replay pause and /replay resume to pause and resume a replay

===Public Servers===

Along with the various official servers, there are quite a few public servers set up using either identical or similar settings to the league. Players usually meet up there to get warm and just shoot around before or after a match. Anyone can play there, regardless of being registered in the league or not. Some of these public servers are running the /mapchange feature, some are CTF and some are just FFA.

Here is a list of LU public servers and the maps currently run on them.

* allejo.public.leaguesunited.org:5190 ('''[[DuPi]]''' by zaphod)
* allejo.public.leaguesunited.org:5191 ('''[[Octocage]]''' by Bachiii and Saturos)
* allejo.public.leaguesunited.org:5192 ('''[[AHOD|All Hands On Deck]]''' by Trepan)
* allejo.public.leaguesunited.org:5193 ('''[[Brigade]]''' by ahs3)
* allejo.public.leaguesunited.org:5194 (LU Last Tank Standing)

==Settings and Options==

A big part of Leagues United, is being able to compete. But the premise for that, is having good settings that will make things like dodging, shooting and jumping a lot easier. A very large amount of the league players use mouse and only a dozen keyboard. If you are just starting out, a recommendation for new players is to try playing with mouse first, as many things will be easier to do later on.
In this game, it's impossible to become the best dodger, jumper and shooter at the same time. These are two if not three completely different types of playing that require many different settings.

Most of the setting adjustment is done by the [[Config_File]], as you can not exercise all your possibilities in the GUI options. You can find a lot of detailed information by using the [http://my.bzflag.org/bb/search.php Search option on BZBB]. Many players have posted their personal configs and other tips there.

For mouse players, these individual playing styles, also mean individual mouse settings. Mousebox size, mouse DPI, mouse sensitivity are all crucial. Usually slower mouse settings and a big mouseboxsize, will enable you to be a better jumper and or shooter, while fast, sensitive, precise mouse settings and a small to even negative mouseboxsize will be enable you to dodge better.
Next to all the native options, some players use mouse enhancement applications, see [http://my.bzflag.org/bb/viewtopic.php?f=103&t=13245 Whitelist] for further info.

Very experienced players however, are known to be able to jump, shoot and dodge with extreme precision. So, no setting in the world is going to help, if you don't practice and play enough.
==Stats==

You might have asked yourself how you're supposed to find other players online if you want to arrange a match.
There are some very useful BZStats and Player checkers that are have been useful to the whole community for years.

#The general BZStats checker that Strayer coded shows a massive amount of information on everything BZFlag related.
##http://bzstats.strayer.de
##http://bzstats.strayer.de/leagues/lu/online/?lang=en (that shows all current LU players that are online)

=Abbreviations you should know=

As mentioned already above, there are some abbreviations used very often in the league. If you haven't already, check out [[Jargon]] for more non-league specific abbreviations and Jargon. Below are some league specific abbreviations. Note that this is not a complete list, just the most common terms you should know in order to prevent confusion between players or in a match.

<properties>
offi=Referring to an official match. ("offi?" means somebody wants to play an official match)
fm=Referring to fun match. ("fm?" means somebody wants to play a fun match)
sk=Selfkill. (Expression often used when new players join an already running fun match. New players should kill themselves once immediately after spawning.)
tk=Teamkill. (More frequently used outside of league play too)
def=Defense. Your flag is under immediate attack or about to be taken. Watch out for yours!
att=Attack. Focus on getting your opponents flag.
gs, ns, n1, g1=Good shot, nice shot, nice one, good one. Frequently used when a player does something that the other regards as nice or skillfull.
ty, thx=Thank you. Thanks.
hf, gl=Have fun, good luck.Usually always said to the opposing team before a match starts
gg=Good game. Usually said by all participating players after a match has ended.
</properties>

[[Category:Leagues]]

2.4 Releases

2016-10-24T05:48:19Z

Allejo: Correct the order of 2.0.x releases

Pages related to various releases of BZFlag.

== Articles in category "Releases" ==
These are the many releases of BZFlag, starting with the current release.

* [[BZFlag 2.4.8]]
* [[BZFlag 2.4.6]]
* [[BZFlag 2.4.4]]
* [[BZFlag 2.4.2]]
* [[BZFlag 2.4.0]]
* [[BZFlag 2.0.16]]
* [[BZFlag 2.0.14]]
* [[BZFlag 2.0.12]]
* [[BZFlag 2.0.10]]
* [[BZFlag 2.0.8]]
* [[BZFlag 2.0.6]]
* [[BZFlag 2.0.4]]
* [[BZFlag 2.0.2]]
* [[BZFlag 2.0.0]]
* [[BZFlag 1.10.8]]
* [[BZFlag 1.10.6]]
* [[BZFlag 1.10.4]]
* [[BZFlag 1.10.2]]
* [[BZFlag 1.10.0]]
* [[BZFlag 1.7g2]]
* [[BZFlag 1.7g0]]
* [[BZFlag 1.7e6]]
* [[BZFlag 1.7e4]]
* [[BZFlag 1.7e2]]
* [[BZFlag 1.7e1]]
* [[BZFlag 1.7e]]
* [[BZFlag 1.7d-9]]
* [[BZFlag 1.7d-8]]
* [[BZFlag 1.7d-7]]
* [[BZFlag 1.7d-6]]
* [[BZFlag 1.7d-5]]
* [[BZFlag 1.7d-4]]
* [[BZFlag 1.7d-3]]
* [[BZFlag 1.7d-2]]
* [[BZFlag 1.7d-1]]
* [[BZFlag 1.7c-2-3]]
* [[BZFlag 1.7c-2-2]]
* [[BZFlag 1.7c-2-1]]
* [[BZFlag 1.7c-2]]
* [[BZFlag 1.7c-1]]

[[Category:History]]

Bz reloadBadwords

2016-10-20T01:18:04Z

Allejo: Created page with "{{apicall | name = bz_reloadBadwords | description = Reloads the bad words for the server. | returntype = void | version = 2.4.9 or later }}"

{{apicall
| name = bz_reloadBadwords
| description = Reloads the bad words for the server.
| returntype = void
| version = 2.4.9 or later
}}

Functions (API)

2016-10-20T01:17:02Z

Allejo: Add bz_reloadBadwords() to the list

{{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 void [[bz_reloadBadwords]] ();
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 float [[bz_getCountdownRemaining]] ( 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]]
* [[Events (API)|BZFS API Events]]
* [[Plug-ins]]

[[Category:BZFS_API_Functions]]

BZFlag 1.10.2

2016-10-09T23:52:52Z

Allejo: Correct the version

BZFlag version 1.10.2 is a version of the BZFlag game that was released on 2003-12-23.

==Features==
* improved transparent proxy support for server - Frank Thilo, Alfredo Tupone
* Stop infinite spawn loop with complex worlds containing big pyramids
* Misc Swear processing fixes - Sean Morrison
* Allow banfile to be empty or not exist
* Don't let zoned tanks flatten Burrowed tanks
* Don't spawn in multiple locations based on multiple r-clicks
* Don't get speed kicked ejecting from buildings due to expansion
* Fix game style menu position
* Take flipz collisions in account for pyramids
* Fix Respawning after non-shot kills (Geno, Self Destruct, etc)
* More caching of BZBD vars - Frank Thilo
* ServerList uses strict http/1.1 - Frank Thilo
* Fix playercounts in rabbit mode
* GM now tracks player in slot 0
* Relax kick tolerances and soften kick messages - Sean Morrison
* Better lag stats - Frank Thilo
* Server-side Autoteam - Sean Morrison, Tupone Alfredo, Frank Thilo
* Remove bad lite effects with Thief steal
* Protect against crashes due to bad shot ids
* Better key binding - Tupone Alfredo, Dave Brosius
* Relax flag drop time for speed checking - Sean Morrison
* Better unresponsive player removal messages
* added kill messages as an option to bzadmin - Lars Luthman
* let genocided players spawn again - Lars Luthman
* auto team is now handled solely in the server - Frank Thilo
* increase averaging for jitter and loss values in lagstats - Frank Thilo
* mrtg script updated - Tim Riker

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

Plug-ins

2016-09-29T17:05:54Z

Allejo: Add note about linking to plugin_utils

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 July 2016, [[BZFlag Git|Git]] tree contains the following plug-ins:

*[[airspawn]]
*[[autoFlagReset]]
*[[bzfscron]]
*[[chathistory]]
*[[customflagsample]]
*[[CustomZoneSample]]
*[[fairCTF]]
*[[fastmap]]
*[[flagStay]]
*[[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]]
*[[wwzones]]

==Third Party Plug-ins==
A number of non-developers have created plug-ins for BZFS, and usually release them on the [https://forums.bzflag.org/ 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.
# If your plug-in uses "plugin_utils.h", then ensure that under Build Phases the '''libplugin_utils.a''' library is listed under "Link Binary With Libraries"; add the library if it is not already listed.
# 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; ensure you select the "Copy items if needed" checkbox and to choose "Create groups."
# 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]]

Plug-ins

2015-11-11T03:36:01Z

Allejo: Quick notes about adding plugin source to the Xcode build

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; ensure you select the "Copy items if needed" checkbox and to choose "Create groups."
# 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]]

Bz getCountdownRemaining

2015-09-25T21:10:51Z

Allejo: Update return type and function name

{{apicall
| name = bz_getCountdownRemaining
| returns = The amount of time remaining in a match in seconds, or <code>-1</code> if a match is not currently in progress.
| returntype = float
| 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 %.0f seconds!", bz_getCountdownRemaining());
} else {
bz_sendTextMessage(BZ_SERVER, player,
"Welcome! No match is currently running.");
}
}break;

Bz getCountdownProgress

2015-09-25T21:09:27Z

Allejo: Allejo moved page Bz getCountdownProgress to Bz getCountdownRemaining: Renamed function

#REDIRECT [[Bz getCountdownRemaining]]

Bz getCountdownRemaining

2015-09-25T21:09:27Z

Allejo: Allejo moved page Bz getCountdownProgress to Bz getCountdownRemaining: Renamed function

{{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-25T21:08:30Z

Allejo: Rename bz_getCountdownProgress() to bz_getCountdownRemaining()

{{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 float [[bz_getCountdownRemaining]] ( 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]]

Server Permissions

2015-09-15T03:03:40Z

Allejo: Remove vandalism

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

Bz pauseCountdown

2015-08-22T08:44:46Z

Allejo: Fix spacing and make use of "removed" parameter

{{apicall
| name = bz_pauseCountdown
| version = 2.4.3
| returns =
| returntype = void
| description = Pauses the countdown that is currently running.
| param1 = playerID
| param1type = int
| param1desc = The id 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.
}}
{{apicall
| name = bz_pauseCountdown
| deprecated = 2.4.3
| removed = 2.5.0
| returns =
| returntype = void
| description = Pauses the countdown that is currently running.
| param1 = pausedBy
| 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.
}}
===Example===
Pause the countdown if a player pauses, saying the player that paused decided to pause the countdown also.
case bz_ePlayerPausedEvent:
{
if (bz_isCountDownActive() && ((bz_PlayerPausedEventData_V1*)eventData)->pause) {
bz_pauseCountdown(bz_getPlayerCallsign(((bz_PlayerPausedEventData_V1*)eventData)->playerID));
}
}
break;

Template:Apicall

2015-08-22T08:43:57Z

Allejo: Add parameter for when a function will be/has been removed

<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:{{{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>

Template:Apicall

2015-08-22T08:40:21Z

Allejo: Restored category and removed function list link

<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:{{{deprecated|}}}|<b>Deprecated as of API Version:</b> {{{deprecated|}}} <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><br/>
<noinclude>{{Documentation}}</noinclude>
<includeonly>
[[Category:BZFS API Functions]]
</includeonly>

Bz pauseCountdown

2015-08-22T08:37:56Z

Allejo: Added deprecation version

{{apicall
| name = bz_pauseCountdown
| version = 2.4.3
| returns =
| returntype = void
| description = Pauses the countdown that is currently running.
| param1 = playerID
| param1type = int
| param1desc = The id 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.
}}

{{apicall
| name = bz_pauseCountdown
| deprecated = 2.4.3
| returns =
| returntype = void
| description = Pauses the countdown that is currently running.
| param1 = pausedBy
| 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.
}}

===Example===
Pause the countdown if a player pauses, saying the player that paused decided to pause the countdown also.
case bz_ePlayerPausedEvent:
{
if (bz_isCountDownActive() && ((bz_PlayerPausedEventData_V1*)eventData)->pause) {
bz_pauseCountdown(bz_getPlayerCallsign(((bz_PlayerPausedEventData_V1*)eventData)->playerID));
}
}
break;

Template:Apicall

2015-08-22T08:37:09Z

Allejo: Removed function list and added deprecation variable

<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:{{{deprecated|}}}|<b>Deprecated as of API Version:</b> {{{deprecated|}}} <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><br/>{{#ifeq:{{{nopagelink|_NOT_HERE_}}}|_NOT_HERE_|[[Functions(API)|Function List]]}}<br/>
<noinclude>{{Documentation}}</noinclude>

Bz pauseCountdown

2015-08-22T08:34:24Z

Allejo: Added new function with int param

{{apicall
| name = bz_pauseCountdown
| version = 2.4.3
| returns =
| returntype = void
| description = Pauses the countdown that is currently running.
| param1 = playerID
| param1type = int
| param1desc = The id 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.
}}

{{apicall
| name = bz_pauseCountdown
| returns =
| returntype = void
| description = Pauses the countdown that is currently running.
| param1 = pausedBy
| 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.
}}

===Example===
Pause the countdown if a player pauses, saying the player that paused decided to pause the countdown also.
case bz_ePlayerPausedEvent:
{
if (bz_isCountDownActive() && ((bz_PlayerPausedEventData_V1*)eventData)->pause) {
bz_pauseCountdown(bz_getPlayerCallsign(((bz_PlayerPausedEventData_V1*)eventData)->playerID));
}
}
break;

Bz eGameEndEvent

2015-08-22T08:29:19Z

Allejo: Previous was adding V2 information; This is fixing a typo

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGameEndEvent''' is an API event that is called each time a game ends. This '''only''' triggers when the game countdown ends (A Game Over), or when /superkill is initiated. This is not to be confused with BZFS being shutdown, /shutdown being initiated, or a game ending due to the '''-g''' option enabled on servers.

==Data==
Both '''bz_eGameStartEvent''' and '''bz_eGameEndEvent''' return the '''bz_GameStartEndEventData_V2''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGameStartEvent or bz_eGameEndEvent
|-
|playerID
|int
|The id of the player who ended the countdown. This will be set to 253 if no player information was given.
|-
|duration
|double
|The duration (in seconds) of the game.
|-
|gameOver
|bool
|This is set to true if the countdown was ended by a gameover or superkill action.
|-
|eventTime
|double
|The server time the event occurred (in seconds.)
|}

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

Bz eGameStartEvent

2015-08-22T08:28:47Z

Allejo: Added information about V2

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
'''bz_eGameStartEvent''' and '''bz_eGameEndEvent''' are API events triggered when a game (i.e., a time- or score-limited match) begins or ends, respectively.

==Data==
Both '''bz_eGameStartEvent''' and '''bz_eGameEndEvent''' return the '''bz_GameStartEndEventData_V2''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGameStartEvent or bz_eGameStartEvent
|-
|playerID
|int
|The id of the player who started the countdown. This will be set to 253 if no player information was given.
|-
|duration
|double
|The duration (in seconds) of the game.
|-
|gameOver
|bool
|This will always be set to false in [[bz_eGameStartEvent]]
|-
|eventTime
|double
|The server time the event occurred (in seconds.)
|}

==Uses==

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

Bz eGameResumeEvent

2015-08-22T08:26:13Z

Allejo: Added information about V2

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
'''bz_eGamePauseEvent''' and '''bz_eGameResumeEvent''' are API events triggered when a game (i.e., a time- or score-limited match) pauses or resumes, respectively.

==Data==
Both '''bz_eGamePauseEvent''' and '''bz_eGameResumeEvent''' return the '''bz_GamePauseResumeEventData_V2''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
| bz_eGamePauseEvent or bz_eGameResumeEvent
|-
|playerID
|int
|The id of the player who resumed countdown. This will be set to 253 if no player information was given.
|-
|actionBy
|[[bz_ApiString]]
|The callsign of the player who triggered the event. By default, it's "SERVER."
|-
|eventTime
|double
|The server time the event occurred (in seconds.)
|}

==Uses==

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

Bz eGamePauseEvent

2015-08-22T08:25:33Z

Allejo: Added information about V2

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
'''bz_eGamePauseEvent''' and '''bz_eGameResumeEvent''' are API events triggered when a game (i.e., a time- or score-limited match) pauses or resumes, respectively.

==Data==
Both '''bz_eGamePauseEvent''' and '''bz_eGameResumeEvent''' return the '''bz_GamePauseResumeEventData_V2''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
| bz_eGamePauseEvent or bz_eGameResumeEvent
|-
|playerID
|int
|The id of the player who paused countdown. This will be set to 253 if no player information was given.
|-
|actionBy
|[[bz_ApiString]]
|The callsign of the player who triggered the event. By default, it's "SERVER."
|-
|eventTime
|double
|The server time the event occurred (in seconds.)
|}

==Uses==

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

Bz eGameEndEvent

2015-08-22T08:23:48Z

Allejo:

{{BZFS_API_Doc}}
{{BZFS_API_Events}}

==Overview==
The '''bz_eGameEndEvent''' is an API event that is called each time a game ends. This '''only''' triggers when the game countdown ends (A Game Over), or when /superkill is initiated. This is not to be confused with BZFS being shutdown, /shutdown being initiated, or a game ending due to the '''-g''' option enabled on servers.

==Data==
Both '''bz_eGameStartEvent''' and '''bz_eGameEndEvent''' return the '''bz_GameStartEndEventData_V2''' data class.

{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|eventType
|[[Event(API)|bz_eEventType]]
|bz_eGameStartEvent or bz_eGameEndEvent
|-
|playerID
|int
|The id of the player who started or ended the countdown. This will be set to 253 if no player information was given.
|-
|duration
|double
|The duration (in seconds) of the game.
|-
|gameOver
|bool
|This is set to true if the countdown was ended by a gameover or superkill action.
|-
|eventTime
|double
|The server time the event occurred (in seconds.)
|}

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

Functions (API)

2015-08-22T08:16:35Z

Allejo: Added updated countdown functions with player IDs

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

Bz getPlayerSpawnAtBase

2015-08-02T05:02:22Z

Allejo: Created page with "{{apicall | name = bz_getPlayerSpawnAtBase | description = Check if a player is supposed to spawn at their base on their next respawn | version = 2.4.3 | param1..."

{{apicall
| name = bz_getPlayerSpawnAtBase
| description = Check if a player is supposed to spawn at their base on their next respawn
| version = 2.4.3
| param1 = playerID
| param1type = int
| param1desc = The id of the target
| returntype = bool
| returns = True if the target player will be spawning at their base next respawn
}}

Bz setPlayerSpawnAtBase

2015-08-02T05:01:10Z

Allejo: Created page with "{{apicall | name = bz_setPlayerSpawnAtBase | description = Forces a player to spawn at their base on '''only''' their next respawn. | version = 2.4.3 | param1..."

{{apicall
| name = bz_setPlayerSpawnAtBase
| description = Forces a player to spawn at their base on '''only''' their next respawn.
| version = 2.4.3
| param1 = playerID
| param1type = int
| param1desc = The id of the target
| param2 = base
| param2type = bool
| param2desc = Use true if they are to spawn at their base on their next respawn
| returntype = void
| returns =
}}

Functions (API)

2015-08-02T03:01:14Z

Allejo: Moved spawnable functions to the player state section

{{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_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]] ( 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]]

Functions (API)

2015-08-02T02:58:39Z

Allejo: Added new spawnAtBase 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_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
BZF_API bool [[bz_getPlayerSpawnAtBase]] ( int playerId );
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_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API bool [[bz_isPlayerSpawnable]] ( 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]] ( 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]]

Functions (API)

2015-08-02T01:02:34Z

Allejo: Removed nonexistent bz_canPlayerSpawn()

{{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_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_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_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API bool [[bz_isPlayerSpawnable]] ( 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]] ( 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]]

Functions (API)

2015-08-02T00:57:28Z

Allejo: Moved incorrect function

{{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_getPlayerCurrentState]] ( int playerID, bz_PlayerUpdateState &state );
?
BZF_API bool [[Bz_isPlayerSpawnable |bz_canPlayerSpawn]]( int playerID );
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_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API bool [[bz_isPlayerSpawnable]] ( 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]] ( 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 isPlayerSpawnable

2015-07-29T05:16:57Z

Allejo: Created page

{{apicall
| name = bz_isPlayerSpawnable
| description = Checks if player has the ability to spawn. This is not to be confused with the SPAWN permission but instead, this should be used together with [[bz_setPlayerSpawnable]].
| version = 2.4.3
| param1 = playerID
| param1type = int
| param1desc = The id of the player to check if they can spawn
| returntype = bool
| returns = True if target player is allowed to spawn
}}

Bz setPlayerSpawnable

2015-07-29T05:11:09Z

Allejo: Add return type

{{apicall
| name = bz_setPlayerSpawnable
| description = Marks this player as allowed to spawn or not allowed to spawn.
| version = 2.4.3
| 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
| returntype = bool
| returns = True if target player was valid and setting the spawnablity was successful
}}

Bz setPlayerSpawnable

2015-07-29T05:08:20Z

Allejo: Added minimum API verision

{{apicall
| name = bz_setPlayerSpawnable
| description = Marks this player as allowed to spawn or not allowed to spawn.
| version = 2.4.3
| 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
| returns = True if target player was valid and setting the spawnablity was successful
}}

Functions (API)

2015-07-29T05:06:03Z

Allejo: Added bz_isPlayerSpawnable and bz_setPlayerSpawnable as officially part of 2.3+

{{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_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_setPlayerSpawnable]] ( int playerID, bool spawn );
BZF_API bool [[bz_isPlayerSpawnable]] ( 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]] ( 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 getPlayerBySlotOrCallsign

2015-06-30T04:19:27Z

Allejo: Grammatical errors

{{apicall
| name = bz_getPlayerBySlotOrCallsign
| description = Gets the information for the player with the specified slot index or callsign. The returned player info won't update as the game progresses. If you need new updates on the player's info, you can call [[bz_updatePlayerData]].

After you're done with the player info returned from this method, you must release it by calling [[bz_freePlayerRecord]].
| version = 2.4.3
| param1 = name
| param1type = const char*
| param1desc = The callsign of a player or the slot number (e.g. #2) of the player '''with''' the pound sign (#)
| returntype = bz_BasePlayerRecord*
| returns = an instance of [[bz_BasePlayerRecord]] for the target player
}}

Bz setTeamLosses

2015-06-14T21:17:19Z

Allejo: Added minimum API verision

{{apicall
| name = bz_setTeamLosses
| version = 2.4.0
| description = Sets the losses of a team
| param1 = team
| param1type = bz_eTeamType
| param1desc = The team to set the losses for.
| param2 = losses
| param2type = int
| param2desc = Amount of losses for the team.
| returntype = void
}}

Bz incrementTeamLosses

2015-06-14T21:16:38Z

Allejo:

{{apicall
| name = bz_incrementTeamLosses
| description = Increment the losses of a team
| version = 2.4.3
| param1 = team
| param1type = bz_eTeamType
| param1desc = The team to set the wins for
| param2 = wins
| param2type = int
| param2desc = The amount to increment by
| returntype = void
}}

Bz incrementTeamLosses

2015-06-14T21:16:33Z

Allejo: Created page with "{{apicall | name = bz_ incrementTeamLosses | description = Increment the losses of a team | version = 2.4.3 | param1 = team | param1type = bz_eTeamType |..."

{{apicall
| name = bz_ incrementTeamLosses
| description = Increment the losses of a team
| version = 2.4.3
| param1 = team
| param1type = bz_eTeamType
| param1desc = The team to set the wins for
| param2 = wins
| param2type = int
| param2desc = The amount to increment by
| returntype = void
}}

Bz incrementTeamWins

2015-06-14T21:16:08Z

Allejo: Created page with "{{apicall | name = bz_incrementTeamWins | description = Increment the wins of a team | version = 2.4.3 | param1 = team | param1type = bz_eTeamType | param..."

{{apicall
| name = bz_incrementTeamWins
| description = Increment the wins of a team
| version = 2.4.3
| param1 = team
| param1type = bz_eTeamType
| param1desc = The team to set the wins for
| param2 = wins
| param2type = int
| param2desc = The amount to increment by
| returntype = void
}}

Bz setTeamWins

2015-06-14T21:15:06Z

Allejo: Added minimum API verision

{{apicall
| name = bz_setTeamWins
| description = Sets the wins of a team
| version = 2.4.0
| param1 = team
| param1type = bz_eTeamType
| param1desc = The team to set the wins for.
| param2 = wins
| param2type = int
| param2desc = Amount of wins for the team.
| returntype = void
}}

Functions (API)

2015-06-14T21:13:08Z

Allejo: Add bz_incrementTeamWins and bz_incrementTeamLosses

{{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_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_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_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]] ( 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 incrementPlayerTKs

2015-06-14T21:12:05Z

Allejo: Added minimum API verision

{{apicall
| name = bz_incrementPlayerTKs
| description = Increments the team-kill count of a player.
| version = 2.4.3
| 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-06-14T21:11:48Z

Allejo: Added minimum API verision

{{apicall
| name = bz_incrementPlayerLosses
| description = Increments the losses of a player.
| version = 2.4.3
| 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-06-14T21:11:26Z

Allejo: Add minimum API version

{{apicall
| name = bz_incrementPlayerWins
| description = Increments the wins of a player.
| version = 2.4.3
| 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 getPlayerBySlotOrCallsign

2015-06-14T21:10:25Z

Allejo: Create page

{{apicall
| name = bz_getPlayerBySlotOrCallsign
| description = Gets the information for the player with the specified slot index or callsign. The returned player info won't update as the game progresses. If you need new updates on the player's info, you can call [[bz_updatePlayerData]].

After you're done with the player info returned from this method, you must release it by calling [[bz_freePlayerRecord]].
| version = 2.4.3
| param1 = name
| param1type = const char*
| param1desc = The callsign of a player of the slot number (e.g. #2) of the player '''with''' the pound sign (#)
| returntype = bz_BasePlayerRecord*
| returns = an instance of [[bz_BasePlayerRecord]] that contains the player in question's information
}}

Functions (API)

2015-06-14T20:56:52Z

Allejo: Added bz_getPlayerBySlotOrCallsign()

{{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_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_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 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]] ( 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]]

Koth

2015-05-22T23:08:09Z

Allejo: Update wording in example description

The plugin will create a King of the Hill game mode in which a team (or player) can occupy a defined volume ("Hill") for a defined amount of time and kill all other teams (or players) if occupied long enough.

=Description=
* Server messaging for Hill unoccupied (can be taken), Hill occupied (by whom and how long they have to hold it), regular countdown warnings while someone is holding Hill (every minute and 30, 20 & 10 seconds until Hill is "captured"), and successful King of the Hill announcements. Long callsigns are truncated in server messages.

* In teamplay mode, if any team player manages to lay claim to the Hill and kill all other team players, his/her entire team must exit the Hill volume and at least one would need to re-enter to try and hold the Hill again. If the player that captures the hill is a rogue in teamplay mode, only that player will need to exit and re-enter to try and take the Hill again.

* In no teamplay mode, if a player manages to lay claim to the Hill and kill all other players, only he/she must exit the Hill volume and re-enter to try and hold the Hill again.

* Players cannot pause on the Hill (everywhere else is ok) - if they try they will be killed with a warning message not to do so.

* King of the Hill will be disabled until there are 2 or more teams present.

* Explicit spawn zones are recommended in map files to prevent player spawns on the Hill.

* There is an autotime function (optional) that will reduce the time to hold the hill, based on the number of players in the game. With this option enabled, the time is reduced a certain percentage (default is 3%) with every additional player (after 2) to a certain minimum percentage (defaut is 50%) of the original specified time to hold. This means that (with default settings) the time to hold would not be affected for 2 players, but would be reduced by 3% for 3 players, 6% for 4 players and so on. The minimum 50% of the original time to hold would be reached at about 19 players and would remain at 50%, no matter how many additional players were to join after that.

* There is a "/kingsay <message>" command available to all players to send a message to person holding the hill.

* When Hill is initially occupied and when hill is taken, standard team audio alerts take place.

=Usage=

There are 2 modes of play available:

# '''Teamplay''': if a player from a team occupies the Hill long enough, all other teams (except his/hers) are killed. Score credits are given to the team, but not given to player that was King of the Hill. If a rogue manages to become King of the Hill in this mode, all players (except him/her) are killed and he/she gets individual score credit for all of the kills.
# '''No teamplay''': for this mode it is recommended to set up a map with only rogue players allowed. If a player occupies the Hill long enough, all other players are killed and score credit is given to the player who became King of the Hill for all of the kills. Obviously, if teams are allowed in this mode, it would result in repeated team kills - no fun. Basically this is a free-for-all mode for King of the Hill.

The parameters of the King of the Hill (koth) map definition are follows:

* '''position <x> <y> <z>'''
Required. This determines the location of the "hill"

* '''size <x> <y> <z>'''
Required for rectangular hills. This determines the size of the rectangular zone

* '''rotation <degrees>'''
Optional. Only for rectangular zones, you can set the rotation as any other object.

* '''radius <radius>'''
Required for cylindrical hills. The radius of the cylindrical hill

* '''height <units>'''
Required for cylindrical hills. The height of the hill; the z-axis.

* '''teamplay'''

Optional. This will enable the teamplay mode of King of the Hill (see above). If not included, teamplay is disabled and it becomes as basic free for all King of the Hill mode.

* '''holdtime <seconds>'''

Optional. This defines the time (in seconds) required to occupy the King of the Hill volume before a player is declared King of the Hill and other teams/players are zapped. If not included, the default setting is 60 seconds (1 minute). The limits of this setting are
controlled to a minimum of 1 second and a maximum of 7200 seconds.

* '''autotime <multiplier> <minimum multiplier>'''

Optional. This will enable the automatic time reduction feature of the plugin that will reduce the time to hold the hill, based on the number of players in the game (see description above). The multiplier field will set the hold time reduction percentage per new player. The
minimum multiplier field will set the minimum hold time reduction percentage. If these fields are left blank, the default multiplier = 3% and the default minimum multiplier = 50%. The multiplier fields should be between 1 and 99 (percent).

* '''nosound'''

Optional. This will disable sounds associated with Keep Away plugin (some clients seem to have issues with this feature).

=Examples=

Examples of map (.bzw) entries:

koth
position 0 0 25
size 60 60 30
teamplay
holdtime 60
end

This would set up a King of the Hill volume 60 x 60 x 30, at position 0 0 25. Teamplay would be enabled and the required time to occupy the "Hill" would be 60 seconds (1 minute). Time to hold would not automatically adjust downward with new players.

koth
position 0 0 20
height 20
radius 15
holdtime 100
teamplay
autotime 5 25
nosound
end

This would set up a King of the Hill cylindrical volume 30 x 30 x 20, at position 0 0 20. Teamplay would be enabled and the required time to occupy the "Hill" would be 100 seconds. The time to occupy the hill would adjust downward with an increasing number of players (see autotime description above). Each new player after 2 will reduce the hold time by 5% to a minimum of 25% of the hold time (25 seconds). The sounds associated with the plugin would be disabled.

The plugin must be loaded at startup or else the server it will not recognize these map parameters.

=Server Commands=

There is one command available to all players with the plugin:

/kingsay <message> - this will send message to the player occupying the hill.

There are several administrator commands available with the plugin:

/kothon - this will turn King of the Hill mode on, if turned off previously.
/kothoff - this will turn King of the Hill mode off for normal gameplay.
/kothtimemult - this will set auto time multiplier (per new player).
/kothtimemultmin - this will set minimum auto time multiplier.
/kothautotimeon - this will enable the autotime function.
/kothsoundon - this will enable the plugin's sounds.
/kothsoundoff - this will disable the plugin's sounds.
/kothautotimeoff - this will disable the autotime funtion.
/kothtime <seconds> - this will change King of the Hill hold time 1 -> 7200 seconds.
/kothstatus - this will return the status of the plugin modes, times, etc.

=Deprecation=

* '''bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>'''
* '''cylinder <X> <Y> <Zmin> <Zmax> <radius>'''

Support for the '''bbox''' and '''cylinder''' parameters in a Koth zone has been deprecated and will be removed in the future.

=External Links=
* http://d41games.freehostia.com/bzflag.php?map=bbox An easy way to make bboxes.
* http://my.bzflag.org/bb/viewtopic.php?f=79&t=10005&p=99894#p99894 KotH plugin page.

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

Koth

2015-05-22T23:05:23Z

Allejo: Updated example with correct value

The plugin will create a King of the Hill game mode in which a team (or player) can occupy a defined volume ("Hill") for a defined amount of time and kill all other teams (or players) if occupied long enough.

=Description=
* Server messaging for Hill unoccupied (can be taken), Hill occupied (by whom and how long they have to hold it), regular countdown warnings while someone is holding Hill (every minute and 30, 20 & 10 seconds until Hill is "captured"), and successful King of the Hill announcements. Long callsigns are truncated in server messages.

* In teamplay mode, if any team player manages to lay claim to the Hill and kill all other team players, his/her entire team must exit the Hill volume and at least one would need to re-enter to try and hold the Hill again. If the player that captures the hill is a rogue in teamplay mode, only that player will need to exit and re-enter to try and take the Hill again.

* In no teamplay mode, if a player manages to lay claim to the Hill and kill all other players, only he/she must exit the Hill volume and re-enter to try and hold the Hill again.

* Players cannot pause on the Hill (everywhere else is ok) - if they try they will be killed with a warning message not to do so.

* King of the Hill will be disabled until there are 2 or more teams present.

* Explicit spawn zones are recommended in map files to prevent player spawns on the Hill.

* There is an autotime function (optional) that will reduce the time to hold the hill, based on the number of players in the game. With this option enabled, the time is reduced a certain percentage (default is 3%) with every additional player (after 2) to a certain minimum percentage (defaut is 50%) of the original specified time to hold. This means that (with default settings) the time to hold would not be affected for 2 players, but would be reduced by 3% for 3 players, 6% for 4 players and so on. The minimum 50% of the original time to hold would be reached at about 19 players and would remain at 50%, no matter how many additional players were to join after that.

* There is a "/kingsay <message>" command available to all players to send a message to person holding the hill.

* When Hill is initially occupied and when hill is taken, standard team audio alerts take place.

=Usage=

There are 2 modes of play available:

# '''Teamplay''': if a player from a team occupies the Hill long enough, all other teams (except his/hers) are killed. Score credits are given to the team, but not given to player that was King of the Hill. If a rogue manages to become King of the Hill in this mode, all players (except him/her) are killed and he/she gets individual score credit for all of the kills.
# '''No teamplay''': for this mode it is recommended to set up a map with only rogue players allowed. If a player occupies the Hill long enough, all other players are killed and score credit is given to the player who became King of the Hill for all of the kills. Obviously, if teams are allowed in this mode, it would result in repeated team kills - no fun. Basically this is a free-for-all mode for King of the Hill.

The parameters of the King of the Hill (koth) map definition are follows:

* '''position <x> <y> <z>'''
Required. This determines the location of the "hill"

* '''size <x> <y> <z>'''
Required for rectangular hills. This determines the size of the rectangular zone

* '''rotation <degrees>'''
Optional. Only for rectangular zones, you can set the rotation as any other object.

* '''radius <radius>'''
Required for cylindrical hills. The radius of the cylindrical hill

* '''height <units>'''
Required for cylindrical hills. The height of the hill; the z-axis.

* '''teamplay'''

Optional. This will enable the teamplay mode of King of the Hill (see above). If not included, teamplay is disabled and it becomes as basic free for all King of the Hill mode.

* '''holdtime <seconds>'''

Optional. This defines the time (in seconds) required to occupy the King of the Hill volume before a player is declared King of the Hill and other teams/players are zapped. If not included, the default setting is 60 seconds (1 minute). The limits of this setting are
controlled to a minimum of 1 second and a maximum of 7200 seconds.

* '''autotime <multiplier> <minimum multiplier>'''

Optional. This will enable the automatic time reduction feature of the plugin that will reduce the time to hold the hill, based on the number of players in the game (see description above). The multiplier field will set the hold time reduction percentage per new player. The
minimum multiplier field will set the minimum hold time reduction percentage. If these fields are left blank, the default multiplier = 3% and the default minimum multiplier = 50%. The multiplier fields should be between 1 and 99 (percent).

* '''nosound'''

Optional. This will disable sounds associated with Keep Away plugin (some clients seem to have issues with this feature).

=Examples=

Examples of map (.bzw) entries:

koth
position 0 0 25
size 60 60 30
teamplay
holdtime 60
end

This would set up a King of the Hill volume 60 x 60 x 30, centered at 0 0 25. Teamplay would be enabled and the required time to occupy the "Hill" would be 60 seconds (1 minute). Time to hold would not automatically adjust downward with new players.

koth
position 0 0 20
height 20
radius 15
holdtime 100
teamplay
autotime 5 25
nosound
end

This would set up a King of the Hill cylindrical volume 30 x 30 x 20, centered at 0 0 30. Teamplay would be enabled and the required time to occupy the "Hill" would be 100 seconds. The time to occupy the hill would adjust downward with an increasing number of players (see autotime description above). Each new player after 2 will reduce the hold time by 5% to a minimum of 25% of the hold time (25 seconds). The sounds associated with the plugin would be disabled.

The plugin must be loaded at startup or else the server it will not recognize these map parameters.

=Server Commands=

There is one command available to all players with the plugin:

/kingsay <message> - this will send message to the player occupying the hill.

There are several administrator commands available with the plugin:

/kothon - this will turn King of the Hill mode on, if turned off previously.
/kothoff - this will turn King of the Hill mode off for normal gameplay.
/kothtimemult - this will set auto time multiplier (per new player).
/kothtimemultmin - this will set minimum auto time multiplier.
/kothautotimeon - this will enable the autotime function.
/kothsoundon - this will enable the plugin's sounds.
/kothsoundoff - this will disable the plugin's sounds.
/kothautotimeoff - this will disable the autotime funtion.
/kothtime <seconds> - this will change King of the Hill hold time 1 -> 7200 seconds.
/kothstatus - this will return the status of the plugin modes, times, etc.

=Deprecation=

* '''bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>'''
* '''cylinder <X> <Y> <Zmin> <Zmax> <radius>'''

Support for the '''bbox''' and '''cylinder''' parameters in a Koth zone has been deprecated and will be removed in the future.

=External Links=
* http://d41games.freehostia.com/bzflag.php?map=bbox An easy way to make bboxes.
* http://my.bzflag.org/bb/viewtopic.php?f=79&t=10005&p=99894#p99894 KotH plugin page.

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