Added bot command 'BotStopMeleeLevel'

common/version.h

@@ -32,7 +32,7 @@
 
 #define CURRENT_BINARY_DATABASE_VERSION 9122
 #ifdef BOTS
-	#define CURRENT_BINARY_BOTS_DATABASE_VERSION 9018
+	#define CURRENT_BINARY_BOTS_DATABASE_VERSION 9019
 #else
 	#define CURRENT_BINARY_BOTS_DATABASE_VERSION 0 // must be 0
 #endif

utils/sql/git/bots/bots_db_update_manifest.txt

@@ -17,6 +17,7 @@
 9016|2017_02_26_bots_spell_casting_chances_update.sql|SHOW TABLES LIKE 'bot_spell_casting_chances'|empty|
 9017|2017_03_26_bots_spells_id_fix_for_saved_shadowknight_bots.sql|SELECT * FROM `bot_data` WHERE `class` = '5' AND `spells_id` = '3004'|not_empty|
 9018|2018_02_02_Bot_Spells_Min_Max_HP.sql|SHOW COLUMNS FROM `bot_spells_entries` LIKE 'min_hp'|empty|
+9019|2018_04_12_bots_stop_melee_level.sql|SHOW COLUMNS FROM `bot_data` LIKE 'stop_melee_level'|empty|
 
 # Upgrade conditions:
 # 	This won't be needed after this system is implemented, but it is used database that are not

utils/sql/git/bots/required/2018_04_12_bots_stop_melee_level.sql

@@ -0,0 +1,8 @@
+ALTER TABLE `bot_data` ADD COLUMN `stop_melee_level` TINYINT(3) UNSIGNED NOT NULL DEFAULT '255' AFTER `follow_distance`;
+
+INSERT INTO `bot_command_settings`(`bot_command`, `access`, `aliases`) VALUES ('botstopmeleelevel', '0', 'sml');
+
+SELECT @csml_raw := (SELECT `rule_value` FROM `rule_values` WHERE `rule_name` LIKE 'Bots:CasterStopMeleeLevel' LIMIT 1);
+SELECT @csml_value := IF((SELECT @csml_raw REGEXP '^[0-9]+$') = '1', @csml_raw, '13');
+
+UPDATE `bot_data` SET `stop_melee_level` = @csml_value WHERE `class` IN ('2', '6', '10', '11', '12', '13', '14');

zone/bot.cpp

@@ -78,6 +78,11 @@ Bot::Bot(NPCType npcTypeData, Client* botOwner) : NPC(&npcTypeData, nullptr, glm
 	SetPauseAI(false);
 	rest_timer.Disable();
 	SetFollowDistance(BOT_FOLLOW_DISTANCE_DEFAULT);
+	if (IsCasterClass(GetClass()))
+		SetStopMeleeLevel((uint8)RuleI(Bots, CasterStopMeleeLevel));
+	else
+		SetStopMeleeLevel(255);
+
 	// Do this once and only in this constructor
 	GenerateAppearance();
 	GenerateBaseStats();
@@ -151,6 +156,11 @@ Bot::Bot(uint32 botID, uint32 botOwnerCharacterID, uint32 botSpellsID, double to
 
 	rest_timer.Disable();
 	SetFollowDistance(BOT_FOLLOW_DISTANCE_DEFAULT);
+	if (IsCasterClass(GetClass()))
+		SetStopMeleeLevel((uint8)RuleI(Bots, CasterStopMeleeLevel));
+	else
+		SetStopMeleeLevel(255);
+
 	strcpy(this->name, this->GetCleanName());
 
 	memset(&_botInspectMessage, 0, sizeof(InspectMessage_Struct));
@@ -2041,6 +2051,13 @@ void Bot::SetTarget(Mob* mob) {
 	}
 }
 
+void Bot::SetStopMeleeLevel(uint8 level) {
+	if (IsCasterClass(GetClass()) || IsSpellFighterClass(GetClass()))
+		_stopMeleeLevel = level;
+	else
+		_stopMeleeLevel = 255;
+}
+
 void Bot::SetGuardMode() {
 	WipeHateList();
 	SetTarget(nullptr);
@@ -2386,11 +2403,20 @@ void Bot::AI_Process() {
 		// Calculate casting distance
 		float caster_distance_max = 0.0f;
 		{
-			if (GetLevel() >= RuleI(Bots, CasterStopMeleeLevel)) {
+			if (GetLevel() >= GetStopMeleeLevel()) {
 				switch (GetClass()) {
 				case CLERIC:
 					caster_distance_max = 1156.0f; // as DSq value (34 units)
 					break;
+				case PALADIN:
+					caster_distance_max = 576.0f; // as DSq value (24 units)
+					break;
+				case RANGER:
+					caster_distance_max = 784.0f; // as DSq value (28 units)
+					break;
+				case SHADOWKNIGHT:
+					caster_distance_max = 676.0f; // as DSq value (26 units)
+					break;
 				case DRUID:
 					caster_distance_max = 1764.0f; // as DSq value (42 units)
 					break;
@@ -2409,7 +2435,11 @@ void Bot::AI_Process() {
 				case ENCHANTER:
 					caster_distance_max = 2500.0f; // as DSq value (50 units)
 					break;
+				case BEASTLORD:
+					caster_distance_max = 900.0f; // as DSq value (30 units)
+					break;
 				default:
+					// pure melee classes (and BARD) do not get this option
 					break;
 				}
 			}

zone/bot.h

@@ -406,6 +406,8 @@ public:
 	bool AIHealRotation(Mob* tar, bool useFastHeals);
 	bool GetPauseAI() { return _pauseAI; }
 	void SetPauseAI(bool pause_flag) { _pauseAI = pause_flag; }
+	uint8 GetStopMeleeLevel() { return _stopMeleeLevel; }
+	void SetStopMeleeLevel(uint8 level);
 	void SetGuardMode();
 	
 	// Mob AI Virtual Override Methods
@@ -742,6 +744,7 @@ private:
 	bool _altoutofcombatbehavior;
 	bool _showhelm;
 	bool _pauseAI;
+	uint8 _stopMeleeLevel;
 
 	// Private "base stats" Members
 	int32 _baseMR;

zone/bot_command.cpp

@@ -1350,6 +1350,7 @@ int bot_command_init(void)
 		bot_command_add("botreport", "Orders a bot to report its readiness", 0, bot_subcommand_bot_report) ||
 		bot_command_add("botspawn", "Spawns a created bot", 0, bot_subcommand_bot_spawn) ||
 		bot_command_add("botstance", "Changes the stance of a bot", 0, bot_subcommand_bot_stance) ||
+		bot_command_add("botstopmeleelevel", "Sets the level a caster or spell-casting fighter bot will stop melee combat", 0, bot_subcommand_bot_stop_melee_level) ||
 		bot_command_add("botsummon", "Summons bot(s) to your location", 0, bot_subcommand_bot_summon) ||
 		bot_command_add("bottattoo", "Changes the Drakkin tattoo of a bot", 0, bot_subcommand_bot_tattoo) ||
 		bot_command_add("bottogglearcher", "Toggles a archer bot between melee and ranged weapon use", 0, bot_subcommand_bot_toggle_archer) ||
@@ -2605,6 +2606,7 @@ void bot_command_bot(Client *c, const Seperator *sep)
 	subcommand_list.push_back("botreport");
 	subcommand_list.push_back("botspawn");
 	subcommand_list.push_back("botstance");
+	subcommand_list.push_back("botstopmeleelevel");
 	subcommand_list.push_back("botsummon");
 	subcommand_list.push_back("bottogglearcher");
 	subcommand_list.push_back("bottogglehelm");
@@ -4792,7 +4794,7 @@ void bot_subcommand_bot_list(Client *c, const Seperator *sep)
 		return;
 	if (helper_is_help_or_usage(sep->arg[1])) {
 		c->Message(m_usage, "usage: %s ([class] [value]) ([race] [value]) ([name] [partial-full])", sep->arg[0]);
-		c->Message(m_note, "Note: filter criteria is orderless and optional");
+		c->Message(m_note, "note: filter criteria is orderless and optional");
 		return;
 	}
 
@@ -5126,6 +5128,53 @@ void bot_subcommand_bot_stance(Client *c, const Seperator *sep)
 	}
 }
 
+void bot_subcommand_bot_stop_melee_level(Client *c, const Seperator *sep)
+{
+	if (helper_command_alias_fail(c, "bot_subcommand_bot_stop_melee_level", sep->arg[0], "botstopmeleelevel"))
+		return;
+	if (helper_is_help_or_usage(sep->arg[1])) {
+		c->Message(m_usage, "usage: <target_bot> %s [current | reset | sync | value: 0-255]", sep->arg[0]);
+		c->Message(m_note, "note: Only caster and spell-casting fighter class bots may be modified");
+		c->Message(m_note, "note: Use [reset] to set stop melee level to server rule");
+		c->Message(m_note, "note: Use [sync] to set stop melee level to current bot level");
+		return;
+	}
+
+	auto my_bot = ActionableBots::AsTarget_ByBot(c);
+	if (!my_bot) {
+		c->Message(m_fail, "You must <target> a bot that you own to use this command");
+		return;
+	}
+	if (!IsCasterClass(my_bot->GetClass()) && !IsSpellFighterClass(my_bot->GetClass())) {
+		c->Message(m_fail, "You must <target> a caster or spell-casting fighter class bot to use this command");
+		return;
+	}
+
+	uint8 sml = RuleI(Bots, CasterStopMeleeLevel);
+
+	if (sep->IsNumber(1)) {
+		sml = atoi(sep->arg[1]);
+	}
+	else if (!strcasecmp(sep->arg[1], "sync")) {
+		sml = my_bot->GetLevel();
+	}
+	else if (!strcasecmp(sep->arg[1], "current")) {
+		c->Message(m_message, "My current melee stop level is %u", my_bot->GetStopMeleeLevel());
+		return;
+	}
+	else if (strcasecmp(sep->arg[1], "reset")) {
+		c->Message(m_fail, "A [current] or [reset] argument, or numeric [value] is required to use this command");
+		return;
+	}
+	// [reset] falls through with initialization value
+
+	my_bot->SetStopMeleeLevel(sml);
+	if (!botdb.SaveStopMeleeLevel(c->CharacterID(), my_bot->GetBotID(), sml))
+		c->Message(m_fail, "%s for '%s'", BotDatabase::fail::SaveStopMeleeLevel(), my_bot->GetCleanName());
+
+	c->Message(m_action, "Successfully set stop melee level for %s to %u", my_bot->GetCleanName(), sml);
+}
+
 void bot_subcommand_bot_summon(Client *c, const Seperator *sep)
 {
 	if (helper_command_alias_fail(c, "bot_subcommand_bot_summon", sep->arg[0], "botsummon"))

zone/bot_command.h

@@ -612,6 +612,7 @@ void bot_subcommand_bot_out_of_combat(Client *c, const Seperator *sep);
 void bot_subcommand_bot_report(Client *c, const Seperator *sep);
 void bot_subcommand_bot_spawn(Client *c, const Seperator *sep);
 void bot_subcommand_bot_stance(Client *c, const Seperator *sep);
+void bot_subcommand_bot_stop_melee_level(Client *c, const Seperator *sep);
 void bot_subcommand_bot_summon(Client *c, const Seperator *sep);
 void bot_subcommand_bot_tattoo(Client *c, const Seperator *sep);
 void bot_subcommand_bot_toggle_archer(Client *c, const Seperator *sep);

zone/bot_database.cpp

@@ -340,7 +340,8 @@ bool BotDatabase::LoadBot(const uint32 bot_id, Bot*& loaded_bot)
 		" `disease`,"			/* not in-use[41] */
 		" `corruption`,"		/* not in-use[42] */
 		" `show_helm`," // 43
-		" `follow_distance`" // 44
+		" `follow_distance`," // 44
+		" `stop_melee_level`" // 45
 		" FROM `bot_data`"
 		" WHERE `bot_id` = '%u'"
 		" LIMIT 1",
@@ -397,13 +398,16 @@ bool BotDatabase::LoadBot(const uint32 bot_id, Bot*& loaded_bot)
 	loaded_bot = new Bot(bot_id, atoi(row[0]), atoi(row[1]), atof(row[14]), atoi(row[6]), tempNPCStruct);
 	if (loaded_bot) {
 		loaded_bot->SetShowHelm((atoi(row[43]) > 0 ? true : false));
+
 		uint32 bfd = atoi(row[44]);
 		if (bfd < 1)
 			bfd = 1;
 		if (bfd > BOT_FOLLOW_DISTANCE_DEFAULT_MAX)
 			bfd = BOT_FOLLOW_DISTANCE_DEFAULT_MAX;
 		loaded_bot->SetFollowDistance(bfd);
-		
+
+		uint8 sml = atoi(row[45]);
+		loaded_bot->SetStopMeleeLevel(sml);
 	}
 
 	return true;
@@ -457,7 +461,8 @@ bool BotDatabase::SaveNewBot(Bot* bot_inst, uint32& bot_id)
 		" `disease`,"
 		" `corruption`,"
 		" `show_helm`,"
-		" `follow_distance`"
+		" `follow_distance`,"
+		" `stop_melee_level`"
 		")"
 		" VALUES ("
 		"'%u',"					/* owner_id */
@@ -501,7 +506,8 @@ bool BotDatabase::SaveNewBot(Bot* bot_inst, uint32& bot_id)
 		" '%i',"				/* disease */
 		" '%i',"				/* corruption */
 		" '1',"					/* show_helm */
-		" '%i'"					/* follow_distance */
+		" '%i',"				/* follow_distance */
+		" '%u'"					/* stop_melee_level */
 		")",
 		bot_inst->GetBotOwnerCharacterID(),
 		bot_inst->GetBotSpellID(),
@@ -540,7 +546,8 @@ bool BotDatabase::SaveNewBot(Bot* bot_inst, uint32& bot_id)
 		bot_inst->GetPR(),
 		bot_inst->GetDR(),
 		bot_inst->GetCorrup(),
-		BOT_FOLLOW_DISTANCE_DEFAULT
+		BOT_FOLLOW_DISTANCE_DEFAULT,
+		(IsCasterClass(bot_inst->GetClass()) ? (uint8)RuleI(Bots, CasterStopMeleeLevel) : 255)
 	);
 	auto results = QueryDatabase(query);
 	if (!results.Success())
@@ -599,7 +606,8 @@ bool BotDatabase::SaveBot(Bot* bot_inst)
 		" `disease` = '%i',"
 		" `corruption` = '%i',"
 		" `show_helm` = '%i',"
-		" `follow_distance` = '%i'"
+		" `follow_distance` = '%i',"
+		" `stop_melee_level` = '%u'"
 		" WHERE `bot_id` = '%u'",
 		bot_inst->GetBotOwnerCharacterID(),
 		bot_inst->GetBotSpellID(),
@@ -641,6 +649,7 @@ bool BotDatabase::SaveBot(Bot* bot_inst)
 		bot_inst->GetBaseCorrup(),
 		((bot_inst->GetShowHelm()) ? (1) : (0)),
 		bot_inst->GetFollowDistance(),
+		bot_inst->GetStopMeleeLevel(),
 		bot_inst->GetBotID()
 	);
 	auto results = QueryDatabase(query);
@@ -2026,7 +2035,8 @@ bool BotDatabase::CreateCloneBot(const uint32 owner_id, const uint32 bot_id, con
 		" `disease`,"
 		" `corruption`,"
 		" `show_helm`,"
-		" `follow_distance`"
+		" `follow_distance`,"
+		" `stop_melee_level`"
 		")"
 		" SELECT"
 		" bd.`owner_id`,"
@@ -2073,7 +2083,8 @@ bool BotDatabase::CreateCloneBot(const uint32 owner_id, const uint32 bot_id, con
 		" bd.`disease`,"
 		" bd.`corruption`,"
 		" bd.`show_helm`,"
-		" bd.`follow_distance`"
+		" bd.`follow_distance`,"
+		" bd.`stop_melee_level`"
 		" FROM `bot_data` bd"
 		" WHERE"
 		" bd.`owner_id` = '%u'"
@@ -2153,6 +2164,27 @@ bool BotDatabase::CreateCloneBotInventory(const uint32 owner_id, const uint32 bo
 	return true;
 }
 
+bool BotDatabase::SaveStopMeleeLevel(const uint32 owner_id, const uint32 bot_id, const uint8 sml_value)
+{
+	if (!owner_id || !bot_id)
+		return false;
+
+	query = StringFormat(
+		"UPDATE `bot_data`"
+		" SET `stop_melee_level` = '%u'"
+		" WHERE `owner_id` = '%u'"
+		" AND `bot_id` = '%u'",
+		sml_value,
+		owner_id,
+		bot_id
+	);
+	auto results = QueryDatabase(query);
+	if (!results.Success())
+		return false;
+
+	return true;
+}
+
 
 /* Bot bot-group functions   */
 bool BotDatabase::QueryBotGroupExistence(const std::string& group_name, bool& extant_flag)
@@ -2852,6 +2884,7 @@ const char* BotDatabase::fail::SaveFollowDistance() { return "Failed to save fol
 const char* BotDatabase::fail::SaveAllFollowDistances() { return "Failed to save all follow distances"; }
 const char* BotDatabase::fail::CreateCloneBot() { return "Failed to create clone bot"; }
 const char* BotDatabase::fail::CreateCloneBotInventory() { return "Failed to create clone bot inventory"; }
+const char* BotDatabase::fail::SaveStopMeleeLevel() { return "Failed to save stop melee level"; }
 
 /* fail::Bot bot-group functions   */
 const char* BotDatabase::fail::QueryBotGroupExistence() { return "Failed to query bot-group existence"; }

zone/bot_database.h

@@ -143,6 +143,8 @@ public:
 	bool CreateCloneBot(const uint32 owner_id, const uint32 bot_id, const std::string& clone_name, uint32& clone_id);
 	bool CreateCloneBotInventory(const uint32 owner_id, const uint32 bot_id, const uint32 clone_id);
 
+	bool SaveStopMeleeLevel(const uint32 owner_id, const uint32 bot_id, const uint8 sml_value);
+
 
 	/* Bot bot-group functions   */
 	bool QueryBotGroupExistence(const std::string& botgroup_name, bool& extant_flag);
@@ -253,6 +255,7 @@ public:
 		static const char* SaveAllFollowDistances();
 		static const char* CreateCloneBot();
 		static const char* CreateCloneBotInventory();
+		static const char* SaveStopMeleeLevel();
 
 		/* fail::Bot bot-group functions   */
 		static const char* QueryBotGroupExistence();