[Quests] Cleanup Quest Parser Logic (#4025)

* [Quests] Cleanup Quest Parser Logic # Notes - Consolidate duplicated code into loops to make it easier to read and easier to add on to. # Images * Update quest_parser_collection.cpp * Push * Push * Update embperl.cpp * Push * Additional cleanup, use File::Exists utility * Range based loops * Update embparser.cpp * Cleanup * Update embparser.cpp --------- Co-authored-by: Akkadius <akkadius1@gmail.com>
2026-08-29 08:38:20 +00:00 · 2024-02-05 19:53:16 -05:00
parent 9e2afd5571
commit 331e04fbf8
7 changed files with 2472 additions and 2109 deletions
@@ -26,105 +26,262 @@
 class Client;
 class NPC;

-namespace EQ
-{
+namespace EQ {
 	class ItemInstance;
 }

 class QuestInterface {
 public:
-	virtual int EventNPC(QuestEventID evt, NPC* npc, Mob *init, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int EventGlobalNPC(QuestEventID evt, NPC* npc, Mob *init, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int EventPlayer(QuestEventID evt, Client *client, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int EventGlobalPlayer(QuestEventID evt, Client *client, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int EventItem(QuestEventID evt, Client *client, EQ::ItemInstance *item, Mob *mob, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int EventSpell(QuestEventID evt, Mob* mob, Client *client, uint32 spell_id, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int EventEncounter(QuestEventID evt, std::string encounter_name, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int EventBot(
-		QuestEventID evt,
-		Bot *bot,
-		Mob *init,
+	virtual int EventNPC(
+		QuestEventID event_id,
+		NPC* npc,
+		Mob* init,
 		std::string data,
 		uint32 extra_data,
-		std::vector<std::any> *extra_pointer
-	) {
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int EventGlobalNPC(
+		QuestEventID event_id,
+		NPC* npc,
+		Mob* init,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int EventPlayer(
+		QuestEventID event_id,
+		Client* client,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int EventGlobalPlayer(
+		QuestEventID event_id,
+		Client* client,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int EventItem(
+		QuestEventID event_id,
+		Client* client,
+		EQ::ItemInstance* inst,
+		Mob* mob,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int EventSpell(
+		QuestEventID event_id,
+		Mob* mob,
+		Client* client,
+		uint32 spell_id,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int EventEncounter(
+		QuestEventID event_id,
+		std::string encounter_name,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int EventBot(
+		QuestEventID event_id,
+		Bot* bot,
+		Mob* init,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
 		return 0;
 	}

 	virtual int EventGlobalBot(
-		QuestEventID evt,
-		Bot *bot,
-		Mob *init,
+		QuestEventID event_id,
+		Bot* bot,
+		Mob* init,
 		std::string data,
 		uint32 extra_data,
-		std::vector<std::any> *extra_pointers
-	) {
+		std::vector<std::any>* extra_pointers
+	)
+	{
 		return 0;
 	}

-	virtual bool HasQuestSub(uint32 npcid, QuestEventID evt) { return false; }
-	virtual bool HasGlobalQuestSub(QuestEventID evt) { return false; }
-	virtual bool PlayerHasQuestSub(QuestEventID evt) { return false; }
-	virtual bool GlobalPlayerHasQuestSub(QuestEventID evt) { return false; }
-	virtual bool SpellHasQuestSub(uint32 spell_id, QuestEventID evt) { return false; }
-	virtual bool ItemHasQuestSub(EQ::ItemInstance *itm, QuestEventID evt) { return false; }
-	virtual bool EncounterHasQuestSub(std::string encounter_name, QuestEventID evt) { return false; }
-	virtual bool HasEncounterSub(const std::string& package_name, QuestEventID evt) { return false; }
-	virtual bool BotHasQuestSub(QuestEventID evt) { return false; }
-	virtual bool GlobalBotHasQuestSub(QuestEventID evt) { return false; }
+	virtual bool HasQuestSub(uint32 npc_id, QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool HasGlobalQuestSub(QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool PlayerHasQuestSub(QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool GlobalPlayerHasQuestSub(QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool SpellHasQuestSub(uint32 spell_id, QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool ItemHasQuestSub(EQ::ItemInstance* itm, QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool EncounterHasQuestSub(std::string encounter_name, QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool HasEncounterSub(const std::string& package_name, QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool BotHasQuestSub(QuestEventID event_id)
+	{
+		return false;
+	}
+
+	virtual bool GlobalBotHasQuestSub(QuestEventID event_id)
+	{
+		return false;
+	}

 	virtual void LoadNPCScript(std::string filename, int npc_id) { }
 	virtual void LoadGlobalNPCScript(std::string filename) { }
 	virtual void LoadPlayerScript(std::string filename) { }
 	virtual void LoadGlobalPlayerScript(std::string filename) { }
-	virtual void LoadItemScript(std::string filename, EQ::ItemInstance *item) { }
+	virtual void LoadItemScript(std::string filename, EQ::ItemInstance* inst) { }
 	virtual void LoadSpellScript(std::string filename, uint32 spell_id) { }
 	virtual void LoadEncounterScript(std::string filename, std::string encounter_name) { }
 	virtual void LoadBotScript(std::string filename) { }
 	virtual void LoadGlobalBotScript(std::string filename) { }

-	virtual int DispatchEventNPC(QuestEventID evt, NPC* npc, Mob *init, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int DispatchEventPlayer(QuestEventID evt, Client *client, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int DispatchEventItem(QuestEventID evt, Client *client, EQ::ItemInstance *item, Mob *mob, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int DispatchEventSpell(QuestEventID evt, Mob* mob, Client *client, uint32 spell_id, std::string data, uint32 extra_data,
-		std::vector<std::any> *extra_pointers) { return 0; }
-	virtual int DispatchEventBot(
-		QuestEventID evt,
-		Bot *bot,
-		Mob *init,
+	virtual int DispatchEventNPC(
+		QuestEventID event_id,
+		NPC* npc,
+		Mob* init,
 		std::string data,
 		uint32 extra_data,
-		std::vector<std::any> *extra_pointers
-	) {
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int DispatchEventPlayer(
+		QuestEventID event_id,
+		Client* client,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int DispatchEventItem(
+		QuestEventID event_id,
+		Client* client,
+		EQ::ItemInstance* inst,
+		Mob* mob,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int DispatchEventSpell(
+		QuestEventID event_id,
+		Mob* mob,
+		Client* client,
+		uint32 spell_id,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
+		return 0;
+	}
+
+	virtual int DispatchEventBot(
+		QuestEventID event_id,
+		Bot* bot,
+		Mob* init,
+		std::string data,
+		uint32 extra_data,
+		std::vector<std::any>* extra_pointers
+	)
+	{
 		return 0;
 	}

 	virtual void AddVar(std::string name, std::string val) { }
-	virtual std::string GetVar(std::string name) { return std::string(); }
+	virtual std::string GetVar(std::string name)
+	{
+		return std::string();
+	}
 	virtual void Init() { }
 	virtual void ReloadQuests() { }
 	virtual uint32 GetIdentifier() = 0;
-	virtual void RemoveEncounter(const std::string &name) { }
+	virtual void RemoveEncounter(const std::string& name) { }

-	virtual void GetErrors(std::list<std::string> &quest_errors) {
+	virtual void GetErrors(std::list<std::string>& quest_errors)
+	{
 		quest_errors.insert(quest_errors.end(), errors_.begin(), errors_.end());
 	}

-	virtual void AddError(std::string error) {
+	virtual void AddError(std::string error)
+	{
 		LogQuests("{}", error);
 		LogQuestErrors("{}", Strings::Trim(error));

 		errors_.push_back(error);
+
 		if (errors_.size() > RuleI(World, MaximumQuestErrors)) {
 			errors_.pop_front();
 		}