made search areas a sphere / cylinder (closes #11)

devpikachu · devpikachu · commit 9480c0d93d37 · 2025-10-30T17:53:00.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## 21.2.0
 **:sparkles: Features**
 - Made each mode variant toggleable ([#10](https://git.omni.ms/vintage-story-mods/durable-better-prospecting/issues/10))
+- Made the modes use spherical / cylindrical walk blocks functions instead of the vanilla cuboid ones ([#11](https://git.omni.ms/vintage-story-mods/durable-better-prospecting/issues/11))
 
 **:bug: Bug Fixes**
 - Re-added mod icon ([#12](https://git.omni.ms/vintage-story-mods/durable-better-prospecting/issues/12))
diff --git a/DurableBetterProspecting/Core/PickaxeMode.cs b/DurableBetterProspecting/Core/PickaxeMode.cs
@@ -7,7 +7,7 @@ internal record PickaxeMode
     public required Icon Icon { get; init; }
     public required SampleShape SampleShape { get; init; }
     public required SampleType SampleType { get; init; }
-    public required int SampleSize { get; init; }
+    public required int SampleRadius { get; init; }
     public required int DurabilityCost { get; init; }
     public required bool Enabled { get; init; }
 }
diff --git a/DurableBetterProspecting/Core/SampleShape.cs b/DurableBetterProspecting/Core/SampleShape.cs
@@ -3,6 +3,6 @@ namespace DurableBetterProspecting.Core;
 internal enum SampleShape
 {
     Vanilla,
-    Cube,
-    Cuboid
+    Sphere,
+    Cylinder
 }
diff --git a/DurableBetterProspecting/Items/ItemProspectingPick.cs b/DurableBetterProspecting/Items/ItemProspectingPick.cs
@@ -1,4 +1,5 @@
 using Common.Mod.Common.Config;
+using Common.Mod.Extensions;
 using DryIoc;
 using DurableBetterProspecting.Core;
 using DurableBetterProspecting.Managers;
@@ -146,24 +147,18 @@ PickaxeMode mode
         }
 
         if (_channel is not IServerNetworkChannel serverChannel
-            || world is not ServerMain serverWorld
             || player.Player is not IServerPlayer serverPlayer)
         {
             return;
         }
 
         var sampleShape = mode.SampleShape;
         var sampleType = mode.SampleType;
-        var sampleSize = mode.SampleSize;
-
-        var halfSize = (int)MathF.Round(sampleSize / 2.0f);
-        var bottomPosition = sampleShape is SampleShape.Cube ? position.Y - halfSize : 0;
-        var topPosition = sampleShape is SampleShape.Cube ? position.Y + halfSize : serverWorld.MapSize.Y;
-        var minPosition = new Vec3i(position.X - halfSize, bottomPosition, position.Z - halfSize).ToBlockPos();
-        var maxPosition = new Vec3i(position.X + halfSize, topPosition, position.Z + halfSize).ToBlockPos();
+        var sampleRadius = mode.SampleRadius;
 
+        // Handler
         Dictionary<string, Reading> readings = [];
-        serverWorld.BlockAccessor.WalkBlocks(minPosition, maxPosition, (block, x, y, z) =>
+        void OnBlockHandler(Block block, int x, int y, int z)
         {
             switch (sampleType)
             {
@@ -224,13 +219,29 @@ PickaxeMode mode
                 default:
                     throw new ArgumentOutOfRangeException(nameof(sampleType), sampleType, null);
             }
-        });
+        }
+
+        switch (sampleShape)
+        {
+            case SampleShape.Sphere:
+                world.WalkBlocksSphere(position, sampleRadius, OnBlockHandler);
+                break;
+
+            case SampleShape.Cylinder:
+                var worldHeight = world.BlockAccessor.MapSizeY;
+                world.WalkBlocksCylinder(position, sampleRadius, 0, worldHeight, OnBlockHandler);
+                break;
+
+            case SampleShape.Vanilla:
+            default:
+                throw new ArgumentOutOfRangeException(nameof(sampleShape), sampleShape, null);
+        }
 
         var markerEligible = mode.Id is Constants.ColumnModeId or Constants.DistanceLongModeId or Constants.QuantityLongModeId;
         var readingPacket = new ReadingPacket
         {
             Mode = mode.Id,
-            Size = mode.SampleSize,
+            Size = mode.SampleRadius,
             Position = markerEligible ? position.ToVec3i() : null,
             Readings = readings.Values.ToArray(),
         };
diff --git a/DurableBetterProspecting/Managers/ModeManager.cs b/DurableBetterProspecting/Managers/ModeManager.cs
@@ -106,7 +106,7 @@ private void CreateModes()
             Icon = Icon.Create("game", "heatmap"),
             SampleShape = SampleShape.Vanilla,
             SampleType = SampleType.Vanilla,
-            SampleSize = int.MaxValue,
+            SampleRadius = int.MaxValue,
             DurabilityCost = _commonConfig.DensityMode.DurabilityCost,
             Enabled = _commonConfig.DensityMode.Enabled
         };
@@ -118,7 +118,7 @@ private void CreateModes()
             Icon = Icon.Create("game", "rocks"),
             SampleShape = SampleShape.Vanilla,
             SampleType = SampleType.Vanilla,
-            SampleSize = int.MaxValue,
+            SampleRadius = int.MaxValue,
             DurabilityCost = _commonConfig.NodeMode.DurabilityCost,
             Enabled = _commonConfig.NodeMode.Enabled && _api.World.Config.GetString(Constants.NodeSearchRadiusConfigKey).ToInt() > 0
         };
@@ -128,9 +128,9 @@ private void CreateModes()
             Id = Constants.RockModeId,
             Name = _translations.Get("mode--rock"),
             Icon = Icon.Create("mode_rock"),
-            SampleShape = SampleShape.Cube,
+            SampleShape = SampleShape.Sphere,
             SampleType = SampleType.Rock,
-            SampleSize = _commonConfig.RockMode.SampleSize,
+            SampleRadius = _commonConfig.RockMode.SampleSize,
             DurabilityCost = _commonConfig.RockMode.DurabilityCost,
             Enabled = _commonConfig.RockMode.Enabled
         };
@@ -140,9 +140,9 @@ private void CreateModes()
             Id = Constants.ColumnModeId,
             Name = _translations.Get("mode--column"),
             Icon = Icon.Create("mode_column"),
-            SampleShape = SampleShape.Cuboid,
+            SampleShape = SampleShape.Cylinder,
             SampleType = SampleType.Ore,
-            SampleSize = _commonConfig.ColumnMode.SampleSize,
+            SampleRadius = _commonConfig.ColumnMode.SampleSize,
             DurabilityCost = _commonConfig.ColumnMode.DurabilityCost,
             Enabled = _commonConfig.ColumnMode.Enabled
         };
@@ -152,9 +152,9 @@ private void CreateModes()
             Id = Constants.DistanceShortModeId,
             Name = _translations.Get("mode--distance-short"),
             Icon = Icon.Create("mode_distance_short"),
-            SampleShape = SampleShape.Cube,
+            SampleShape = SampleShape.Sphere,
             SampleType = SampleType.Ore,
-            SampleSize = _commonConfig.DistanceMode.SampleSizeShort,
+            SampleRadius = _commonConfig.DistanceMode.SampleSizeShort,
             DurabilityCost = _commonConfig.DistanceMode.DurabilityCostShort,
             Enabled = _commonConfig.DistanceMode.EnabledShort
         };
@@ -164,9 +164,9 @@ private void CreateModes()
             Id = Constants.DistanceMediumModeId,
             Name = _translations.Get("mode--distance-medium"),
             Icon = Icon.Create("mode_distance_medium"),
-            SampleShape = SampleShape.Cube,
+            SampleShape = SampleShape.Sphere,
             SampleType = SampleType.Ore,
-            SampleSize = _commonConfig.DistanceMode.SampleSizeMedium,
+            SampleRadius = _commonConfig.DistanceMode.SampleSizeMedium,
             DurabilityCost = _commonConfig.DistanceMode.DurabilityCostMedium,
             Enabled = _commonConfig.DistanceMode.EnabledMedium
         };
@@ -176,9 +176,9 @@ private void CreateModes()
             Id = Constants.DistanceLongModeId,
             Name = _translations.Get("mode--distance-long"),
             Icon = Icon.Create("mode_distance_long"),
-            SampleShape = SampleShape.Cube,
+            SampleShape = SampleShape.Sphere,
             SampleType = SampleType.Ore,
-            SampleSize = _commonConfig.DistanceMode.SampleSizeLong,
+            SampleRadius = _commonConfig.DistanceMode.SampleSizeLong,
             DurabilityCost = _commonConfig.DistanceMode.DurabilityCostLong,
             Enabled = _commonConfig.DistanceMode.EnabledLong
         };
@@ -188,9 +188,9 @@ private void CreateModes()
             Id = Constants.QuantityShortModeId,
             Name = _translations.Get("mode--quantity-short"),
             Icon = Icon.Create("mode_quantity_short"),
-            SampleShape = SampleShape.Cube,
+            SampleShape = SampleShape.Sphere,
             SampleType = SampleType.Ore,
-            SampleSize = _commonConfig.QuantityMode.SampleSizeShort,
+            SampleRadius = _commonConfig.QuantityMode.SampleSizeShort,
             DurabilityCost = _commonConfig.QuantityMode.DurabilityCostShort,
             Enabled = _commonConfig.QuantityMode.EnabledShort
         };
@@ -200,9 +200,9 @@ private void CreateModes()
             Id = Constants.QuantityMediumModeId,
             Name = _translations.Get("mode--quantity-medium"),
             Icon = Icon.Create("mode_quantity_medium"),
-            SampleShape = SampleShape.Cube,
+            SampleShape = SampleShape.Sphere,
             SampleType = SampleType.Ore,
-            SampleSize = _commonConfig.QuantityMode.SampleSizeMedium,
+            SampleRadius = _commonConfig.QuantityMode.SampleSizeMedium,
             DurabilityCost = _commonConfig.QuantityMode.DurabilityCostMedium,
             Enabled = _commonConfig.QuantityMode.EnabledMedium
         };
@@ -212,9 +212,9 @@ private void CreateModes()
             Id = Constants.QuantityLongModeId,
             Name = _translations.Get("mode--quantity-long"),
             Icon = Icon.Create("mode_quantity_long"),
-            SampleShape = SampleShape.Cube,
+            SampleShape = SampleShape.Sphere,
             SampleType = SampleType.Ore,
-            SampleSize = _commonConfig.QuantityMode.SampleSizeLong,
+            SampleRadius = _commonConfig.QuantityMode.SampleSizeLong,
             DurabilityCost = _commonConfig.QuantityMode.DurabilityCostLong,
             Enabled = _commonConfig.QuantityMode.EnabledLong
         };
diff --git a/DurableBetterProspecting/assets/durablebetterprospecting/lang/en.json b/DurableBetterProspecting/assets/durablebetterprospecting/lang/en.json
@@ -1,6 +1,4 @@
 {
-  "Durable Better Prospecting Common Configuration": "Durable Better Prospecting Common Configuration",
-  "Durable Better Prospecting Client Configuration": "Durable Better Prospecting Client Configuration",
   "You don't have permission to edit the common configuration": "You don't have permission to edit the common configuration",
   "Ascending": "Ascending",
   "Descending": "Descending",
@@ -23,7 +21,7 @@
   "reading--mode-column": "Column",
   "reading--mode-distance": "Distance",
   "reading--mode-quantity": "Quantity",
-  "reading--sample-taken": "{0} sample taken within an area of {1} block(s)",
+  "reading--sample-taken": "{0} sample taken within a radius of {1} block(s)",
   "reading--sample-empty": "No {0} found",
   "reading--sample-not-empty": "Found the following {0}:",
   "reading--amount-trace": "Trace amounts",
@@ -39,6 +37,8 @@
   "reading--east": "E",
   "reading--west": "W",
 
+  "config--header--common": "Durable Better Prospecting Common Configuration",
+  "config--header--client": "Durable Better Prospecting Client Configuration",
   "config--button--reset": "Reset to default: {0}",
   "config--label--enabled": "Enabled",
   "config--label--enabled-short": "Enabled (Short Range)",
@@ -50,13 +50,13 @@
   "config--label--durability-cost-short": "Durability Cost (Short Range)",
   "config--label--durability-cost-medium": "Durability Cost (Medium Range)",
   "config--label--durability-cost-long": "Durability Cost (Long Range)",
-  "config--label--sample-size": "Sample Size",
-  "config--label--sample-size-short": "Sample Size (Short Range)",
-  "config--label--sample-size-medium": "Sample Size (Medium Range)",
-  "config--label--sample-size-long": "Sample Size (Long Range)",
+  "config--label--sample-radius": "Sample Radius",
+  "config--label--sample-radius-short": "Sample Radius (Short Range)",
+  "config--label--sample-radius-medium": "Sample Radius (Medium Range)",
+  "config--label--sample-radius-long": "Sample Radius (Long Range)",
   "config--description--durability-cost": "The amount of durability damage to take for each sample",
-  "config--description--sample-size-cube": "The size of the sampled area. This area is a cube, centered on the sampled block",
-  "config--description--sample-size-cuboid": "The size of the sampled area. This area is a cuboid, centered on the sampled block and stretching from the mantle to the world height",
+  "config--description--sample-radius-sphere": "The radius of the sampled area. This area is a sphere, centered on the sampled block",
+  "config--description--sample-radius-cylinder": "The radius of the sampled area. This area is a cylinder, centered on the sampled block and stretching from the mantle to the world height",
 
   "config--label--common--direction": "Reading Direction",
   "config--label--common--marker": "Automatic Marker",
diff --git a/DurableBetterProspecting/config.json b/DurableBetterProspecting/config.json
@@ -201,9 +201,9 @@
         {
           "name": "SampleSize",
           "type": "Int32",
-          "defaultValue": 32,
-          "label": "config--label--sample-size",
-          "description": "config--description--sample-size-cube"
+          "defaultValue": 16,
+          "label": "config--label--sample-radius",
+          "description": "config--description--sample-radius-sphere"
         }
       ]
     },
@@ -229,9 +229,9 @@
         {
           "name": "SampleSize",
           "type": "Int32",
-          "defaultValue": 32,
-          "label": "config--label--sample-size",
-          "description": "config--description--sample-size-cuboid"
+          "defaultValue": 16,
+          "label": "config--label--sample-radius",
+          "description": "config--description--sample-radius-cylinder"
         }
       ]
     },
@@ -257,9 +257,9 @@
         {
           "name": "SampleSizeShort",
           "type": "Int32",
-          "defaultValue": 16,
-          "label": "config--label--sample-size-short",
-          "description": "config--description--sample-size-cube"
+          "defaultValue": 8,
+          "label": "config--label--sample-radius-short",
+          "description": "config--description--sample-radius-sphere"
         },
         {
           "name": "EnabledMedium",
@@ -278,9 +278,9 @@
         {
           "name": "SampleSizeMedium",
           "type": "Int32",
-          "defaultValue": 32,
-          "label": "config--label--sample-size-medium",
-          "description": "config--description--sample-size-cube"
+          "defaultValue": 16,
+          "label": "config--label--sample-radius-medium",
+          "description": "config--description--sample-radius-sphere"
         },
         {
           "name": "EnabledLong",
@@ -299,9 +299,9 @@
         {
           "name": "SampleSizeLong",
           "type": "Int32",
-          "defaultValue": 64,
-          "label": "config--label--sample-size-long",
-          "description": "config--description--sample-size-cube"
+          "defaultValue": 32,
+          "label": "config--label--sample-radius-long",
+          "description": "config--description--sample-radius-sphere"
         }
       ]
     },
@@ -327,9 +327,9 @@
         {
           "name": "SampleSizeShort",
           "type": "Int32",
-          "defaultValue": 16,
-          "label": "config--label--sample-size-short",
-          "description": "config--description--sample-size-cube"
+          "defaultValue": 8,
+          "label": "config--label--sample-radius-short",
+          "description": "config--description--sample-radius-sphere"
         },
         {
           "name": "EnabledMedium",
@@ -348,9 +348,9 @@
         {
           "name": "SampleSizeMedium",
           "type": "Int32",
-          "defaultValue": 32,
-          "label": "config--label--sample-size-medium",
-          "description": "config--description--sample-size-cube"
+          "defaultValue": 16,
+          "label": "config--label--sample-radius-medium",
+          "description": "config--description--sample-radius-sphere"
         },
         {
           "name": "EnabledLong",
@@ -369,9 +369,9 @@
         {
           "name": "SampleSizeLong",
           "type": "Int32",
-          "defaultValue": 64,
-          "label": "config--label--sample-size-long",
-          "description": "config--description--sample-size-cube"
+          "defaultValue": 32,
+          "label": "config--label--sample-radius-long",
+          "description": "config--description--sample-radius-sphere"
         }
       ]
     },

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ internal record PickaxeMode`
`7`	`7`	`public required Icon Icon { get; init; }`
`8`	`8`	`public required SampleShape SampleShape { get; init; }`
`9`	`9`	`public required SampleType SampleType { get; init; }`
`10`		`- public required int SampleSize { get; init; }`
	`10`	`+ public required int SampleRadius { get; init; }`
`11`	`11`	`public required int DurabilityCost { get; init; }`
`12`	`12`	`public required bool Enabled { get; init; }`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@ namespace DurableBetterProspecting.Core;`
`3`	`3`	`internal enum SampleShape`
`4`	`4`	`{`
`5`	`5`	`Vanilla,`
`6`		`- Cube,`
`7`		`- Cuboid`
	`6`	`+ Sphere,`
	`7`	`+ Cylinder`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -201,9 +201,9 @@`
`201`	`201`	`{`
`202`	`202`	`"name": "SampleSize",`
`203`	`203`	`"type": "Int32",`
`204`		`- "defaultValue": 32,`
`205`		`- "label": "config--label--sample-size",`
`206`		`- "description": "config--description--sample-size-cube"`
	`204`	`+ "defaultValue": 16,`
	`205`	`+ "label": "config--label--sample-radius",`
	`206`	`+ "description": "config--description--sample-radius-sphere"`
`207`	`207`	`}`
`208`	`208`	`]`
`209`	`209`	`},`
`@@ -229,9 +229,9 @@`
`229`	`229`	`{`
`230`	`230`	`"name": "SampleSize",`
`231`	`231`	`"type": "Int32",`
`232`		`- "defaultValue": 32,`
`233`		`- "label": "config--label--sample-size",`
`234`		`- "description": "config--description--sample-size-cuboid"`
	`232`	`+ "defaultValue": 16,`
	`233`	`+ "label": "config--label--sample-radius",`
	`234`	`+ "description": "config--description--sample-radius-cylinder"`
`235`	`235`	`}`
`236`	`236`	`]`
`237`	`237`	`},`
`@@ -257,9 +257,9 @@`
`257`	`257`	`{`
`258`	`258`	`"name": "SampleSizeShort",`
`259`	`259`	`"type": "Int32",`
`260`		`- "defaultValue": 16,`
`261`		`- "label": "config--label--sample-size-short",`
`262`		`- "description": "config--description--sample-size-cube"`
	`260`	`+ "defaultValue": 8,`
	`261`	`+ "label": "config--label--sample-radius-short",`
	`262`	`+ "description": "config--description--sample-radius-sphere"`
`263`	`263`	`},`
`264`	`264`	`{`
`265`	`265`	`"name": "EnabledMedium",`
`@@ -278,9 +278,9 @@`
`278`	`278`	`{`
`279`	`279`	`"name": "SampleSizeMedium",`
`280`	`280`	`"type": "Int32",`
`281`		`- "defaultValue": 32,`
`282`		`- "label": "config--label--sample-size-medium",`
`283`		`- "description": "config--description--sample-size-cube"`
	`281`	`+ "defaultValue": 16,`
	`282`	`+ "label": "config--label--sample-radius-medium",`
	`283`	`+ "description": "config--description--sample-radius-sphere"`
`284`	`284`	`},`
`285`	`285`	`{`
`286`	`286`	`"name": "EnabledLong",`
`@@ -299,9 +299,9 @@`
`299`	`299`	`{`
`300`	`300`	`"name": "SampleSizeLong",`
`301`	`301`	`"type": "Int32",`
`302`		`- "defaultValue": 64,`
`303`		`- "label": "config--label--sample-size-long",`
`304`		`- "description": "config--description--sample-size-cube"`
	`302`	`+ "defaultValue": 32,`
	`303`	`+ "label": "config--label--sample-radius-long",`
	`304`	`+ "description": "config--description--sample-radius-sphere"`
`305`	`305`	`}`
`306`	`306`	`]`
`307`	`307`	`},`
`@@ -327,9 +327,9 @@`
`327`	`327`	`{`
`328`	`328`	`"name": "SampleSizeShort",`
`329`	`329`	`"type": "Int32",`
`330`		`- "defaultValue": 16,`
`331`		`- "label": "config--label--sample-size-short",`
`332`		`- "description": "config--description--sample-size-cube"`
	`330`	`+ "defaultValue": 8,`
	`331`	`+ "label": "config--label--sample-radius-short",`
	`332`	`+ "description": "config--description--sample-radius-sphere"`
`333`	`333`	`},`
`334`	`334`	`{`
`335`	`335`	`"name": "EnabledMedium",`
`@@ -348,9 +348,9 @@`
`348`	`348`	`{`
`349`	`349`	`"name": "SampleSizeMedium",`
`350`	`350`	`"type": "Int32",`
`351`		`- "defaultValue": 32,`
`352`		`- "label": "config--label--sample-size-medium",`
`353`		`- "description": "config--description--sample-size-cube"`
	`351`	`+ "defaultValue": 16,`
	`352`	`+ "label": "config--label--sample-radius-medium",`
	`353`	`+ "description": "config--description--sample-radius-sphere"`
`354`	`354`	`},`
`355`	`355`	`{`
`356`	`356`	`"name": "EnabledLong",`
`@@ -369,9 +369,9 @@`
`369`	`369`	`{`
`370`	`370`	`"name": "SampleSizeLong",`
`371`	`371`	`"type": "Int32",`
`372`		`- "defaultValue": 64,`
`373`		`- "label": "config--label--sample-size-long",`
`374`		`- "description": "config--description--sample-size-cube"`
	`372`	`+ "defaultValue": 32,`
	`373`	`+ "label": "config--label--sample-radius-long",`
	`374`	`+ "description": "config--description--sample-radius-sphere"`
`375`	`375`	`}`
`376`	`376`	`]`
`377`	`377`	`},`