Merge pull request #137 from kgiesing/fix-objective-random-tagged-poi-goto-sdx-localization

Custom quest objective fixes

Author: SphereII

Mods/0-SCore/Config/Localization.txt

@@ -118,6 +118,10 @@ xuiPersonalSettings,"Personal Settings","","Persönliche Einstellungen","Лич
 xuiSCoreUtilsAutoRedeemChallenges,"Auto Redeem Challenges","","Herausforderungen automatisch einlösen","Автоматически выполнять испытания"
 xuiSCoreUtilsAutoRedeemChallengesToolTip,"Auto Redeem Challenges as they complete.","","Löst Herausforderungen automatisch ein, sobald sie abgeschlossen sind.","Автоматически выполнять испытания по мере их завершения."
 ObjectiveBuffSDX_keyword,"Get","","Erhalten","Получить"
+ObjectiveGotoPOISDX,"Head to Rally Point:","Se rendre au point de ralliement :","Begib dich zum Sammelpunkt:","Направиться к точке сбора:"
+ObjectiveRandomGotoSDX,"Head to Rally Point:","Se rendre au point de ralliement :","Begib dich zum Sammelpunkt:","Направиться к точке сбора:"
+ObjectiveRandomPOIGotoSDX,"Head to Rally Point:","Se rendre au point de ralliement :","Begib dich zum Sammelpunkt:","Направиться к точке сбора:"
+ObjectiveRandomTaggedPOIGotoSDX,"Head to Rally Point:","Se rendre au point de ralliement :","Begib dich zum Sammelpunkt:","Направиться к точке сбора:"
 ItemCannotBePlaced,"This item cannot go into this slot.","","Dieser Gegenstand kann nicht in diesen Slot gelegt werden.","Этот предмет нельзя поместить в этот слот."
 npcNoStorage,"NPCs Cannot Be Placed In Storage.","","NSCs können nicht im Lager platziert werden.","NPC нельзя поместить в хранилище."
 buffFreshnessSCoreName,"Fresh Food","","Frisches Essen","Свежая еда"

Mods/0-SCore/Scripts/NetPackage/NetPackageRandomTaggedPOIGotoSDX.cs

@@ -87,7 +87,7 @@ public override void ProcessPackage(World _world, GameManager _callbacks)
                         includeTags,
                         excludeTags,
                         // The values used in vanilla are the square of the distance; adjusted here
-                        minSearchDistance >= 0 ? minSearchDistance : 50,
+                        minSearchDistance >= 0 ? minSearchDistance : 32,
                         maxSearchDistance >= 0 ? maxSearchDistance : 2000,
                         usedPoiLocations,
                         entityId,

Mods/0-SCore/Scripts/Quests/ObjectiveGotoPOISDX.cs

@@ -14,23 +14,18 @@ internal class ObjectiveGotoPOISDX : ObjectiveRandomPOIGoto
 
     public override bool useUpdateLoop => true;
 
+    public override void SetupObjective()
+    {
+        keyword = Localization.Get("ObjectiveGotoPOISDX");
+    }
+
     public override BaseObjective Clone()
     {
         var objectiveGotoPOI = new ObjectiveGotoPOISDX();
         CopyValues(objectiveGotoPOI);
         objectiveGotoPOI.strPOIname = strPOIname;
         return objectiveGotoPOI;
     }
-
-
-    private void SetDistanceOffset(Vector3 POISize)
-    {
-        if (POISize.x > POISize.z)
-            distanceOffset = POISize.x;
-        else
-            distanceOffset = POISize.z;
-    }
-
 
     public override Vector3 GetPosition(EntityNPC ownerNPC = null, EntityPlayer entityPlayer = null, List<Vector2> usedPOILocations = null, int entityIDforQuests = -1)
     {

Mods/0-SCore/Scripts/Quests/ObjectiveRandomGotoSDX.cs

@@ -18,7 +18,7 @@ public override BaseObjective.ObjectiveValueTypes ObjectiveValueType
 	// Token: 0x06003857 RID: 14423 RVA: 0x001839B8 File Offset: 0x00181BB8
 	public override void SetupObjective()
 	{
-		this.keyword = Localization.Get("ObjectiveRallyPointHeadTo");
+		this.keyword = Localization.Get("ObjectiveRandomGotoSDX");
 		this.SetupIcon();
 	}
 

Mods/0-SCore/Scripts/Quests/ObjectiveRandomPOIGotoSDX.cs

@@ -9,7 +9,7 @@ public class ObjectiveRandomPOIGotoSDX : ObjectiveGoto
 	public override void SetupObjective()
 	{
 		//Log.Out("ObjectiveRandomPOIGotoSDX-SetupObjective");
-		this.keyword = Localization.Get("ObjectiveRallyPointHeadTo");
+		this.keyword = Localization.Get("ObjectiveRandomPOIGotoSDX");
 	}
 
 	// Token: 0x0600386E RID: 14446 RVA: 0x00184429 File Offset: 0x00182629

Mods/0-SCore/Scripts/Quests/ObjectiveRandomTaggedPOIGotoSDX.cs

@@ -52,6 +52,15 @@ public class ObjectiveRandomTaggedPOIGotoSDX : ObjectiveRandomPOIGoto
     /// </summary>
     public float MaxSearchDistance { get; internal set; } = -1;
 
+    /// <summary>
+    /// Sets up the quest objective.
+    /// </summary>
+    public override void SetupObjective()
+    {
+        base.SetupObjective();
+        keyword = Localization.Get("ObjectiveRandomTaggedPOIGotoSDX");
+    }
+
     /// <summary>
     /// Parses additional properties from the dynamic properties.
     /// </summary>
@@ -155,7 +164,7 @@ public override Vector3 GetPosition(
                     IncludeTags,
                     ExcludeTags,
                     // The values used in vanilla are the square of the distance; adjusted here
-                    MinSearchDistance >= 0 ? MinSearchDistance : 50,
+                    MinSearchDistance >= 0 ? MinSearchDistance : 32,
                     MaxSearchDistance >= 0 ? MaxSearchDistance : 2000,
                     usedPoiLocations,
                     entityIdForQuests,
@@ -195,7 +204,7 @@ public override Vector3 GetPosition(
 
                 OwnerQuest.QuestPrefab = prefabInstance;
 
-                OwnerQuest.DataVariables.Add("POIName", OwnerQuest.QuestPrefab.location.Name);
+                OwnerQuest.DataVariables.Add("POIName", Localization.Get(OwnerQuest.QuestPrefab.location.Name));
 
                 if (usedPoiLocations != null)
                 {
@@ -230,6 +239,11 @@ public override Vector3 GetPosition(
         return Vector3.zero;
     }
 
+    /// <summary>
+    /// Converts a 2D location representing the center of a prefab to a 3D position in the world.
+    /// </summary>
+    /// <param name="prefabCenter"></param>
+    /// <returns></returns>
     public static Vector3 PrefabCenterToPosition(Vector2 prefabCenter)
     {
         // Since the center is a 2D vector, its "y" is actually the z-axis position
@@ -245,9 +259,9 @@ public static Vector3 PrefabCenterToPosition(Vector2 prefabCenter)
     /// <returns></returns>
     public override BaseObjective Clone()
     {
-        var objectiveRandomPOIGoto = new ObjectiveRandomTaggedPOIGotoSDX();
-        CopyValues(objectiveRandomPOIGoto);
-        return objectiveRandomPOIGoto;
+        var objective = new ObjectiveRandomTaggedPOIGotoSDX();
+        CopyValues(objective);
+        return objective;
     }
 
     /// <summary>
@@ -262,20 +276,12 @@ public override void CopyValues(BaseObjective objective)
         obj.ExcludeTags = ExcludeTags;
         obj.MinSearchDistance = MinSearchDistance;
         obj.MaxSearchDistance = MaxSearchDistance;
-    }
-
-    /// <summary>
-    /// Copied verbatim from ObjectiveRandomPOIGoto, made protected so any future subclasses won't
-    /// have to do the same thing.
-    /// </summary>
-    /// <param name="poiSize"></param>
-    protected void SetDistanceOffset(Vector3 poiSize)
-    {
-        if (poiSize.x > poiSize.z)
-        {
-            distanceOffset = poiSize.x;
-            return;
-        }
-        distanceOffset = poiSize.z;
+        // These values are copied in ObjectiveRandomPOIGoto.Clone, and this class can't call that
+        // base class method because it creates the wrong object type. So, copy the values here.
+        obj.poiTier = poiTier;
+        obj.distance = distance;
+        obj.biomeFilterType = biomeFilterType;
+        obj.biomeFilter = biomeFilter;
+        obj.locationName = locationName;
     }
 }

Mods/0-SCore/Scripts/Quests/QuestUtils.cs

@@ -129,26 +129,27 @@ public static PrefabInstance GetRandomPOINearTrader(
         BiomeFilterTypes biomeFilterType = BiomeFilterTypes.AnyBiome,
         string biomeFilter = "")
     {
-        var world = GameManager.Instance.World;
+        var current = QuestEventManager.Current;
+        var gameRandom = GameManager.Instance.World.GetGameRandom();
+        var distanceIndex = trader.PreferredDistanceIndex;
+        var distanceIndexes = GetDistanceIndexes(minSearchDistance, maxSearchDistance);
+        for (var i = 0; i < 3; i++)
+        {
+            distanceIndex %= 3;
 
-        var minDistanceTier = minSearchDistance < 0 ? 0 : GetTraderPrefabListTier(minSearchDistance);
-        var maxDistanceTier = maxSearchDistance < 0 ? 2 : GetTraderPrefabListTier(maxSearchDistance);
+            if (!distanceIndexes.Contains(distanceIndex))
+            {
+                distanceIndex++;
+                continue;
+            }
 
-        for (var distanceTier = minDistanceTier; distanceTier <= maxDistanceTier; distanceTier++)
-        {
-           var prefabsForTrader = QuestEventManager.Current.GetPrefabsForTrader(
-                trader.traderArea,
-                difficulty,
-                distanceTier,
-                world.GetGameRandom());
-
-           if (prefabsForTrader == null) continue;
-           // GetPrefabsForTrader shuffles the prefabs before returning them, so we can just
-            // iterate through the list and still send players to "random" POIs
-            for (var j = 0; j < prefabsForTrader.Count; j++)
+            var prefabsForTrader = current.GetPrefabsForTrader(trader.traderArea, difficulty, distanceIndex, gameRandom);
+            if (prefabsForTrader != null)
             {
-                var prefabInstance = prefabsForTrader[j];
-                if (ValidPrefabForQuest(
+                for (var j = 0; j < prefabsForTrader.Count; j++)
+                {
+                    PrefabInstance prefabInstance = prefabsForTrader[j];
+                    if (ValidPrefabForQuest(
                         trader,
                         prefabInstance,
                         questTag,
@@ -160,15 +161,85 @@ public static PrefabInstance GetRandomPOINearTrader(
                         biomeFilter,
                         minSearchDistance,
                         maxSearchDistance))
-                {
-                    return prefabInstance;
+                    {
+                        return prefabInstance;
+                    }
                 }
             }
+
+            distanceIndex++;
         }
 
         return null;
     }
 
+    /// <summary>
+    /// <para>
+    /// Takes the minumum and maximum search distances, and returns the vanilla distance indexes
+    /// that are compatible with those search distances. It is meant to avoid searching through
+    /// lists of POIs by distance index, if none of those POIs can be within range.
+    /// </para>
+    /// <para>
+    /// <list type="table">
+    ///     <listheader>
+    ///         <term>index</term>
+    ///         <description>distance range</description>
+    ///     </listheader>
+    ///     <item>
+    ///         <term>0</term>
+    ///         <description>0 - 500</description>
+    ///     </item>
+    ///     <item>
+    ///         <term>1</term>
+    ///         <description>501 - 1500</description>
+    ///     </item>
+    ///     <item>
+    ///         <term>2</term>
+    ///         <description>1501+</description>
+    ///     </item>
+    /// </list>
+    /// Taken from <see cref="QuestEventManager.SetupTraderPrefabList"/>
+    /// </para>
+    /// </summary>
+    /// <param name="minSearchDistance">Minimum search distance, in blocks/meters</param>
+    /// <param name="maxSearchDistance">Maximum search distance, in blocks/meters</param>
+    /// <returns></returns>
+    public static List<int> GetDistanceIndexes(float minSearchDistance, float maxSearchDistance)
+    {
+        var allIndexes = new List<int> { 0, 1, 2 };
+
+        if (minSearchDistance > maxSearchDistance)
+        {
+            // Invalid entries. Just use the vanilla indexes.
+            return allIndexes;
+        }
+
+        if (minSearchDistance < 0  && maxSearchDistance < 0)
+        {
+            // No min or max specified. Use the vanilla indexes.
+            return allIndexes;
+        }
+
+        if (minSearchDistance <= 500f && maxSearchDistance > 1500f)
+        {
+            // This is within the entire range of vanilla indexes.
+            return allIndexes;
+        }
+
+        // Remove the indexes according to the min and max distance.
+        if (minSearchDistance > 500f)
+            allIndexes.Remove(0);
+        if (minSearchDistance > 1500f)
+            allIndexes.Remove(1);
+
+        if (maxSearchDistance >= 0 && maxSearchDistance <= 1500f)
+            allIndexes.Remove(2);
+        if (maxSearchDistance >= 0 && maxSearchDistance <= 500f)
+            allIndexes.Remove(1);
+
+        return allIndexes;
+    }
+
     /// <summary>
     /// Gets a random POI near an entity's position. This is meant to be a replacement for
     /// <see cref="DynamicPrefabDecorator.GetRandomPOINearWorldPos"/>
@@ -290,14 +361,14 @@ public static bool ValidPrefabForQuest(
             return false;
         }
 
-        //if (!prefab.prefab.GetQuestTag(questTag))
-        //{
-        //    if (LoggingEnabled)
-        //    {
-        //        Log.Out($"Quest {questTag}: Prefab {prefab.name} does not have quest tag {questTag}");
-        //    }
-        //    return false;
-        //}
+        if (!questTag.IsEmpty && !prefab.prefab.GetQuestTag(questTag))
+        {
+            if (LoggingEnabled)
+            {
+                Log.Out($"Quest {questTag}: Prefab {prefab.name} does not have quest tag {questTag}");
+            }
+            return false;
+        }
 
         Vector2 poiLocation = new Vector2(prefab.boundingBoxPosition.x, prefab.boundingBoxPosition.z);
 
@@ -310,7 +381,7 @@ public static bool ValidPrefabForQuest(
             return false;
         }
 
-        QuestEventManager.POILockoutReasonTypes lockoutReason = QuestEventManager.Current.CheckForPOILockouts(entityIdForQuests, poiLocation, out var num);
+        QuestEventManager.POILockoutReasonTypes lockoutReason = QuestEventManager.Current.CheckForPOILockouts(entityIdForQuests, poiLocation, out _);
 
         if (lockoutReason != QuestEventManager.POILockoutReasonTypes.None)
         {