Package net.citizensnpcs.npc.ai

Class AStarNavigationStrategy

java.lang.Object

net.citizensnpcs.api.ai.AbstractPathStrategy

net.citizensnpcs.npc.ai.AStarNavigationStrategy

All Implemented Interfaces:

PathStrategy

public class AStarNavigationStrategy
extends AbstractPathStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AStarNavigationStrategy.AStarPlanner

Constructor Summary

Constructors

Constructor	Description
AStarNavigationStrategy(NPC npc, Iterable<Vector> path, NavigatorParameters params)
AStarNavigationStrategy(NPC npc, Location dest, NavigatorParameters params)

Method Summary

Modifier and Type	Method	Description
Location	getCurrentDestination()
Iterable<Vector>	getPath()
Location	getTargetAsLocation()
void	stop()	Forcibly stops pathfinding.
boolean	update()	Updates and runs the pathfinding strategy on its current NPC and destination.

Methods inherited from class net.citizensnpcs.api.ai.AbstractPathStrategy

clearCancelReason, getCancelReason, getTargetType, setCancelReason

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AStarNavigationStrategy

public AStarNavigationStrategy(NPC npc,
 Iterable<Vector> path,
 NavigatorParameters params)

AStarNavigationStrategy

public AStarNavigationStrategy(NPC npc,
 Location dest,
 NavigatorParameters params)

Method Details

getCurrentDestination

public Location getCurrentDestination()

Returns:

Gets the current movement destination

getPath

public Iterable<Vector> getPath()

Returns:

A copy of the current path, if any

getTargetAsLocation

public Location getTargetAsLocation()

Returns:

Gets the target destination location

stop

public void stop()

Description copied from interface: PathStrategy

Forcibly stops pathfinding. Note that this method does not necessarily set the cancel reason.

update

public boolean update()

Description copied from interface: PathStrategy

Updates and runs the pathfinding strategy on its current NPC and destination.

Returns:

Whether pathfinding has completed