Files
OpenRA/OpenRA.Mods.Common/Pathfinder/SparsePathGraph.cs
RoosterDragon 4ec5a4b34a Fix reversed path searches from inaccessible locations.
The Harvester trait and MoveAdjacentTo activity called the pathfinder but had a single source and multiple targets. The pathfinder interface only allows for the opposite: multiple sources and a single target. To work around this they would swap the inputs. This works in most cases but not all cases. One aspect of asymmetry is that an actor may move out of an inaccessible source cell, but not onto an inaccessible target cell.

Searches that involved an inaccessible source cell and that applied this swapping method would therefore fail to return a path, when a valid path was possible. Although a rare case, once good way to reproduce is to use a production building that spawns actors on inaccessible cells around it, such as the RA naval yard. A move order uses the pathfinder correctly and the unit will move out. Using a force attack causes the unit to use the broken "swapped" mechanism in MoveAdjacentTo and it will be stuck.

This asymmetry has been longstanding but the pathfinding infrastructure only sporadically accounted for it. It is now documented and applied consistently. Create a new overload on the pathfinder trait that allows a single source and multiple targets, so callers have an overload that does what they need and won't be tempted to swap the positions and run into this issue.

Internally, this requires us to teach Locomotor to ignore the self actor when performing movement cost checks for these "in reverse" searches so the unit doesn't consider the cell blocked by itself.
2023-04-07 16:38:37 +01:00

54 lines
1.5 KiB
C#

#region Copyright & License Information
/*
* Copyright (c) The OpenRA Developers and Contributors
* This file is part of OpenRA, which is free software. It is made
* available to you under the terms of the GNU General Public License
* as published by the Free Software Foundation, either version 3 of
* the License, or (at your option) any later version. For more
* information, see COPYING.
*/
#endregion
using System;
using System.Collections.Generic;
namespace OpenRA.Mods.Common.Pathfinder
{
/// <summary>
/// A sparse pathfinding graph that supports a search over provided cells.
/// This is a classic graph that supports an arbitrary graph of nodes and edges,
/// and does not require a dense grid of cells.
/// Costs and any desired connections to a <see cref="Traits.ICustomMovementLayer"/>
/// must be provided as input.
/// </summary>
sealed class SparsePathGraph : IPathGraph
{
readonly Func<CPos, List<GraphConnection>> edges;
readonly Dictionary<CPos, CellInfo> info;
public SparsePathGraph(Func<CPos, List<GraphConnection>> edges, int estimatedSearchSize = 0)
{
this.edges = edges;
info = new Dictionary<CPos, CellInfo>(estimatedSearchSize);
}
public List<GraphConnection> GetConnections(CPos position, Func<CPos, bool> targetPredicate)
{
return edges(position) ?? new List<GraphConnection>();
}
public CellInfo this[CPos pos]
{
get
{
if (info.TryGetValue(pos, out var cellInfo))
return cellInfo;
return default;
}
set => info[pos] = value;
}
public void Dispose() { }
}
}