Corrections needed for API docs

[allejo]

Commit 987414d6841b7a2a89cbf2c21da396e5036bfedc added the entirety of the remaining 2.4.x API to the docs. These files have multiple overloads so verifying that the committed versions are correct would be highly appreciated.

• [ ] bz_getPlayerIndexList
• [ ] bz_sendTextMessage
• [ ] bz_sendTextMessage
• [ ] bz_sendTextMessage
• [ ] bz_sendTextMessagef
• [ ] bz_sendTextMessagef
• [ ] bz_sendTextMessagef
• [ ] bz_setShotMetaData
• [ ] bz_registerCustomSlashCommand
• [ ] bz_addURLJob
• [ ] bz_addURLJob
• [ ] bz_cancelCountdown
• [ ] bz_pauseCountdown
• [ ] bz_resumeCountdown
• [ ] bz_startCountdown
• [ ] bz_MD5

[Zehra]

✅ Documented bugs in this post have been completed

- allejo

---

From what I could find in BZFS API Events:

Administrative events

• bz_eUnmuteEvent correct (still not sure why it uses the same data as bz_eMuteEvent though.)

  There is no difference between the data available between a mute and unmute action. If you need to know which action it is, you already have that by listening to either to the mute or unmute event.

Capture The Flag events

• bz_eAllowCTFCaptureEvent ('bool killTeam' appears in header, although does not appear in documentation.)

  Fixed in 4f9e7f583fcf1c8d672274a1797bddfc7434eda9

Chat events

• bz_eFilteredChatMessageEvent (Mentions available, since 2.4.4, while it is available since 2.4.0, but bz_ChatEventData_V2 exists only in 2.4.4 and after, so 'technically' correct.)

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

• bz_eRawChatMessageEvent (Mentions available, since 2.4.4, while it is available since 2.4.0, but * bz_ChatEventData_V2 exists only in 2.4.4 and after, so 'technically' correct.)

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

Countdown Timer events

• bz_eGameEndEvent (Says 2.4.0, while bz_GameStartEndEventData_V2 exists in 2.4.4 and after.)

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

• bz_eGameStartEvent (Says 2.4.0, while bz_GameStartEndEventData_V2 exists in 2.4.4 and after.)

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

Logging events

• bz_eNetDataReceiveEvent (In header, there is a 'playerID', but this isn't in the documentation, so not sure if this is intentional.)

  Fixed in f1540e15bb67c5e4dfad4eefc1d344f47ca9d325

• bz_eNetDataSendEvent (Same as detail mentioned above.)

  Fixed in f1540e15bb67c5e4dfad4eefc1d344f47ca9d325

Player

• bz_eGetPlayerMotto (Mentions available, since 2.4.4, while it is available since 2.4.0, but bz_GetPlayerMottoData_V2 exists only in 2.4.4 and after, so 'technically' correct.)

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

• bz_ePlayerAuthEvent ('bool password' and 'bool globalAuth' appear in header, but not in documentation.)

  Fixed in c99bc2e85d3188cd1849dc85a76a7b326779183d

• bz_ePlayerDieEvent (Available since 2.4.0, but bz_PlayerDieEventData_V2 exists only in 2.4.10 and after.)

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

Player Spawns events

• bz_eAllowSpawn (2.4.6. and after have bz_AllowSpawnData_V2.)

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

Shots events

• bz_eShotFiredEvent ('int shotID;' appears in header, but not in documentation.)

  Fixed in c99bc2e85d3188cd1849dc85a76a7b326779183d

Slash Commands events

• bz_eSlashCommandEvent (exists since 2.4.0, but bz_SlashCommandEventData_V2 not documented, but exists since 2.4.14 and after.

  Fixed in bd5f3ea06b75b3cb657d717c16f4ff114c947eb1

[Zehra]

Inconsistent information

Chat Messages

• bz_sendTextMessage() (correct, but doesn't seem to document 'bz_eMessageType' options?)
• bz_sendTextMessagef() (correct, but doesn't seem to document 'bz_eMessageType' options?)

Flag Management

• bz_resetFlags() ( 'bool keepTeamFlags', exists only in 2.4.4. and afterwards.)

Inter-Plug-in Communications

• bz_callPluginGenericCallback() (Introduced in 2.4.4. and also needs a description.)

Map Building

• bz_addWorldWeapon() (Missing address of 'delays' in bz_APIFloatList.)

Player Latency

• bz_getPausedTime() (It returns double instead of int.)

Player Records

• bz_freePlayerRecord() (Says int, but is bool according to header.)
• bz_getPlayerBySlotOrCallsign() (2.4.4. is where it is introduced.)
• bz_updatePlayerData() (Says 'void', but header seems to indicated a 'bool' value instead.)

Player Score

• bz_howManyTimesPlayerKilledBy() (2.4.4 is when it first appears.)
• bz_incrementPlayerLosses() (void listed, but bool return value according to header.)
• bz_incrementPlayerTKs() (void listed, but bool return value according to header.)
• bz_incrementPlayerWins() (void listed, but bool return value according to header.)

Player State

• bz_getPlayerCurrentState() (Doesn't seem to be in the headers, but I did find 'getCurrentState'?)

Poll Management

• bz_registerCustomPollType() (2.4.12 is when it is first introduced.)
• bz_removeCustomPollType() (Same as bz_registerCustomPollType, it is first introduced in 2.4.12.)

Server Management

• bz_restart() ('bool' appears in header instead of void.)

Shot Management

• bz_setShotMetaData() (correct, but we have a depreciated function as well.)
• bz_shotHasMetaData() (correct, but we have a depreciated function as well.)

String Operations

• bz_MD5() (seems there is two functions with the same name?)

Timed Games

• bz_cancelCountdown() (correct, but should note depreciated function?)
• bz_pauseCountdown() (correct, but should note depreciated function?)
• bz_resumeCountdown() (correct, but should note depreciated function?)
• bz_startCountdown() (correct, but should note depreciated function?)

URL Jobs

• bz_addURLJob() (Correct, but probably should note the additional two functions with the same name in more up to date versions of the API.)

World Management

• bz_getClientWorldDownloadURL() (correct, but 'usage' appears weird.)

Missing Descriptions

Bans

• bz_getBanItem() (correct, but needs description.)
• bz_getBanItemDuration() (correct, but needs description.)
• bz_getBanItemIsFromMaster() (correct, but needs description.)
• bz_getBanItemReason() (correct, but needs description.)
• bz_getBanItemSource() (correct, but needs description.)
• bz_getBanListSize() (correct, but needs description.)

Connection Management

• bz_disconnectNonPlayerConnection() (correct, but description needed.)
• bz_getNonPlayerConnectionHost() (correct, but description needed.)
• bz_getNonPlayerConnectionIP() (correct, but description needed.)
• bz_getNonPlayerConnectionOutboundPacketCount() (correct, but description needed.)
• bz_registerNonPlayerConnectionHandler() (correct, but needs description.)
• bz_removeNonPlayerConnectionHandler() (correct, but needs description.)
• bz_sendNonPlayerData() (correct, but needs description.)
• bz_setNonPlayerDataThrottle() (correct, but needs description.)
• bz_setNonPlayerDisconnectOnSend() (correct, but needs description.)
• bz_setNonPlayerInactivityTimeout() (correct, but needs description.)

Coordinate System

• bz_getRandomPoint() (correct, but needs description.)
• bz_vectorFromPoints() (correct, but needs description.)
• bz_vectorFromRotations() (correct, but needs description.)

Filtering

• bz_AddFilterItem() (correct, but needs description.)
• bz_CallsignsFiltered() (correct, but needs description.)
• bz_ChatFiltered() (correct, but needs description.)
• bz_ClearFilter() (correct, but needs description.)
• bz_LoadFilterDefFile() (correct, but needs description.)
• bz_SetFiltering() (correct, but needs description.)

Game Mode Management

• bz_computePlayerScore() (correct, but description needed.)
• bz_computeTeamScore() (correct, but description needed.)
• bz_computingPlayerScore() (correct, but description needed.)
• bz_computingTeamScore() (correct, but description needed.)
• bz_getGameType() (correct, but description needed.)
• bz_triggerFlagCapture() (correct, but description needed.)

Gameplay Recordings

• bz_saveRecBuf() (correct, but description needed.)
• bz_startRecBuf() (correct, but description needed.)
• bz_stopRecBuf() (correct, but description needed.)

Global Database Management (BZDB)

• bz_BZDBItemExists() (correct, but description needed.)
• bz_BZDBItemHasValue() (correct, but needs description.)
• bz_getBZDBBool() (correct, but needs description.)
• bz_getBZDBDouble() (correct, but needs description.)
• bz_getBZDBInt() (correct, but needs description.)
• bz_getBZDBItemPerms() (correct, but needs description.)
• bz_getBZDBItemPesistent() (correct, but needs description.)
• bz_getBZDBString() (correct, but needs description.)
• bz_getBZDBVarList() (correct, but needs description.)
• bz_registerCustomBZDBBool() (correct, but needs description.)
• bz_registerCustomBZDBDouble() (correct, but needs description.)
• bz_registerCustomBZDBInt() (correct, but needs description.)
• bz_registerCustomBZDBString() (correct, but needs description.)
• bz_removeCustomBZDBVariable() (correct, but needs description.)
• bz_resetALLBZDBVars() (correct, but needs description.)
• bz_resetBZDBVar() (correct, but needs description.)
• bz_setDefaultBZDBBool() (correct, but needs description.)
• bz_setDefaultBZDBDouble() (correct, but needs description.)
• bz_setDefaultBZDBInt() (correct, but needs description.)
• bz_setDefaultBZDBString() (correct, but needs description.)
• bz_updateBZDBBool() (correct, but needs description.)
• bz_updateBZDBDouble() (correct, but needs description.)
• bz_updateBZDBInt() (correct, but needs description.)
• bz_updateBZDBString() (correct, but needs description.)

Help Topics

• bz_getHelpTopic() (correct, but needs description.)
• bz_getHelpTopics() (correct, but needs description.)

Inter-Plug-in Communications

• bz_addClipFieldNotifier() (correct, but needs description.)
• bz_clipFieldExists() (correct, but needs description.)
• bz_getclipFieldFloat() (correct, but needs description.)
• bz_getclipFieldInt() (correct, but needs description.)
• bz_getclipFieldString() (correct, but needs description.)
• bz_removeClipFieldNotifier() (correct, but needs description.)
• bz_setclipFieldFloat() (correct, but needs description.)
• bz_setclipFieldInt() (correct, but needs description.)
• bz_setclipFieldString() (correct, but needs description.)

Map Building

• bz_addWorldBase() (correct, but needs description.)
• bz_addWorldBox() (correct, but needs description.)
• bz_addWorldPyramid() (correct, but needs description.)
• bz_addWorldTeleporter() (correct, but needs description.)
• bz_addWorldWaterLevel() (correct, but needs description.)
• bz_registerCustomMapObject() (correct, but needs description.)
• bz_removeCustomMapObject() (correct, but needs description.)

Map Information

• bz_getWorldMaxHeight() (correct, but needs description.)

Map Management

• bz_checkBaseAtPoint() (correct, but needs description.)
• bz_setWorldSize() (correct, but needs description.) [Sets the size of the world based on argument.]

Misc

• bz_sendPlayCustomLocalSound() (correct, but needs description.)

Player Handicaps

• bz_refreshHandicaps() (correct, but needs description.)

Player Information

• bz_getPlayerHumanity() (correct, but needs a description.)
• bz_getPlayerMotto() (correct, but needs a description.)

Player Latency

• bz_getLagWarn() (correct, but needs a description.)
• bz_setLagWarn() (correct, but needs a description.)

Plug-in Management

• bz_getLoadedPlugins() (correct, but description needed.)
• bz_getPlugin() (correct, but description needed.)
• bz_pluginBinPath() (correct, but description needed.)
• bz_pluginExists() (correct, but description needed.)
• bz_registerCustomPluginHandler() (correct, but description needed.)
• bz_removeCustomPluginHandler() (correct, but description needed.)

Poll Management

• bz_pollActive() (correct, but needs description.)
• bz_pollVeto() (correct, but needs description.)

Server Debugging

• bz_debugMessage() (correct, but needs description.)
• bz_debugMessagef() (correct, but needs description.)
• bz_getDebugLevel() (correct, but needs description.)
• bz_setDebugLevel() (correct, but needs description.)

Server Information

• bz_getPublic() (correct, but needs description.)
• bz_getPublicAddr() (correct, but needs description.)
• bz_getPublicDescription() (correct, but needs description.)
• bz_getPublicPort() (correct, but needs description.)
• bz_getServerOwner() (correct, but needs description.)
• bz_getServerVersion() (correct, but needs description.)

Server Management

• bz_getReports() (correct, but needs description.)
• bz_getStandardSpawn() (correct, but needs description.)
• bz_getWorldCacheData() (correct, but needs description.)
• bz_getWorldCacheSize() (correct, but needs description.)
• bz_updateListServer() (correct, but needs description.)

Server Side Players

• bz_addServerSidePlayer() (correct, but needs description.)
• bz_removeServerSidePlayer() (correct, but needs description.)

Server Side Shots

• bz_fireServerShot() (correct, but needs description.) [Fires a shot from the server based on arguments.]

Server Time

• bz_getCurrentTime() (correct, but needs description.)
• bz_getLocaltime() (correct, but needs description.)
• bz_getUTCtime() (correct, but needs description.)

Slash Commands

• bz_registerCustomSlashCommand() (correct, but needs description. [also should 'bz_CustomSlashCommandHandler *handler);' be documented?]) [Registers a custom slash command.]
• bz_removeCustomSlashCommand() (correct, but needs description.)

String Operations

• bz_filterPath() (correct, but needs description.)
• bz_format() (correct, but needs description.)
• bz_join() (correct, but needs description.)
• bz_ltrim() (correct, but needs description.)
• bz_rtrim() (correct, but needs description.)
• bz_tolower() (correct, but needs description.)
• bz_toupper() (correct, but needs description.)
• bz_trim() (correct, but needs description.)
• bz_urlEncode() (correct, but needs description.)

Timed Games

• bz_getCountdownRemaining() (correct, but needs description.)
• bz_getTimeLimit() (correct, but needs description.)
• bz_isCountDownActive() (correct, but needs description.)
• bz_isCountDownInProgress() (correct, but needs description.)
• bz_isCountDownPaused() (correct, but needs description.)
• bz_isTimeManualStart() (correct, but needs description.)
• bz_setTimeLimit() (correct, but needs description.)

URL Jobs

• bz_addURLJobForID() (correct, but needs description.)
• bz_removeURLJob() (correct, but needs description.)
• bz_removeURLJobByID() (correct, but needs description.)
• bz_sentFetchResMessage() (correct, but needs description.)

Edit: Minor update to "missing descriptions".

[The-Noah]

• [x] bz_APIVersion
• [x] bz_HostBanUser
• [x] bz_HostUnbanUser
• [x] bz_IDUnbanUser
• [x] bz_IPBanUser
• [x] bz_IPUnbanUser
• [x] bz_MD5
• [x] bz_getProtocolVersion
• [x] bz_getServerVersion
• [x] bz_kickUser
• [x] bz_killPlayer
• [x] bz_loadPlugin
• [x] bz_unloadPlugin

[allejo]

@The-Noah, do you have a PR or branch for those functions you've checked off?

[The-Noah]

Sorry, I have been very busy recently. I am finishing up a few and then will create a PR.

[allejo]

Sorry, I have been very busy recently. I am finishing up a few and then will create a PR.

No worries, thanks for your work! If you could just make sure you split your contributions to reasonably sized PRs, that'd help us review them and manage them quicker.

[The-Noah]

Okay. Is the list above small enough?

[allejo]

I'd suggest splitting them up at least into two PRs. See how #5 has grown to a point where it's hard to find conversations. But I'm cautious towards suggesting one PR/doc because then we'd be flooded with PRs since we're barely starting off with docs.

Admin Related

• bz_HostBanUser
• bz_HostUnbanUser
• bz_IDUnbanUser
• bz_IPBanUser
• bz_IPUnbanUser
• bz_kickUser
• bz_killPlayer

API/Server Related

• bz_APIVersion
• bz_loadPlugin
• bz_unloadPlugin
• bz_MD5
• bz_getProtocolVersion
• bz_getServerVersion