-Help fix/update: Added a few help texts, fixed and ran sql generation.

cmangos · Sep 20, 2024 · 8c04f6b · 8c04f6b
1 parent a50e46a
commit 8c04f6b
Show file tree

Hide file tree

Showing 13 changed files with 1,673 additions and 1,066 deletions.
diff --git a/botpch.h b/botpch.h
@@ -13,8 +13,4 @@
 #include "Globals/ObjectMgr.h"
 #include "DBScripts/ScriptMgr.h"
 
-#include "playerbot/playerbot.h"
-
-#ifndef GenerateBotHelp
-//#define GenerateBotHelp //Enable only for help generation
-#endif
+#include "playerbot/playerbot.h"
diff --git a/playerbot/ChatFilter.cpp b/playerbot/ChatFilter.cpp
@@ -155,7 +155,7 @@ class RoleChatFilter : public ChatFilter
     virtual std::string GetHelpName() {
         return "role";
     }
-    virtual std::unordered_map<std::string,string> GetFilterExamples() 
+    virtual std::unordered_map<std::string,std::string> GetFilterExamples() 
     {
         std::unordered_map<std::string, std::string> retMap;
         retMap["@tank"] = "All bots that have a tank spec.";

diff --git a/playerbot/PlayerbotAIAware.h b/playerbot/PlayerbotAIAware.h
@@ -1,6 +1,10 @@
 #pragma once
 #include <string>
 
+#ifndef GenerateBotHelp
+//#define GenerateBotHelp //Enable only for help generation
+#endif
+
 class PlayerbotAI;
 
 namespace ai

diff --git a/playerbot/PlayerbotHelpMgr.cpp b/playerbot/PlayerbotHelpMgr.cpp
@@ -63,7 +63,7 @@ std::string PlayerbotHelpMgr::makeList(std::vector<std::string>const parts, std:
 }
 
 #ifdef GenerateBotHelp
-string PlayerbotHelpMgr::formatFloat(float num)
+std::string PlayerbotHelpMgr::formatFloat(float num)
 {
     std::ostringstream out;
     out << std::fixed << std::setprecision(3);
@@ -90,12 +90,12 @@ bool PlayerbotHelpMgr::IsGenericSupported(PlayerbotAIAware* object)
     return supported.find(name) != supported.end();
 }
 
-string PlayerbotHelpMgr::GetObjectName(PlayerbotAIAware* object, std::string className)
+std::string PlayerbotHelpMgr::GetObjectName(PlayerbotAIAware* object, std::string className)
 {
     return IsGenericSupported(object) ? object->getName() : className + " " + object->getName();
 }
 
-string PlayerbotHelpMgr::GetObjectLink(PlayerbotAIAware* object, std::string className)
+std::string PlayerbotHelpMgr::GetObjectLink(PlayerbotAIAware* object, std::string className)
 {
     std::string prefix = "unkown";
     if (dynamic_cast<Strategy*>(object))
@@ -235,7 +235,7 @@ void PlayerbotHelpMgr::LoadAllStrategies()
     }
 }
 
-string PlayerbotHelpMgr::GetStrategyBehaviour(std::string className, Strategy* strategy)
+std::string PlayerbotHelpMgr::GetStrategyBehaviour(std::string className, Strategy* strategy)
 {
     std::string behavior;
 
@@ -328,7 +328,7 @@ void PlayerbotHelpMgr::GenerateStrategyHelp()
     }
 }
 
-string PlayerbotHelpMgr::GetTriggerBehaviour(std::string className, Trigger* trigger)
+std::string PlayerbotHelpMgr::GetTriggerBehaviour(std::string className, Trigger* trigger)
 {
     std::string behavior;
 
@@ -441,7 +441,7 @@ void PlayerbotHelpMgr::GenerateTriggerHelp()
     }
 }
 
-string PlayerbotHelpMgr::GetActionBehaviour(std::string className, Action* nextAction)
+std::string PlayerbotHelpMgr::GetActionBehaviour(std::string className, Action* nextAction)
 {
     std::string behavior;
 

diff --git a/playerbot/strategy/actions/AcceptBattleGroundInvitationAction.h b/playerbot/strategy/actions/AcceptBattleGroundInvitationAction.h
@@ -25,6 +25,18 @@ namespace ai
          ai->ResetStrategies();*/
          return true;
       }
+
+#ifdef GenerateBotHelp
+      virtual std::string GetHelpName() { return "accept bg invitation"; } //Must equal iternal name
+      virtual std::string GetHelpDescription()
+      {
+          return "This action clicks the accept button when invited to join a bg.\n"
+              "After joining the bg strategies are reset..\n"
+              "This action is currently disabled..";
+      }
+      virtual std::vector<std::string> GetUsedActions() { return {}; }
+      virtual std::vector<std::string> GetUsedValues() { return {}; }
+#endif 
    };
 }
 
diff --git a/playerbot/strategy/actions/AcceptDuelAction.h b/playerbot/strategy/actions/AcceptDuelAction.h
@@ -35,6 +35,18 @@ namespace ai
             ai->ResetStrategies();
             return true;
         }
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "accept duel"; } //Must equal iternal name
+        virtual std::string GetHelpDescription()
+        {
+            return "This action clicks the accept button when invited to join a bg.\n"
+                "After joining the bg strategies are reset.\n"
+                "This action is currently disabled.";
+        }
+        virtual std::vector<std::string> GetUsedActions() { return {}; }
+        virtual std::vector<std::string> GetUsedValues() { return {}; }
+#endif 
     };
 
 }
diff --git a/playerbot/strategy/actions/AcceptQuestAction.h b/playerbot/strategy/actions/AcceptQuestAction.h
@@ -12,31 +12,82 @@ namespace ai
 
     protected:
         virtual bool ProcessQuest(Player* requester, Quest const* quest, WorldObject* questGiver) override;
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "accept all quests"; } //Must equal iternal name
+        virtual std::string GetHelpDescription()
+        {
+            return "This action wil accept all quests from the npc selected by the master\n"
+                "It will use all nearby quest givers if none is selected.";
+        }
+        virtual std::vector<std::string> GetUsedActions() { return {}; }
+        virtual std::vector<std::string> GetUsedValues() { return { "nearest npcs" ,  "nearest game objects no los" }; }
+#endif 
     };
 
     class AcceptQuestAction : public AcceptAllQuestsAction 
     {
     public:
         AcceptQuestAction(PlayerbotAI* ai) : AcceptAllQuestsAction(ai, "accept quest") {}
         virtual bool Execute(Event& event);
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "accept quests"; } //Must equal iternal name
+        virtual std::string GetHelpDescription()
+        {
+            return "This action wil accept a specified quest (link or *) from any nearby quest giver.";
+        }
+        virtual std::vector<std::string> GetUsedActions() { return { }; }
+        virtual std::vector<std::string> GetUsedValues() { return { "nearest npcs" ,  "nearest game objects no los" }; }
+#endif 
     };
 
     class AcceptQuestShareAction : public Action 
     {
     public:
         AcceptQuestShareAction(PlayerbotAI* ai) : Action(ai, "accept quest share") {}
         virtual bool Execute(Event& event);
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "accept quest share"; } //Must equal iternal name
+        virtual std::string GetHelpDescription()
+        {
+            return "This action will make a bot click accept when shared a quest.";
+        }
+        virtual std::vector<std::string> GetUsedActions() { return { }; }
+        virtual std::vector<std::string> GetUsedValues() { return { }; }
+#endif 
     };
 
     class ConfirmQuestAction : public Action {
     public:
         ConfirmQuestAction(PlayerbotAI* ai) : Action(ai, "confirm quest") {}
         virtual bool Execute(Event& event);
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "confirm quest"; } //Must equal iternal name
+        virtual std::string GetHelpDescription()
+        {
+            return "This action will make a bot click accept asked to start a quest.";
+        }
+        virtual std::vector<std::string> GetUsedActions() { return { }; }
+        virtual std::vector<std::string> GetUsedValues() { return { }; }
+#endif 
     };
 
     class QuestDetailsAction : public Action {
     public:
         QuestDetailsAction(PlayerbotAI* ai) : Action(ai, "quest details") {}
         virtual bool Execute(Event& event);
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "quest details"; } //Must equal iternal name
+        virtual std::string GetHelpDescription()
+        {
+            return "This action will make a bot click accept in the quest details page.";
+        }
+        virtual std::vector<std::string> GetUsedActions() { return { }; }
+        virtual std::vector<std::string> GetUsedValues() { return { }; }
+#endif 
     };
 }
diff --git a/playerbot/strategy/actions/AcceptResurrectAction.h b/playerbot/strategy/actions/AcceptResurrectAction.h
@@ -27,6 +27,16 @@ namespace ai
 
             return false;
         }
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "accept resurrect"; } //Must equal iternal name
+        virtual std::string GetHelpDescription()
+        {
+            return "This action clicks the accept button asked if it wants to be resurrected by a player.";
+        }
+        virtual std::vector<std::string> GetUsedActions() { return {}; }
+        virtual std::vector<std::string> GetUsedValues() { return {}; }
+#endif 
     };
 
 }
diff --git a/playerbot/strategy/actions/QuestAction.h b/playerbot/strategy/actions/QuestAction.h
@@ -8,7 +8,7 @@ namespace ai
     class QuestAction : public Action 
     {
     public:
-        QuestAction(PlayerbotAI* ai, std::string name) : Action(ai, name) {}
+        QuestAction(PlayerbotAI* ai, std::string name = "quest") : Action(ai, name) {}
 
     public:
         virtual bool Execute(Event& event);

diff --git a/playerbot/strategy/generic/CombatStrategy.h b/playerbot/strategy/generic/CombatStrategy.h
@@ -40,6 +40,14 @@ namespace ai
     public:
         AvoidAoeStrategyMultiplier(PlayerbotAI* ai) : Multiplier(ai, "run away on area debuff") {}
         float GetValue(Action* action) override;
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "run away on area debuff"; } //Must equal iternal name
+        virtual std::string GetHelpDescription() {
+            return "This stops bots from casting certain (cast-time) spells when affected by an area debuf.";
+        }
+        virtual std::vector<std::string> GetRelatedStrategies() { return {}; }
+#endif
     };
 
     class WaitForAttackStrategy : public Strategy

diff --git a/playerbot/strategy/values/ActiveSpellValue.h b/playerbot/strategy/values/ActiveSpellValue.h
@@ -9,5 +9,12 @@ namespace ai
         ActiveSpellValue(PlayerbotAI* ai, std::string name = "active spell") : CalculatedValue<uint32>(ai, name) {}
 
         virtual uint32 Calculate();
+
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "active spell"; } //Must equal iternal name
+        virtual std::string GetHelpTypeName() { return "spell"; }
+        virtual std::string GetHelpDescription() { return "This value contains the spell id of the spell that the bot is currently casting."; }
+        virtual std::vector<std::string> GetUsedValues() { return {}; }
+#endif 
     };
 }
diff --git a/playerbot/strategy/values/AlwaysLootListValue.h b/playerbot/strategy/values/AlwaysLootListValue.h
@@ -11,6 +11,13 @@ namespace ai
         virtual std::string Save();
         virtual bool Load(std::string value);
 
+#ifdef GenerateBotHelp
+        virtual std::string GetHelpName() { return "always loot list"; } //Must equal iternal name
+        virtual std::string GetHelpTypeName() { return "loot"; }
+        virtual std::string GetHelpDescription() { return "This value contains a list of item ids that should always be looted."; }
+        virtual std::vector<std::string> GetUsedValues() { return {}; }
+#endif 
+
     private:
         std::set<uint32> list;
     };