AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | List of all members
AlphaFramework.World.Paths.IPathfinder< TCoordinates > Interface Template Reference

A strategy pattern interface for pathfinding algorithms. More...

Inheritance diagram for AlphaFramework.World.Paths.IPathfinder< TCoordinates >:
AlphaFramework.World.Paths.SimplePathfinder

Public Member Functions

IEnumerable< TCoordinates > FindPath (TCoordinates start, TCoordinates target)
 Calculates a path from source to target coordinates. More...
 

Detailed Description

A strategy pattern interface for pathfinding algorithms.

Template Parameters
TCoordinatesData type for storing position coordinates of objects in the game world.
Type Constraints
TCoordinates :struct 

Member Function Documentation

IEnumerable<TCoordinates> AlphaFramework.World.Paths.IPathfinder< TCoordinates >.FindPath ( TCoordinates  start,
TCoordinates  target 
)

Calculates a path from source to target coordinates.

Parameters
startThe starting coordinates.
targetThe end coordinates.
Returns
A list of coordinates forming a path; null if no path was found.

The documentation for this interface was generated from the following file: