fix(TRSWalker): GetClosestPoint improved logic

Author: Torwent

osrs/interfaces/interfacecontrols.simba

@@ -374,7 +374,10 @@ WriteLn Chat.Scroll.CanScroll();
 *)
 function TRSScrollBar.CanScroll(): Boolean;
 begin
-  Result := Self.IsVisible() and (Self.Slider <> Self.Bounds);
+  if not Self.IsVisible() then
+    Exit;
+
+  Result := (Abs(Self.Slider.Y1 - Self.Bounds.Y1) > 0) or (Abs(Self.Slider.Y2 - Self.Bounds.Y2) > 0);
 end;
 
 

osrs/position/map/entities.simba

@@ -18,6 +18,8 @@ these do not have a rotation field.
 {$INCLUDE_ONCE WaspLib/osrs.simba}
 
 type
+  ENPCData = enum(ID, NAME, LEVEL, CATEGORY, MINIMAPDOT, ACTIONS, SIZE, COORDINATES, COLORS);
+
 (*
 ## TRSEntity
 Main type to handle {ref}`RSEntity`.
@@ -44,7 +46,7 @@ Array of {ref}`TRSEntity`.
 ## RSEntity.Create
 ```pascal
 function TRSEntity.Create(walker: PRSWalker; size: TVector3; coordinates: TPointArray; uptext: TStringArray = []; dots: ERSMinimapDots = []): TRSEntity; static;
-function TRSEntity.Create(json: TJSONItem): TRSEntity; static; overload;
+function TRSEntity.Create(json: TJSONObject): TRSEntity; static; overload;
 ```
 Createors to create your {ref}`TRSEntity`.
 
@@ -95,7 +97,7 @@ begin
     Result.Filter += TRSDotFilter.Create([], TCircle.Create(pt.X, pt.Y, radius), True);
 end;
 
-function TRSEntity.Create(json: TJSONItem): TRSEntity; static; overload;
+function TRSEntity.Create(json: TJSONObject): TRSEntity; static; overload;
 var
   i: Integer;
   colors: TColorArray;
@@ -105,29 +107,34 @@ begin
   if json.Typ <> EJSONType.OBJ then
     raise GetDebugLn('TRSEntity', 'JSON Object expected, got ' + ToStr(json.Typ) + '.');
 
-  if json.Item[1].AsString <> 'null' then
-    Result.UpText := [json.Item[1].AsString];
-  if json.Item[4].AsBool then //4 is minimapdot key in TRSMap jsons
+  with json.Item[Ord(ENPCData.NAME)] do
+    if AsString <> 'null' then
+      Result.UpText := [AsString];
+
+  if json.Item[Ord(ENPCData.MINIMAPDOT)].AsBool then
     Result.MinimapDots := [ERSMinimapDot.NPC];
 
-  //6 is size key in TRSMap jsons
-  Result.Size.X := Round(json.Item[6].Item[0].AsInt * 0.8, 2);
-  Result.Size.Y := Round(json.Item[6].Item[1].AsInt * 0.8, 2);
-  Result.Size.Z := Round(json.Item[6].Item[2].AsInt / 40, 2);
+  with json.Item[Ord(ENPCData.SIZE)] do
+  begin
+    Result.Size.X := Item[0].AsInt * 0.8;
+    Result.Size.Y := Item[1].AsInt * 0.8;
+    Result.Size.Z := Item[2].AsInt / 40;
+  end;
 
-  if Result.Size.Z = 0.0 then
+  if Abs(Result.Size.Z) < 0.05 then
     Result.Size.Z := 3.0;
 
-  //7 is coordinates key in TRSMap jsons
-  for i := 0 to json.Item[7].Count-1 do
-  begin
-    coord := json.Item[7].Item[i];
-    Result.Coordinates += [coord.Item[0].AsInt, coord.Item[1].AsInt];
-    Result.Filter += TRSDotFilter.Create([], TCircle.Create(coord.Item[0].AsInt, coord.Item[1].AsInt, 40), True);
-  end;
-  //8 is colors key in TRSMap jsons
-  for i := 0 to json.Item[8].Count-1 do
-    colors += json.Item[8].Item[i].AsInt;
+  with json.Item[Ord(ENPCData.COORDINATES)] do
+    for i := 0 to Count-1 do
+    begin
+      coord := Item[i];
+      Result.Coordinates += [coord.Item[0].AsInt, coord.Item[1].AsInt];
+      Result.Filter += TRSDotFilter.Create([], TCircle.Create(coord.Item[0].AsInt, coord.Item[1].AsInt, 40), True);
+    end;
+
+  with json.Item[Ord(ENPCData.COLORS)] do
+    for i := 0 to Count-1 do
+      colors += Item[i].AsInt;
 
   if colors <> [] then
   begin
@@ -138,7 +145,29 @@ begin
   Result.Walker := @Map.Walker;
 end;
 
-function TRSEntityArray.Create(json: TJSONItem): TRSEntityArray; static;
+(*
+## RSEntityArray.Create
+```pascal
+function TRSEntityArray.Create(json: TJSONArray): TRSEntityArray; static;
+```
+Create function to build your {ref}`TRSObjectArray`.
+
+This only accepts a `json` array and it expects a specific json structure which is
+the one that {ref}`Map JSONs` provide.
+
+Example:
+```pascal
+{$I WaspLib/osrs.simba}
+
+var
+  objs: TRSObjectArray;
+begin
+  Map.Setup([ERSChunk.VARROCK]);
+  objs := TRSObject.Create(ObjectsJSON.GetByName('bank'));
+end;
+```
+*)
+function TRSEntityArray.Create(json: TJSONArray): TRSEntityArray; static;
 var
   i: Integer;
 begin

osrs/position/map/mapjson.simba

@@ -109,15 +109,17 @@ end;
 
 
 (*
-## ObjectsJSON.Get
+## ObjectsJSON.GetByName
 ```pascal
-function TMapObjectJSON.Get(name: String; amount: Integer = 0): TJSONItem;
+function TMapObjectJSON.GetByName(name: String; amount: Integer = 0): TJSONArray;
 ```
-Returns a `TJSONItem` JSON array of a map object that matches the specified `name`.
-By default you get all objects that match the `name`, however,
-if you want you can specify how many you want through `amount`.
+Returns a `TJSONArray` of JSON Objects of a map object that matches the
+specified `name`.
+
+By default you get all objects that match the `name`, however, if you want you
+can specify how many you want through `amount`.
 *)
-function TMapObjectJSON.GetByName(name: String; amount: Integer = 0): TJSONItem;
+function TMapObjectJSON.GetByName(name: String; amount: Integer = 0): TJSONArray;
 var
   i, found: Integer;
 begin
@@ -138,11 +140,11 @@ end;
 (*
 ## ObjectsJSON.GetByID
 ```pascal
-function TMapObjectJSON.GetByID(id: Integer): TJSONItem;
+function TMapObjectJSON.GetByID(id: Integer): TJSONObject;
 ```
-Returns a `TJSONItem` JSON object of a map object that matches the specified `id`.
+Returns a `TJSONObject` of a map object that matches the specified `id`.
 *)
-function TMapObjectJSON.GetByID(id: Integer): TJSONItem;
+function TMapObjectJSON.GetByID(id: Integer): TJSONObject;
 var
   i: Integer;
 begin
@@ -157,14 +159,14 @@ end;
 (*
 ## ObjectsJSON.GetByAction
 ```pascal
-function TMapObjectJSON.GetByAction(action: String; amount: Integer = 0): TJSONItem;
+function TMapObjectJSON.GetByAction(action: String; amount: Integer = 0): TJSONArray;
 ```
-Returns a `TJSONItem` JSON array of a map object that has an action that matches
-the specified `action`.
+Returns a `TJSONArray` of JSON Objects of a map object that has an action that
+matches the specified `action`.
 By default you get all objects that match the `action`, however, if you want
 you can specify how many you want through `amount`.
 *)
-function TMapObjectJSON.GetByAction(action: String; amount: Integer = 0): TJSONItem;
+function TMapObjectJSON.GetByAction(action: String; amount: Integer = 0): TJSONArray;
 var
   i, j, found: Integer;
 begin
@@ -176,7 +178,8 @@ begin
       if Self.Data.Item[i].Item[4].Item[j].AsString = action then
       begin
         Result.AddObject('', Self.Data.Item[i].Clone());
-        if Inc(found) = amount then Exit;
+        if Inc(found) = amount then
+          Exit;
         Continue(2);
       end;
 

osrs/position/map/objects.simba

@@ -8,6 +8,8 @@ game objects.
 {$INCLUDE_ONCE WaspLib/osrs.simba}
 
 type
+  EObjectData = enum(ID, NAME, TYP, CATEGORY, ACTIONS, COORDINATES, SIZE, ROTATIONS, COLORS);
+
 (*
 ## TRSObject
 Main type to handle {ref}`RSObjects`.
@@ -33,7 +35,7 @@ Array of {ref}`TRSObject`.
 ## RSObject.Create
 ```pascal
 function TRSObject.Create(walker: PRSWalker; size: TVector3; coordinates: TPointArray; uptext: TStringArray = []): TRSObject; static;
-function TRSObject.Create(json: TJSONItem): TRSObject; static; overload;
+function TRSObject.Create(json: TJSONObject): TRSObject; static; overload;
 ```
 Createors to create your {ref}`TRSObject`.
 
@@ -75,7 +77,7 @@ begin
   Result.Walker := walker;
 end;
 
-function TRSObject.Create(json: TJSONItem): TRSObject; static; overload;
+function TRSObject.Create(json: TJSONObject): TRSObject; static; overload;
 var
   i: Integer;
   colors: TColorArray;
@@ -84,31 +86,33 @@ begin
   if json.Typ <> EJSONType.OBJ then
     raise GetDebugLn('TRSObject', 'JSON Object expected, got ' + ToStr(json.Typ) + '.');
 
-  if json.Item[1].AsString <> 'null' then
-    Result.UpText := [json.Item[1].AsString];
+  with json.Item[Ord(EObjectData.NAME)] do
+    if AsString <> 'null' then
+      Result.UpText := [AsString];
 
-  //5 is coordinates key in trsmap jsons
-  for i := 0 to json.Item[5].Count-1 do
-    Result.Coordinates += [json.Item[5].Item[i].Item[0].AsInt, json.Item[5].Item[i].Item[1].AsInt];
+  with json.Item[Ord(EObjectData.COORDINATES)] do
+    for i := 0 to Count-1 do
+      Result.Coordinates += [Item[i].Item[0].AsInt, Item[i].Item[1].AsInt];
 
-  //6 is size key in trsmap jsons
-  Result.Size.X := Round(json.Item[6].Item[0].AsInt * 0.8, 2);
-  Result.Size.Y := Round(json.Item[6].Item[1].AsInt * 0.8, 2);
-  Result.Size.Z := Round(json.Item[6].Item[2].AsInt / 40, 2);
+  with json.Item[Ord(EObjectData.SIZE)] do
+  begin
+    Result.Size.X := Item[0].AsInt * 0.8;
+    Result.Size.Y := Item[1].AsInt * 0.8;
+    Result.Size.Z := Item[2].AsInt / 40;
+  end;
 
-  if Result.Size.Z = 0.0 then
+  if Abs(Result.Size.Z) < 0.05 then
     Result.Size.Z := 3.0;
 
-  //7 is rotations key in trsmap jsons
-  for i := 0 to json.Item[7].Count-1 do
-    Result.Rotations += json.Item[7].Item[i].AsInt;
+  with json.Item[Ord(EObjectData.ROTATIONS)] do
+    for i := 0 to Count-1 do
+      Result.Rotations += Item[i].AsInt;
 
-  while Length(Result.Rotations) < Length(Result.Coordinates) do
-    Result.Rotations += Result.Rotations[High(Result.Rotations)];
+  SetLength(Result.Rotations, Length(Result.Coordinates));
 
-  //8 is colors key in trsmap jsons
-  for i := 0 to json.Item[8].Count-1 do
-    colors += json.Item[8].Item[i].AsInt;
+  with json.Item[Ord(EObjectData.ROTATIONS)] do
+    for i := 0 to Count-1 do
+      colors += Item[i].AsInt;
 
   if colors <> [] then
   begin
@@ -122,9 +126,9 @@ end;
 (*
 ## RSObjectArray.Create
 ```pascal
-function TRSObjectArray.Create(json: TJSONItem): TRSObjectArray; static; overload;
+function TRSObjectArray.Create(json: TJSONArray): TRSObjectArray; static; overload;
 ```
-Createor function to build your {ref}`TRSObjectArray`.
+Create function to build your {ref}`TRSObjectArray`.
 
 This only accepts a `json` array and it expects a specific json structure which is
 the one that {ref}`Map JSONs` provide.
@@ -141,7 +145,7 @@ begin
 end;
 ```
 *)
-function TRSObjectArray.Create(json: TJSONItem): TRSObjectArray; static;
+function TRSObjectArray.Create(json: TJSONArray): TRSObjectArray; static;
 var
   i: Integer;
 begin

osrs/walker.simba

@@ -1054,31 +1054,44 @@ end;
 (*
 ## TRSWalker.GetClosestPoint
 ```pascal
-function TRSWalker.GetClosestPointEx(me: TPoint; destinations: TPointArray): TPoint;
-function TRSWalker.GetClosestPoint(destinations: TPointArray): TPoint;
+function TRSWalker.GetClosestPoint(me: TPoint; destinations: TPointArray; out path: TGraphNodeArray): TPoint;
 ```
-Method used to get the closest Point to the Player out of a TPA.
+Method used to get the closest `destination` point to `me`.
 *)
-function TRSWalker.GetClosestPoint(me: TPoint; destinations: TPointArray; out path: TGraphNodeArray): TPoint; overload;
+function TRSWalker.GetClosestPoint(me: TPoint; destinations: TPointArray; out path: TGraphNodeArray): TPoint;
 var
   shortPaths: array of TGraphNodeArray;
-  best, dist: Integer;
+  best, dist, i: Integer;
   destination: TPoint;
+  pathDist: Double;
 begin
   me := Self.Position();
   best := $FFFFFF;
 
   for destination in destinations do
   begin
+    if not me.InRange(destination, best) then
+      Continue;
+
     try
       path := Self.WebGraph^.PathBetween(me, destination, 0, 4);
     except
       Continue;
     end;
 
-    if path = [] then Continue;
+    if path = [] then
+      Continue;
+
+    pathDist := 0;
+    for i := 0 to High(path)-1 do
+    begin
+      pathDist += path[i].Node.DistanceTo(path[i+1].Node);
+      if pathDist > best then
+        Continue;
+    end;
+
+    dist := Floor(pathDist);
 
-    dist := Floor(path.PolylineLength());
     if dist < best then
     begin
       shortPaths := [path];