Class Pathfinder

A pathfinder which implements the A* pathfinding algorithm.

Hierarchy

Pathfinder

Index

Constructors

constructor

Properties

nodes
w

Methods

Constructors

constructor

new Pathfinder(mapWidth: number, walkableNodes?: NodeUpdate[]): Pathfinder

- Defined in services/pathfinding/pathfinder.ts:12
Parameters
- mapWidth: number
- Optional walkableNodes: NodeUpdate[]
Returns Pathfinder

Properties

Private nodes

nodes: Node[]

Private w

w: number

Methods

destroy

destroy(): void

- Defined in services/pathfinding/pathfinder.ts:88
Releases any resources held by this pathfinder.

Returns void

findPath

findPath(start: Point, end: Point): Promise<Point[]>

- Defined in services/pathfinding/pathfinder.ts:31
Finds a path from the start to the end and returns a list of points in between.

Parameters
- start: Point
  
  The start point.
- end: Point
  
  The end point.
Returns Promise<Point[]>

Private getDistance

getDistance(nodeA: Node, nodeB: Node): number

- Defined in services/pathfinding/pathfinder.ts:186
Parameters
- nodeA: Node
- nodeB: Node
Returns number

Private getIndex

getIndex(x: number, y: number): number

- Defined in services/pathfinding/pathfinder.ts:156
Parameters
- x: number
- y: number
Returns number

Private getNeighbors

getNeighbors(node: Node): Node[]

- Defined in services/pathfinding/pathfinder.ts:166
Parameters
- node: Node
Returns Node[]

Private getPosition

getPosition(index: number): object

- Defined in services/pathfinding/pathfinder.ts:160
Parameters
- index: number
Returns object
- x: number
- y: number

Private retracePath

retracePath(start: Node, end: Node): Point[]

- Defined in services/pathfinding/pathfinder.ts:145
Parameters
- start: Node
- end: Node
Returns Point[]

Private simplifyPath

simplifyPath(path: Node[]): Point[]

- Defined in services/pathfinding/pathfinder.ts:92
Parameters
- path: Node[]
Returns Point[]

updateWalkableNodes

updateWalkableNodes(updates: NodeUpdate[]): void

- Defined in services/pathfinding/pathfinder.ts:78
Applies updates to the nodes known by this pathfinder.

Parameters
- updates: NodeUpdate[]
  
  The node updates to apply.
Returns void

Generated using TypeDoc