net.citizensnpcs.npc.ai

Class CitizensNavigator

java.lang.Object

net.citizensnpcs.npc.ai.CitizensNavigator

All Implemented Interfaces:

Runnable, Navigator

public class CitizensNavigator
extends Object
implements Navigator, Runnable

Constructor Summary

Constructors

Constructor and Description
CitizensNavigator(NPC npc)

Method Summary

Modifier and Type	Method and Description
void	cancelNavigation() Cancels any running navigation towards a target.
NavigatorParameters	getDefaultParameters() Returns the NavigatorParameters local to this navigator.
EntityTarget	getEntityTarget() Returns the current EntityTarget of the navigator, if any.
NavigatorParameters	getLocalParameters() Returns the NavigatorParameters local to any current target execution.
NPC	getNPC()
PathStrategy	getPathStrategy()
Location	getTargetAsLocation() Returns the current Location being navigated towards - this is not necessarily permanent and may change, for example when pathing towards a moving Entity.
TargetType	getTargetType()
boolean	isNavigating()
boolean	isPaused()
void	load(DataKey root)
void	onDespawn()
void	onSpawn()
void	run()
void	save(DataKey root)
void	setPaused(boolean paused) Sets whether the navigator is paused and shouldn't process the path for now.
void	setTarget(Entity target, boolean aggressive) Sets the current navigation to an entity target.
void	setTarget(Iterable<Vector> path) Sets the current navigation using a list of Vectors which will be followed in turn.
void	setTarget(Location target) Sets the current navigation to a Location destination.

Methods inherited from class java.lang.Object

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

Constructor Detail

CitizensNavigator

public CitizensNavigator(NPC npc)

Method Detail

cancelNavigation

public void cancelNavigation()

Description copied from interface: Navigator

Cancels any running navigation towards a target.

Specified by:

cancelNavigation in interface Navigator

getDefaultParameters

public NavigatorParameters getDefaultParameters()

Description copied from interface: Navigator

Returns the NavigatorParameters local to this navigator. These parameters are copied to local target parameters when a new target is started.

Specified by:

getDefaultParameters in interface Navigator

Returns:

The default parameters

See Also:

Navigator.getLocalParameters()

getEntityTarget

public EntityTarget getEntityTarget()

Description copied from interface: Navigator

Returns the current EntityTarget of the navigator, if any. May return null.

Specified by:

getEntityTarget in interface Navigator

Returns:

The current entity target

getLocalParameters

public NavigatorParameters getLocalParameters()

Description copied from interface: Navigator

Returns the NavigatorParameters local to any current target execution. These are updated independently of the default parameters.

Specified by:

getLocalParameters in interface Navigator

Returns:

The local parameters

See Also:

Navigator.getDefaultParameters()

getNPC

public NPC getNPC()

Specified by:

getNPC in interface Navigator

Returns:

The NPC attached to this navigator

getPathStrategy

public PathStrategy getPathStrategy()

Specified by:

getPathStrategy in interface Navigator

Returns:

The current PathStrategy or null if the navigator is not pathfinding

getTargetAsLocation

public Location getTargetAsLocation()

Description copied from interface: Navigator

Returns the current Location being navigated towards - this is not necessarily permanent and may change, for example when pathing towards a moving Entity. May return null.

Specified by:

getTargetAsLocation in interface Navigator

Returns:

The target location

getTargetType

public TargetType getTargetType()

Specified by:

getTargetType in interface Navigator

Returns:

The current TargetType of the navigator

isNavigating

public boolean isNavigating()

Specified by:

isNavigating in interface Navigator

Returns:

Whether the navigator is currently pathing towards a target.

See Also:

Navigator.getTargetType()

isPaused

public boolean isPaused()

Specified by:

isPaused in interface Navigator

Returns:

Whether the navigator is currently paused

load

public void load(DataKey root)

onDespawn

public void onDespawn()

onSpawn

public void onSpawn()

run

public void run()

Specified by:

run in interface Runnable

save

public void save(DataKey root)

setPaused

public void setPaused(boolean paused)

Description copied from interface: Navigator

Sets whether the navigator is paused and shouldn't process the path for now.

Specified by:

setPaused in interface Navigator

Parameters:

paused - Whether the navigator should be paused or not

setTarget

public void setTarget(Entity target,
                      boolean aggressive)

Description copied from interface: Navigator

Sets the current navigation to an entity target.

Specified by:

setTarget in interface Navigator

Parameters:

target - The Entity to path towards

aggressive - Whether to attack the target when close enough

setTarget

public void setTarget(Iterable<Vector> path)

Description copied from interface: Navigator

Sets the current navigation using a list of Vectors which will be followed in turn.

Specified by:

setTarget in interface Navigator

Parameters:

path - The path

setTarget

public void setTarget(Location target)

Description copied from interface: Navigator

Sets the current navigation to a Location destination.

Specified by:

setTarget in interface Navigator

Parameters:

target - The destination