BZFS API Functions
These API functions are allow plug-in developers to interact with the current game state and players.
API Lists
- bz_deleteFloatList()
- bz_deleteIntList()
- bz_deleteStringList()
- bz_newFloatList()
- bz_newIntList()
- bz_newStringList()
API Versioning
Bans
- bz_HostBanUser()
- bz_HostUnbanUser()
- bz_IDUnbanUser()
- bz_IPBanUser()
- bz_IPUnbanUser()
- bz_getBanItem()
- bz_getBanItemDuration()
- bz_getBanItemIsFromMaster()
- bz_getBanItemReason()
- bz_getBanItemSource()
- bz_getBanListSize()
- bz_kickUser()
Chat Messages
Connection Management
- bz_disconnectNonPlayerConnection()
- bz_getNonPlayerConnectionHost()
- bz_getNonPlayerConnectionIP()
- bz_getNonPlayerConnectionOutboundPacketCount()
- bz_registerNonPlayerConnectionHandler()
- bz_removeNonPlayerConnectionHandler()
- bz_sendNonPlayerData()
- bz_setNonPlayerDataThrottle()
- bz_setNonPlayerDisconnectOnSend()
- bz_setNonPlayerInactivityTimeout()
Coordinate System
Filtering
- bz_AddFilterItem()
- bz_CallsignsFiltered()
- bz_ChatFiltered()
- bz_ClearFilter()
- bz_LoadFilterDefFile()
- bz_SetFiltering()
Flag Management
- bz_RegisterCustomFlag()
- bz_flagPlayer()
- bz_getFlagName()
- bz_getFlagPosition()
- bz_getNumFlags()
- bz_getPlayerFlagID()
- bz_givePlayerFlag()
- bz_moveFlag()
- bz_removePlayerFlag()
- bz_resetFlag()
- bz_resetFlags()
Game Mode Management
- bz_computePlayerScore()
- bz_computeTeamScore()
- bz_computingPlayerScore()
- bz_computingTeamScore()
- bz_getGameType()
- bz_triggerFlagCapture()
Gameplay Recordings
Global Database Management (BZDB)
- bz_BZDBItemExists()
- bz_BZDBItemHasValue()
- bz_getBZDBBool()
- bz_getBZDBDouble()
- bz_getBZDBInt()
- bz_getBZDBItemPerms()
- bz_getBZDBItemPesistent()
- bz_getBZDBString()
- bz_getBZDBVarList()
- bz_registerCustomBZDBBool()
- bz_registerCustomBZDBDouble()
- bz_registerCustomBZDBInt()
- bz_registerCustomBZDBString()
- bz_removeCustomBZDBVariable()
- bz_resetALLBZDBVars()
- bz_resetBZDBVar()
- bz_setDefaultBZDBBool()
- bz_setDefaultBZDBDouble()
- bz_setDefaultBZDBInt()
- bz_setDefaultBZDBString()
- bz_updateBZDBBool()
- bz_updateBZDBDouble()
- bz_updateBZDBInt()
- bz_updateBZDBString()
Group Management
Help Topics
Inter-Plug-in Communications
- bz_addClipFieldNotifier()
- bz_callPluginGenericCallback()
- bz_clipFieldExists()
- bz_getclipFieldFloat()
- bz_getclipFieldInt()
- bz_getclipFieldString()
- bz_removeClipFieldNotifier()
- bz_setclipFieldFloat()
- bz_setclipFieldInt()
- bz_setclipFieldString()
Map Building
- bz_addWorldBase()
- bz_addWorldBox()
- bz_addWorldPyramid()
- bz_addWorldTeleporter()
- bz_addWorldWaterLevel()
- bz_addWorldWeapon()
- bz_registerCustomMapObject()
- bz_removeCustomMapObject()
Map Information
Map Management
Misc
Player Handicaps
Player Information
- bz_getAdmin()
- bz_getPlayerCallsign()
- bz_getPlayerFlag()
- bz_getPlayerHumanity()
- bz_getPlayerIPAddress()
- bz_getPlayerMotto()
- bz_getPlayerTeam()
- bz_isPlayerAutoPilot()
Player Latency
- bz_getIdleTime()
- bz_getLagWarn()
- bz_getPausedTime()
- bz_getPlayerJitter()
- bz_getPlayerLag()
- bz_getPlayerPacketloss()
- bz_setLagWarn()
Player Lists
Player Permissions
Player Records
Player Score
- bz_getPlayerLosses()
- bz_getPlayerRank()
- bz_getPlayerTKs()
- bz_getPlayerWins()
- bz_howManyTimesPlayerKilledBy()
- bz_incrementPlayerLosses()
- bz_incrementPlayerTKs()
- bz_incrementPlayerWins()
- bz_resetPlayerScore()
- bz_setPlayerLosses()
- bz_setPlayerTKs()
- bz_setPlayerWins()
Player State
- bz_getPlayerSpawnAtBase()
- bz_isPlayerPaused()
- bz_isPlayerSpawnable()
- bz_setPlayerSpawnAtBase()
- bz_setPlayerSpawnable()
Plug-in Management
- bz_getLoadedPlugins()
- bz_getPlugin()
- bz_loadPlugin()
- bz_pluginBinPath()
- bz_pluginExists()
- bz_registerCustomPluginHandler()
- bz_removeCustomPluginHandler()
- bz_unloadPlugin()
Poll Management
Server Debugging
Server Information
- bz_getPublic()
- bz_getPublicAddr()
- bz_getPublicDescription()
- bz_getPublicPort()
- bz_getServerOwner()
- bz_getServerVersion()
Server Management
- bz_gameOver()
- bz_getPlayerCount()
- bz_getReports()
- bz_getShotMismatch()
- bz_getWorldCacheData()
- bz_getWorldCacheSize()
- bz_isAutoTeamEnabled()
- bz_reloadBadwords()
- bz_reloadGroups()
- bz_reloadHelp()
- bz_reloadLocalBans()
- bz_reloadMasterBans()
- bz_reloadUsers()
- bz_restart()
- bz_setShotMismatch()
- bz_shutdown()
- bz_superkill()
- bz_updateListServer()
Server Side Players
Server Side Shots
Server Time
Shot Management
- bz_getShotGUID()
- bz_getShotMetaDataI()
- bz_getShotMetaDataS()
- bz_setShotMetaData()
- bz_shotHasMetaData()
Slash Commands
Spawn Management
String Operations
- bz_MD5()
- bz_filterPath()
- bz_format()
- bz_join()
- bz_ltrim()
- bz_rtrim()
- bz_tolower()
- bz_toupper()
- bz_trim()
- bz_urlEncode()
Team Management
- bz_getTeamCount()
- bz_getTeamLosses()
- bz_getTeamPlayerLimit()
- bz_getTeamScore()
- bz_getTeamWins()
- bz_incrementTeamLosses()
- bz_incrementTeamWins()
- bz_resetTeamScore()
- bz_resetTeamScores()
- bz_setTeamLosses()
- bz_setTeamWins()
Timed Games
- bz_cancelCountdown()
- bz_getCountdownRemaining()
- bz_getTimeLimit()
- bz_isCountDownActive()
- bz_isCountDownInProgress()
- bz_isCountDownPaused()
- bz_isTimeManualStart()
- bz_pauseCountdown()
- bz_resumeCountdown()
- bz_setTimeLimit()
- bz_startCountdown()