[L4D2] Bot Controller v1.5

Skyy · **Author**

Plugin Information:

This plugin aims to replace plugins like Super Versus, Bebop, and my old Player-Plus as a Bot Management plugin. Bot Controller is a framework which allows other plugins to be built off of it.

What is the framework?

BotController is the framework; it's a plugin built on natives & forwards, but doesn't really do anything unless those calls are utilized. The framework can be expanded upon without harming any plugins developed for it. Plugins written for the framework simply expand on its base capabilities. BotController must be installed on your server for its modules to work on the server.

What are the modules?

Currently only one module exists, but you're welcome to develop your own! The module in question is bc_config which, using the calls, is what actually manages the bots.
bc_config adds several new cvars:

Spoiler

bc_config does not create a /cfg/sourcemod/ file for convenience, allowing server operators to add these cvars to their server.cfg or elsewhere, or to simply use the default values associated with the plugin.

Installation:

Installing the plugin has never been simpler.

1. Place botcontrol.txt in your /sourcemod/gamedata/ folder.
2. Place botcontroller.phrases in your /sourcemod/translations/ folder.
3. Place botcontroller.smx in your /sourcemod/plugins/ folder.
4. Place bc_config.smx in your /sourcemod/plugins/ folder.

Module Development:

Several calls have been written for module development; bc_config, for example, is a module.
These can be found in botcontrol.inc

Spoiler

PHP Code:


			
/*
 *  Calling this native will force the plugin to regulate the survivor bots based
 *  on whatever the current survivor minimum and maximum requirements are.
 *  
 */
native OnRegulateSurvivorBots();

/*
 *  Forces the player to attempt to join the survivor team - or create bots. See params.
 *
 * @param client        If set to 0, will create a bot but not assign a player to it.
 *                      Will do nothing if the survivor limit has been reached.
 *
 */
native OnJoinSurvivorTeam(client);

/*
 *  Sets the Survivor Minimum and Maximum requirements. OnRegulateSurvivorBots() will not
 *  be called if BotRegulation override is enabled.
 *
 *  @param min          The minimum number of survivors that MUST exist. Humans + Bots.
 *  @param max          The maximum number of survivors that CAN exist.
 *
 */
native OnSetSurvivorRequirements(min, max);

/*
 *  Will block BotControl core from running any Survivor Bot Restriction Regulation functions.
 *  If the function is blocked, the OnRegulateSurvivorBots() native must be called for these
 *  functions to be performed.
 *
 */
native OnBlockSurvivorBotRegulation();

/*
 *
 *  Will allow BotControl core to run all Survivor Bot Restriction Regulation functions.
 *  This is the default setting. Don't forget to call this OnPluginEnd() if your plugin
 *  blocks the functionality!!!
 *
 */
native OnAllowSurvivorBotRegulation();

/*
 *
 *    Will allow survivor bots to be in-game even if there are no human survivors in-game.
 *
 */
native OnAllowSoloSurvivorBots();

/*
 *
 *    Will not allow survivor bots to be in-game if there are no human survivors in-game.
 *
 */
native OnBlockSoloSurvivorBots();

/*
 *
 *  Allows the creation of a custom number of survivor bots.
 *  Important:  Disable SurvivorBotRegulation by the core plugin before using this native.
 *
 *  @param count        The number of Survivor Bots to create.
 *
 */
native OnCreateSurvivorBots(count);

/*
 *
 *  Allows the destruction of a custom number of survivor bots.
 *  Important:  This will not remove bots that are tied to idle players.
 *
 *  @param count        The number of Survivor Bots to destroy.
 *
 */
native OnDestroySurvivorBots(count);

/*
 *
 *    Allows the setting and management of both infected and survivor team limits.
 *
 *    @param survivorLimit    Must be a value greater than 0 or will be ignored.
 *    @param infectedLimit    Must be a value greater or equal to 0 or will be ignored.
 *
 */
native OnSlotManagement(survivorLimit, infectedLimit);

/*
 *
 *    Adjusts the values, permanently, of reserve slots.
 *
 *    @param reserveslots        The number of non-playable (unless under special circumstances) slots on the server.
 *    @param maximumslots        The number of maximum always-playable slots on the server. Make sure maxplayers is reserveslots + maximumslots.
 *    @param kickdelay        The time in seconds (int) until the player is removed (if there are reserve slots available for the connecting player)
 *                            otherwise the player receives no notice and is removed immediately for the connecting player.
 *
 */
native OnReserveSlotManagement(reserveslots, maximumslots, kickdelay);

/*
 *
 *    Enables reserve slots management on the server. Note, this DOES NOT set the reserve slots, the maximum slots, and the kick delay.
 *    You MUST call OnReserveSlotManagement native (above) and set the values before enabling this (or all hell will break loose)
 *
 */
native OnAllowReserveSlots();

/*
 *
 *    The opposite of enabling.
 *
 */
native OnBlockReserveSlots();

/*
 *
 *    Provides plugins more detailed / selective options for WHICH survivor bots to remove.
 *    Hope to find a way to add more than a static number of options.
 *
 *    @param count        The plugin will kick UP TO this amount of bots (if applicable)
 *    @param reqs            1 - Only one condition must pass on a bot to remove it. 2 - All received conditions must pass to remove the bot.
 *    @param param1        Currently, the native supports UP TO 3 UNIQUE params. Your options are, for example:
 *
 *                        ".mdl" in a param will check the param string against the bot survivor model.
 *                        "!dead" as a param will require bots to be not dead.
 *                        "dead" as a param will require bots to be dead.
 *                        *NOTE* -> You could use 3 different models as your params, if for example, you wanted to remove bots of all those
 *                                  models. However, for that to work, reqs would have to be set to 1.
 *
 *                        I'd really love to add more, or, if possible, IF GetNativeArray will allow me to pass an ADT Array...
 *                        !-- IMPORTANT --!
 *                        Because this native is expected to be used under special circumstances, it DOES NOT adjust the survivor bot minimum
 *                        requirement after kicking bots in this way, in the assumption that an author will do something with the forward that
 *                        immediately follows, OnDestroySurvivorBotsFwd.
 *
 */
native OnDestroySurvivorBotsEx(count, reqs, String:param1[], String:param2[], String:param3[]);

/*
 *
 *    The only purpose of this native is to request whether Bot Regulation is enabled or disabled on the core plugin.
 *    Will shoot off the OnRequestSurvivorBotRegulationFwd forward.
 *
 */
native OnRequestSurvivorBotRegulation();

/*
 *
 *    When a new bot is created, sends out information about the bot and new client.
 *    Requested by DeathChaos25
 *
 *    @Param client        The Client ID of the player who will be taking ownership of the bot.
 *    @Param cnetp        The net prop ID of the bot.
 *    @Param cmodel        The character model of the bot.
 *
 */
forward OnBotCreatedFwd(client, cnetp, String:cmodel[]);

/*
 *
 *    After all eligible bots have been removed, this forward fires, notifying plugins of the number
 *    of bots that were removed - it's possible the number may differ from the value the plugin that
 *    triggered this forward requested be removed.
 *
 *    @Param count        The number of survivor bots that were kicked through OnDestroySurvivorBotsEx native.
 *
 */
forward OnDestroySurvivorBotsFwd(count);

/*
 *
 *    This forward is called when OnRequestSurvivorBotRegulation native is called. It will notify any listening
 *    plugins on whether or not Bot Regulation is automated through the plugin or not.
 *
 *    @Bool IsEnabled        0 for disabled, 1 for enabled.
 *
 */
forward OnRequestSurvivorBotRegulationFwd(bool:IsEnabled);

/*
 *
 *    This forward is called when the first client loads into the game.
 *
 */
forward OnFirstClientLoadedFwd();

/*
 *
 *    This forward fires when a player goes idle and is moved to the spectator team.
 *
 *    @Param client        The client ID.
 *    @Param PrmWpn        The String of the Primary weapon. Is -1 if no weapon found.
 *    @Param PrmUp        The upgrades for the Primary weapon. Is -1 if no weapon.
 *    @Param SecWpn        The String of the Secondary weapon. Is -1 if no weapon found.
 *    @Param SecUp        The upgrades for the Secondary weapon. Is -1 if no weapon.
 *    @Param GrnWpn        The grenade the player is holding, -1 if not found.
 *    @Param AidWpn        The First Aid item the player is holding, -1 if not found.
 *    @Param PillsWpn        The Pills item the player is holding, -1 if not found.
 *
 */
forward OnSurvivorIdleFwd(client, String:PrmWpn[], PrmUp, String:SecWpn[], SecUp, String:GrnWpn[], String:AidWpn[], String:PillsWpn[]);

/*
 *
 *    This forward fires when a player who was an idle Survivor has rejoined the game.
 *
 *    @Param client        The client ID.
 *
 */
forward OnSurvivorIdleEndFwd(client);

/*
 *
 *        After a player has successfully cleared the reserve slots check, broadcast it.
 *        Bot Controller doesn't handle players joining on its own - so another plugin has to do it.
 *
 *        @Param client        The client ID.
 *
 */
forward OnAnyClientLoaded(client);