Core: PathSettings: Id can be specified by the user.

Core: RequirementFactory: Be able to use  'PathDist' Requirement for local context.

Author: Xian55

Core/ClassConfig/ClassConfiguration.cs

@@ -150,6 +150,11 @@ public void Initialise(IServiceProvider sp, Dictionary<int, string> overridePath
             settings.Init(globalTime, playerReader, i);
         }
 
+        if (Paths.Select(x => x.Id).Distinct().Count() != Paths.Length)
+        {
+            throw new ArgumentException("One ore more PathSettings share the same Id. Must be unique!");
+        }
+
         RequirementFactory factory = new(sp, this);
 
         var baseActionKeys = GetByType<KeyAction>();

Core/ClassConfig/PathSettings.cs

@@ -44,7 +44,7 @@ public void Init(RecordInt globalTime, PlayerReader playerReader, int id)
     {
         this.globalTime = globalTime;
         this.playerReader = playerReader;
-        Id = id;
+        Id = Id == default ? id : Id;
     }
 
     public bool CanRun()

Core/Requirement/RequirementFactory.cs

@@ -520,22 +520,26 @@ private void BindPathSettingsIntVariables(PathSettings[] paths)
         {
             PathSettings settings = paths[i];
 
-            string nameDistanceToPath = $"PathDist_{settings.Id}";
-            intVariables.TryAdd(nameDistanceToPath, settings.GetDistanceXYFromPath);
+            string prefixKey = "PathDist";
+            string suffix = $"{settings.Id}";
+            string key = $"{prefixKey}_{suffix}";
+            intVariables.TryAdd(key, settings.GetDistanceXYFromPath);
+
+            InitPerKeyAction(prefixKey, suffix);
 
             Init(settings);
         }
     }
 
     private void InitPerKeyAction(KeyAction item)
     {
-        InitPerKeyAction(item, "CD");
-        InitPerKeyAction(item, "Cost");
+        InitPerKeyAction("CD", item.Name);
+        InitPerKeyAction("Cost", item.Name);
     }
 
-    private void InitPerKeyAction(KeyAction item, string prefixKey)
+    private void InitPerKeyAction(string prefixKey, string suffix)
     {
-        string key = $"{prefixKey}_{item.Name}";
+        string key = $"{prefixKey}_{suffix}";
         intVariables.Remove(prefixKey);
 
         if (intVariables.TryGetValue(key, out Func<int>? func))

README.md

@@ -620,6 +620,7 @@ The path that the player follows during [Follow Route Goal](#follow-route-goal),
 | Property Name | Description | Optional | Default value |
 | --- | --- | --- | --- |
 | `"PathFilename"` | [Path](#path) to use while alive | **false** | `""` |
+| `"Id"` | <b>Must be a Unique Integer value</b> to identify PathSettings. | true | `"Auto incremented from zero"` or `"Unless specified by user."` |
 | `"PathThereAndBack"` | While using the path, [should go start to and reverse](#there-and-back) | true | `true` |
 | `"PathReduceSteps"` | Reduce the number of path points | true | `false` |
 | `"SideActivityRequirements"` | List of [Requirements](#requirement) to limit when the player should search for target<br/>Great for enforcing how closely should follow the path. | true | `true` |
@@ -629,6 +630,7 @@ The path that the player follows during [Follow Route Goal](#follow-route-goal),
 When the bellow properties are defined in the [Class Configuration](#12-class-configuration), a new [PathSettings](#pathsettings) instance is created under in `Paths` array as the first element.
 
 ```json
+"Id": 42,                                                               // Optional - Helps identify the path
 "PathFilename": "_pack\\1-20\\Dwarf.Gnome\\1-4_Dun Morogh.json.json",   // the path to walk when alive
 "PathThereAndBack": true,                                               // if true walks the path and the walks it backwards.
 "PathReduceSteps": true,                                                // uses every other coordinate, halve the coordinate count
@@ -1393,6 +1395,7 @@ Formula: `[Keyword] [Operator] [Numeric integer value]`
 | `SessionHours` | Returns with the elapsed time in Hours since the Session started.<br>The Session starts when the `Start Bot` button is pressed! |
 | `ExpPerc` | Returns with the player experience as percentage to hit next level. |
 | `UIMapId` | Returns with the player current [UIMapId](https://github.com/Xian55/WowClassicGrindBot/blob/9bea201760babc0f6670df2bd5c071c9c3f1220d/Json/dbc/som/WorldMapArea.json#L3C6-L3C11) |
+| `PathDist` | Returns the context [PathSettings](#pathsettings) of closest distance (in yards) from the player location to the Path. |
 | `PathDist_{PathSettings.Id}` | Returns the closest distance (in yards) from the player location to the Path. |
 
 For the `MinRange` and `MaxRange` gives an approximation range distance between the player and target.