baseline: OpenMU upstream b5a0961 (fresh source)

src/Pathfinding/IPathFinder.cs

@@ -0,0 +1,29 @@
+// <copyright file="IPathFinder.cs" company="MUnique">
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.
+// </copyright>
+
+namespace MUnique.OpenMU.Pathfinding;
+
+using System.Threading;
+
+/// <summary>
+/// Interface for a path finder.
+/// </summary>
+internal interface IPathFinder
+{
+    /// <summary>
+    /// Finds the path between two points.
+    /// </summary>
+    /// <param name="start">The start point.</param>
+    /// <param name="end">The end point.</param>
+    /// <param name="terrain">
+    /// The two-dimensional grid of the terrain.
+    /// For each coordinate it contains the cost of traveling to it from a neighbor coordinate.
+    /// The value of 0 means, that the coordinate is unreachable, <see cref="BaseGridNetwork.UnreachableGridNodeValue" />.
+    /// If the highest bit of a value is set, it means it's a coordinate of a safezone.
+    /// </param>
+    /// <param name="includeSafezone">If set to <c>true</c>, safezone nodes should be included in the search.</param>
+    /// <param name="cancellationToken">The optional cancellation token to cancel the operation.</param>
+    /// <returns>The path between start and end, including <paramref name="end"/>, but excluding <paramref name="start"/>.</returns>
+    IList<PathResultNode>? FindPath(Point start, Point end, byte[,] terrain, bool includeSafezone, CancellationToken cancellationToken = default);
+}