Add quest plugin (#730)

Co-authored-by: Niklas G <niegoedde@gmail.com>

Application/RSBot/Views/Main.cs

@@ -9,6 +9,7 @@
 using SDUI.Controls;
 using SDUI.Helpers;
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Drawing;
 using System.Linq;
@@ -34,6 +35,8 @@ public partial class Main : UIWindow
         /// </summary>
         private string _playerName;
 
+
+        private Dictionary<string, UIWindow> _pluginWindows = new(8);
         #endregion Members
 
         #region Constructor
@@ -112,6 +115,12 @@ private void RegisterEvents()
             EventManager.SubscribeEvent("OnStopBot", OnStopBot);
             EventManager.SubscribeEvent("OnAgentServerDisconnected", OnAgentServerDisconnected);
             EventManager.SubscribeEvent("OnShowScriptRecorder", new Action<int, bool>(OnShowScriptRecorder));
+            EventManager.SubscribeEvent("OnAddSidebarElement", new Action<Control>(OnAddSidebarElement));
+        }
+
+        private void OnAddSidebarElement(Control obj)
+        {
+            pSidebarCustom.Controls.Add(obj);
         }
 
         private void OnShowScriptRecorder(int ownerId, bool startRecording)
@@ -297,25 +306,34 @@ private void PluginMenuItem_Click(object sender, EventArgs e)
             var menuItem = (ToolStripMenuItem)sender;
             var plugin = (IPlugin)menuItem.Tag;
 
-            var window = new UIWindow
+            if (!_pluginWindows.TryGetValue(plugin.InternalName, out var pluginWindow) || pluginWindow.IsDisposed)
             {
-                Text = plugin.DisplayName,
-                Name = plugin.InternalName,
-                MaximizeBox = false,
-                FormBorderStyle = FormBorderStyle.FixedDialog,
-                Icon = Icon,
-                StartPosition = FormStartPosition.CenterParent,
-                ShowTitle = true
-            };
+                pluginWindow = new UIWindow
+                {
+                    Text = plugin.DisplayName,
+                    Name = plugin.InternalName,
+                    MaximizeBox = false,
+                    FormBorderStyle = FormBorderStyle.FixedDialog,
+                    Icon = Icon,
+                    StartPosition = FormStartPosition.CenterParent,
+                    ShowTitle = true
+                };
+
+                var content = plugin.View;
+                content.Dock = DockStyle.Fill;
+
+                plugin.Translate();
 
-            var content = plugin.View;
-            content.Dock = DockStyle.Fill;
+                pluginWindow.Size = new Size(content.Size.Width + 16, content.Size.Height + 32);
+                pluginWindow.Controls.Add(content);
+
+                _pluginWindows[plugin.InternalName] = pluginWindow;
+            }
 
-            plugin.Translate();
+            if (!pluginWindow.Visible)
+                pluginWindow.Show();
 
-            window.Size = new Size(content.Size.Width + 16, content.Size.Height + 32);
-            window.Controls.Add(content);
-            window.Show();
+            pluginWindow.BringToFront();
         }
 
         /// <summary>

Library/RSBot.Core/Client/DivisionInfo.cs

@@ -72,7 +72,7 @@ internal static DivisionInfo Load()
                             Name = reader.ReadJoymaxString(),
                             GatewayServers = new List<string>()
                         };
-                        reader.ReadByte(); //Null terminator for CharacterName
+                        reader.ReadByte(); //Null terminator for NameStrID
 
                         var gatewayCount = reader.ReadByte();
 

Library/RSBot.Core/Client/ReferenceManager.cs

@@ -37,6 +37,8 @@ public class ReferenceManager
         public List<RefTeleport> TeleportData { get; } = new(256);
         public List<RefTeleportLink> TeleportLinks { get; } = new(256);
         public Dictionary<int, RefOptionalTeleport> OptionalTeleports { get; } = new(32);
+        public Dictionary<uint, RefQuestReward> QuestRewards { get; } = new(1024);
+        public List<RefQuestRewardItem> QuestRewardItems { get; } = new(1024);
         public GatewayInfo GatewayInfo { get; private set; }
         public DivisionInfo DivisionInfo { get; private set; }
         public VersionInfo VersionInfo { get; private set; }
@@ -80,9 +82,16 @@ public void Load(int languageTab)
                 () => LoadScrapOfPackageItemData("RefScrapOfPackageItem.txt"),
                 () => LoadReferenceFile("magicoption.txt", MagicOptions),
                 () => LoadReferenceFile("magicoptionassign.txt", MagicOptionAssignments),
-                () => LoadReferenceFile("refoptionalteleport.txt", OptionalTeleports)
+                () => LoadReferenceFile("refoptionalteleport.txt", OptionalTeleports),
+                () => LoadReferenceFile("refquestrewarditems.txt", QuestRewardItems),
+                () => LoadReferenceFile("refqusetreward.txt", QuestRewards)
             );
 
+            if (Game.ClientType > GameClientType.Chinese)
+                LoadConditionalData("QuestData.txt", QuestData);
+            else
+                LoadReferenceFile("questdata.txt", QuestData);
+
             if(Game.ClientType > GameClientType.Japanese_Old)
             {
                 LoadReferenceFile("refabilitybyitemoptleveldata.txt", AbilityItemByOptLevel);
@@ -657,6 +666,7 @@ public RefMagicOpt GetMagicOption(string group, byte degree)
             return MagicOptions?.FirstOrDefault(m => m.Group == group && m.Level == degree);
         }
 
+
         /// <summary>
         /// Gets a list of magic options for the specified type ids
         /// </summary>
@@ -689,5 +699,27 @@ public IEnumerable<RefExtraAbilityByEquipItemOptLevel> GetExtraAbilityItems(uint
         {
             return ExtraAbilityByEquipItemOptLevel.Where(p => p.ItemId == itemId && p.OptLevel == optLevel);
         }
+
+        /// <summary>
+        /// Gets a list of reward items for the specified quest.
+        /// </summary>
+        /// <param name="questId"></param>
+        /// <returns></returns>
+        public IEnumerable<RefQuestRewardItem> GetQuestRewardItems(uint questId)
+        {
+            return QuestRewardItems.Where(r => r.QuestId == questId);
+        }
+
+        /// <summary>
+        /// Returns the reward for the specified quest
+        /// </summary>
+        /// <param name="questId"></param>
+        /// <returns></returns>
+        public RefQuestReward GetQuestReward(uint questId)
+        {
+            QuestRewards.TryGetValue(questId, out var result);
+
+            return result;
+        }
     }
 }

Library/RSBot.Core/Client/ReferenceObjects/RefQuest.cs

@@ -1,7 +1,16 @@
-namespace RSBot.Core.Client.ReferenceObjects
+using System.Collections.Generic;
+
+namespace RSBot.Core.Client.ReferenceObjects
 {
     public class RefQuest : IReference<uint>
     {
+        #region Properties
+
+        public RefQuestReward Reward => Game.ReferenceManager.GetQuestReward(ID);
+        public IEnumerable<RefQuestRewardItem> RewardItems => Game.ReferenceManager.GetQuestRewardItems(ID);
+
+        #endregion
+
         #region Fields
 
         public byte Service;
@@ -45,6 +54,8 @@ public bool Load(ReferenceParser parser)
 
             return true;
         }
+
+        public string GetTranslatedName() => Game.ReferenceManager.GetTranslation(NameString);
     }
 }
 

Library/RSBot.Core/Client/ReferenceObjects/RefQuestReward.cs

@@ -0,0 +1,60 @@
+namespace RSBot.Core.Client.ReferenceObjects
+{
+    public class RefQuestReward : IReference<uint>
+    {
+        #region Fields
+
+        public uint QuestId;
+        public string QuestCodeName;
+        public bool IsView;
+        public bool IsBasicReward;
+        public bool IsItemReward;
+        public bool IsCheckCondition;
+        public bool IsCheckCountry;
+        public bool IsCheckClass;
+        public bool IsCheckGender;
+        public int Gold;
+        public int Exp;
+        public int SPExp;
+        public int SP;
+        public int AP;
+        public string APType;
+        public byte Hwan;
+        public byte InventorySlots;
+        public byte ItemRewardType;
+        public byte SelectionCount;
+
+        #endregion Fields
+
+        public uint PrimaryKey => QuestId;
+
+        public bool Load(ReferenceParser parser)
+        {
+            parser.TryParse(0, out QuestId);
+            parser.TryParse(1, out QuestCodeName);
+            parser.TryParse(2, out IsView);
+            parser.TryParse(3, out IsBasicReward);
+            parser.TryParse(4, out IsItemReward);
+            parser.TryParse(5, out IsCheckCondition);
+            parser.TryParse(6, out IsCheckCountry);
+            parser.TryParse(7, out IsCheckClass);
+            parser.TryParse(8, out IsCheckGender);
+
+            //9?!
+
+            parser.TryParse(10, out Gold);
+            parser.TryParse(11, out Exp);
+            parser.TryParse(12, out SPExp);
+            parser.TryParse(13, out SP);
+            parser.TryParse(14, out AP);
+            parser.TryParse(15, out APType);
+            parser.TryParse(16, out Hwan);
+            parser.TryParse(17, out InventorySlots);
+            parser.TryParse(18, out ItemRewardType);
+            parser.TryParse(19, out SelectionCount);
+
+            return true;
+        }
+    }
+}
+

Library/RSBot.Core/Client/ReferenceObjects/RefQuestRewardItem.cs

@@ -0,0 +1,38 @@
+namespace RSBot.Core.Client.ReferenceObjects
+{
+    public class RefQuestRewardItem : IReference
+    {
+        #region Fields
+
+        public uint QuestId;
+        public string QuestCodeName;
+        public byte RewardType;
+        public string ItemCodeName;
+        public string OptionalItemCode;
+        public int OptionalItemCount;
+        public int AchieveQuantity;
+        public string RentItemCodeName;
+
+        public RefObjItem Item => ItemCodeName == "xxx" ? null : Game.ReferenceManager.GetRefItem(ItemCodeName);
+
+        public RefObjItem OptionalItem => OptionalItemCode == "xxx" ? null : Game.ReferenceManager.GetRefItem(OptionalItemCode);
+        public RefObjItem RentItem => OptionalItemCode == "xxx" ? null : Game.ReferenceManager.GetRefItem(RentItemCodeName);
+
+        #endregion Fields
+
+        public bool Load(ReferenceParser parser)
+        {
+            parser.TryParse(0, out QuestId);
+            parser.TryParse(1, out QuestCodeName);
+            parser.TryParse(2, out RewardType);
+            parser.TryParse(3, out ItemCodeName);
+            parser.TryParse(4, out OptionalItemCode);
+            parser.TryParse(5, out OptionalItemCount);
+            parser.TryParse(6, out AchieveQuantity);
+            parser.TryParse(7, out RentItemCodeName);
+
+            return true;
+        }
+    }
+}
+

Library/RSBot.Core/Extensions/StringExtension.cs

@@ -0,0 +1,44 @@
+using System.Text;
+
+namespace RSBot.Core.Extensions
+{
+    public static class StringExtension
+    {
+        #region Methods
+
+        public static string JoymaxFormat<T1>(this string unformatted, T1 valA)
+        {
+            var stringBulder = new StringBuilder(unformatted);
+            stringBulder = stringBulder.Replace("%d", "%s");
+
+            stringBulder = stringBulder.Replace("%s", valA.ToString(), 0, stringBulder.ToString().IndexOf("%s") + 2);
+
+            return stringBulder.ToString();
+        }
+
+        public static string JoymaxFormat<T1, T2>(this string unformatted, T1 valA, T2 valB)
+        {
+            var stringBulder = new StringBuilder(unformatted);
+            stringBulder = stringBulder.Replace("%d", "%s");
+
+            stringBulder = stringBulder.Replace("%s", valA.ToString(), 0, stringBulder.ToString().IndexOf("%s") + 2);
+            stringBulder = stringBulder.Replace("%s", valB.ToString(), 0, stringBulder.ToString().IndexOf("%s") + 2);
+
+            return stringBulder.ToString();
+        }
+
+        public static string JoymaxFormat<T1, T2, T3>(this string unformatted, T1 valA, T2 valB, T3 valC)
+        {
+            var stringBulder = new StringBuilder(unformatted);
+            stringBulder = stringBulder.Replace("%d", "%s");
+
+            stringBulder = stringBulder.Replace("%s", valA.ToString(), 0, stringBulder.ToString().IndexOf("%s") + 2);
+            stringBulder = stringBulder.Replace("%s", valB.ToString(), 0, stringBulder.ToString().IndexOf("%s") + 2);
+            stringBulder = stringBulder.Replace("%s", valC.ToString(), 0, stringBulder.ToString().IndexOf("%s") + 2);
+
+            return stringBulder.ToString();
+        }
+
+        #endregion Methods
+    }
+}

Library/RSBot.Core/Network/Handler/Agent/Action/ActionTalkRequest.cs

@@ -1,7 +1,6 @@
 using RSBot.Core.Components;
 using RSBot.Core.Event;
 using RSBot.Core.Objects;
-using RSBot.Core.Objects.Spawn;
 
 namespace RSBot.Core.Network.Handler.Agent.Action
 {
@@ -41,6 +40,7 @@ public void Invoke(Packet packet)
             Game.Player.State.DialogState = new DialogState
             {
                 RequestedNpcId = entityId,
+                TalkOption = option
             };
 
             EventManager.FireEvent("OnTalkRequest", entityId, option);