feat(sailing minimap): sailing minimap related methods and properties

Author: Torwent

osrs.simba

@@ -77,6 +77,7 @@ Summary: It includes this file until the current file is reached.
 {$IFNDEF WL_CHOOSEOPTION_INCLUDED}          {$INCLUDE_ONCE osrs/interfaces/chooseoption.simba}
 {$IFNDEF WL_MAINSCREEN_INCLUDED}            {$INCLUDE_ONCE osrs/interfaces/mainscreen/mainscreen.simba}
 {$IFNDEF WL_MINIMAP_INCLUDED}               {$INCLUDE_ONCE osrs/interfaces/minimap.simba}
+{$IFNDEF WL_SAILING_MINIMAP_INCLUDED}       {$INCLUDE_ONCE osrs/interfaces/sailing_minimap.simba}
 
 {$IFNDEF WL_OVERHEADFINDER_INCLUDED}        {$INCLUDE_ONCE osrs/finders/overheadfinder.simba}
 
@@ -185,4 +186,4 @@ Summary: It includes this file until the current file is reached.
 {$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}
 {$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}
 {$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}
-{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}
+{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}{$ENDIF}

osrs/data/data.simba

@@ -370,19 +370,15 @@ var
   ids: TStringArray;
   id: String;
   json: TJSONItem;
-  stackable: Boolean;
 begin
   if item.IsNumeric then ids := [item]
   else ids := ItemFinder.Database.GetAll(item.ToLower(), 'item', 'id');
+
   for id in ids do
   begin
     json := Self.GetDefinition(id);
-    case json.Item[Ord(EItemDataKey.STACKABLE)].AsInt of
-      0: stackable := False;
-      1: stackable := True;
-    end;
-    if stackable then
-      Exit(stackable);
+    if json.Item[Ord(EItemDataKey.STACKABLE)].AsInt <> 0 then
+      Exit(True);
   end;
 end;
 

osrs/interfaces/sailing_minimap.simba

@@ -0,0 +1,174 @@
+(*
+# Sailing Minimap
+Methods to interact with the minimap interface while sailing:
+```{figure} ../../images/sailing_minimap.png
+```
+*)
+
+{$DEFINE WL_SAILING_MINIMAP_INCLUDED}
+{$INCLUDE_ONCE WaspLib/osrs.simba}
+
+type
+(*
+## ERSBoat enum
+```pascal
+ERSBoat = enum(RAFT, SKIFF, SLOOP);
+```
+Enum representing the types of boat the player can own and use.
+*)
+  ERSBoat = enum(RAFT, SKIFF, SLOOP);
+
+function TRSMinimap._GetBoat(out black, brown: TPointArray): TPointArray;
+var
+  grown, tpa: TPointArray;
+  atpa: T2DPointArray;
+begin
+  black := Target.FindColor($010000, 0, Minimap.Bounds);
+  if black = [] then
+    Exit;
+
+  brown := Target.FindColor([$364E79, 0.9, EColorSpace.HSL, [1.888, 0.826, 0.288]], Minimap.Bounds);
+  if brown = [] then
+    Exit;
+
+  atpa := brown.Cluster(5);
+
+  brown := [];
+  for tpa in atpa do
+    if tpa.MinAreaRect().Contains(Minimap.Center) then
+    begin
+      brown := tpa;
+      Break;
+    end;
+
+  if brown = [] then
+    Exit;
+
+  grown := brown.Grow(2);
+
+  for tpa in black.Cluster(5) do
+    if tpa.Intersection(grown) <> [] then
+    begin
+      black := tpa;
+      Exit(black+brown);
+    end;
+end;
+
+(*
+## Minimap.GetBoat
+```pascal
+function TRSMinimap.GetBoat(): TPointArray;
+```
+Returns a `TPointArray` of the player's boat.
+
+Example:
+```pascal
+{$I WaspLib/osrs.simba}
+begin
+  while True do
+    ShowOnTarget(Minimap.GetBoat());
+end.
+```
+```{figure} ../../images/getboat.png
+```
+*)
+function TRSMinimap.GetBoat(): TPointArray;
+var
+  black, brown: TPointArray;
+begin
+  Result := Self._GetBoat(black, brown);
+end;
+
+(*
+## Minimap.BoatRadians
+```pascal
+property TRSMinimap.BoatRadians: Single;
+```
+Returns a the boat angle as radians.
+
+Example:
+```pascal
+{$I WaspLib/osrs.simba}
+begin
+  WriteLn Minimap.BoatRadians;
+end.
+```
+*)
+property TRSMinimap.BoatRadians: Single;
+var
+  boat, black, brown, tpa: TPointArray;
+  tipTPA: TVector2Array;
+  tip, center: TVector2;
+  i: Integer;
+begin
+  boat := Self._GetBoat(black, brown);
+  if boat = [] then
+    Exit;
+
+  tpa := black.Difference(black.PointsNearby(brown, 0, 5)).SortFrom(Minimap.Center);
+  for i := High(tpa) downto 0 do
+  begin
+    tipTPA += tpa[i];
+    if Length(tipTPA) > 3 then
+      Break;
+  end;
+
+  tip := tipTPA.Mean();
+
+  center := boat.MinAreaRect().Mean;
+
+  Result := Modulo(ArcTan2(Minimap.Center.Y-tip.Y, Minimap.Center.X-tip.X) - HALF_PI, TAU);
+end;
+
+(*
+## Minimap.BoatDegrees
+```pascal
+property TRSMinimap.BoatDegrees: Single;
+```
+Returns a the boat angle as degrees.
+
+Example:
+```pascal
+{$I WaspLib/osrs.simba}
+begin
+  WriteLn Minimap.BoatDegrees;
+end.
+```
+*)
+property TRSMinimap.BoatDegrees: Single;
+begin
+  Result := RadToDeg(Self.BoatRadians);
+end;
+
+(*
+## Minimap.BoatType
+```pascal
+property TRSMinimap.BoatType: ERSBoat;
+```
+Returns a the boat {ref}`ERSBoat` type.
+
+Example:
+```pascal
+{$I WaspLib/osrs.simba}
+begin
+  WriteLn Minimap.BoatType;
+end.
+```
+*)
+property TRSMinimap.BoatType: ERSBoat;
+var
+  tpa: TPointArray;
+  size: Integer;
+begin
+  tpa := Self.GetBoat();
+  size := tpa.MinAreaRect().Area;
+
+  //todo:
+  if InRange(size, 0, 5) then
+    Exit(ERSBoat.RAFT);
+  //todo:
+  if InRange(size, 6, 20) then
+    Exit(ERSBoat.SKIFF);
+  if InRange(size, 800, 1100) then
+    Exit(ERSBoat.SLOOP);
+end;