Add more API functions

[TheGiraffe3]

I think it could be nice to have some of the BZFS API functions from the Grue repository.
For example, changing player teams could be useful for the base game's ctfOverseer plugin, and forcing player spawns would be helpful for teleport plugins or always-spawned servers.
A list of Grue's custom functions:

BZF_API bool bz_endServerShot(uint32_t shotID, bool explode = true);
BZF_API uint32_t bz_fireServerShotAsPlayer(const char* shotType, float origin[3], float vector[3],
                                   const char* flagAbbr, int playerID,
                                   float lifetime = -1,
                                   int targetPlayerId = -1);
BZF_API float bz_randFloatBetween(float a, float b);
BZF_API void bz_forcePlayerSpawn(int playerID);
BZF_API bool bz_isTeamFlag(const char* flagAbbr);
BZF_API void bz_sendToTeamsExcept(bz_eTeamType _team, const char* msg, int from = BZ_SERVER);
BZF_API bz_eTeamType bz_getTeamFromFlag(const char* flagAbbr);
BZF_API const char* bz_eTeamTypeLiteral(bz_eTeamType _team);
BZF_API bool bz_changeTeam(int playerID, bz_eTeamType _team);
BZF_API const char* bz_getFlagFromTeam(bz_eTeamType _team);
BZF_API bz_ApiString bz_getPlayerFlagAbbr(int playerID);
BZF_API bool bz_isPlayer(int playerID);
BZF_API bool bz_isValidSpawnPoint(float* pos);
BZF_API float* bz_getServerShotPos(uint32_t shotID);
BZF_API bz_eTeamType bz_getUnbalancedTeam(bz_eTeamType, bz_eTeamType);
BZF_API void bz_setServerVariableForPlayer(int playerID, const std::string& key, const std::string& value);
BZF_API bool bz_isNaturalBadFlag(const char* flagAbbr);
BZF_API bz_eTeamType bz_stringToTeamType(std::string teamColor);

BZF_API bool bz_delayedFlagReset(int flagID);
extern std::queue<std::tuple<double, int>> delayedFlagResetQueue; // time, flagID

Some of these might not be as useful (such as the bz_isTeamFlag function) but I'd like to see some of them in official releases.

[blast007]

• bz_endServerShot: Could probably just be a wrapper around the bzfs function shotEnded, and work for normal player shots as well, though I don't know if normal player shots will end correctly for both the local player and remote players.
• bz_fireServerShotAsPlayer: Likely doesn't work 100% correctly since I seem to recall that the local player doesn't see those shots.
• bz_randFloatBetween: Couldn't a plugin just do use this? https://en.cppreference.com/w/cpp/numeric/random/uniform_real_distribution.html
• bz_forcePlayerSpawn: Might be interesting, but I'd have to look into that
• bz_isTeamFlag: Maybe, but I wonder if it would be more useful taking a flag index instead of a flag abbreviation. Guess I'd have to see what it's used for.
• bz_sendToTeamsExcept: That seems oddly specific and seems like something a plugin should be doing on it's own
• bz_eTeamTypeLiteral: I could see that being useful, though the name is a bit odd
• bz_changeTeam: There only works by chance and abuses the protocol a bit since the local client accepts it's own MsgAddPlayer message. This would not go into the official codebase until we have a proper team change system.
• bz_getFlagFromTeam: I'm not clear on what this would be used for
• bz_getPlayerFlagAbbr: That's already what bz_getPlayerFlag does, so I'm not sure why that was added
• bz_isPlayer: That name is unclear (Is player only human tanks? Do observers count?). That implementation is also inefficient since it fetches a whole player record just to check if a player exists. A plugin could just use bz_getPlayerTeam(playerID) != eNoTeam
• bz_isValidSpawnPoint: That seems like a flawed implementation and I'm not sure of the use case. Is a plugin going to create a new spawn algorithm? Why does it set the Z min to 2 and the Z max to 1?
• bz_getServerShotPos: Why?
• bz_setServerVariableForPlayer: Nope, BZDB is a global database. It's not something you set for a specific player.
• bz_isNaturalBadFlag: I don't even know what this is supposed to do. What makes it a "natural" bad flag?
• bz_stringToTeamType: Maybe something like this could be added
• bz_delayedFlagReset: This seems overly specific and should be something a plugin tracks itself, not bzfs.

[TheGiraffe3]

• bz_randFloatBetween: yep, this one could be in a plugin
• bz_isTeamFlag: this might not be worth putting in main BZFS, it's fairly easy to do
• bz_sendToTeamsExcept: 👍🏼
• bz_changeTeam: Alright, but it would definitely be useful. I can imagine using /leave to switch to Observer mode wouldn't be a bad thing to have on all servers.
• bz_isPlayer: I think the main use case is if you're finding a random player to do something to.
• bz_isValidSpawnPoint: Probably isn't necessary for the base game, I believe it's used for the Dimension Door flag.
• bz_getServerShotPos: Maybe somewhat of a niche use case, but one way to use it would be have shockwaves fired every five seconds along the path of a bullet.
• bz_setServerVariableForPlayer: Setting BZDB values per player is useful for making maps with different sections (or even zones where players receive a speed boost, etc.)
• bz_isNaturalBadFlag: if it's a game-provided bad flag (e.g. Bouncy or Wide Angle) it returns true, could also be done in a plugin.