Wiki

Clone wiki

RogueSharp / RogueSharp / PathFinder / ShortestPath

PathFinderShortestPath Method

Returns an ordered IEnumerable of Cells representing the shortest path from a specified source Cell to a destination Cell

Namespace: RogueSharp
Assembly:

Syntax

public Path ShortestPath(
    Cell source,
    Cell destination
)

Parameters

source

Type: RogueSharpCell
The Cell which is at the start of the path

destination

Type: RogueSharpCell
The Cell which is at the end of the path

Return Value

Type: Path
Returns an ordered IEnumerable of Cells representing the shortest path from a specified source Cell to a destination Cell

Exceptions

Exception Condition
ArgumentNullException Thrown when source or destination is null
PathNotFoundException Thrown when there is not a path from the source to the destination

See Also

Reference

PathFinder Class
RogueSharp Namespace

[6]: 2014-2016 Faron Bracy

Updated