Package net.citizensnpcs.trait.waypoint

Class LinearWaypointProvider

java.lang.Object

net.citizensnpcs.trait.waypoint.LinearWaypointProvider

All Implemented Interfaces:

Persistable, WaypointProvider, WaypointProvider.EnumerableWaypointProvider

public class LinearWaypointProvider
extends Object
implements WaypointProvider.EnumerableWaypointProvider

An ordered list of Waypoints to walk between.

Nested Class Summary

Nested classes/interfaces inherited from interface net.citizensnpcs.trait.waypoint.WaypointProvider

WaypointProvider.EnumerableWaypointProvider

Constructor Summary

Constructors

Constructor	Description
LinearWaypointProvider()
LinearWaypointProvider(NPC npc)

Method Summary

Modifier and Type	Method	Description
void	addWaypoint(Waypoint waypoint)
boolean	cachePaths()
WaypointEditor	createEditor(CommandSender sender, CommandContext args)	Creates an WaypointEditor with the given CommandSender.
boolean	cycleWaypoints()
Waypoint	getCurrentWaypoint()
boolean	isPaused()	Returns whether this provider has paused execution of waypoints.
void	load(DataKey key)
void	onRemove()	Called when the provider is removed from the NPC.
void	onSpawn(NPC npc)	Called when the NPC attached to this provider is spawned.
void	save(DataKey key)
void	setCachePaths(boolean cachePaths)
void	setCycle(boolean cycle)
void	setPaused(boolean paused)	Pauses waypoint execution.
Iterable<Waypoint>	waypoints()	Returns the modifiable list of waypoints.

Methods inherited from class java.lang.Object

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

Constructor Details

LinearWaypointProvider

public LinearWaypointProvider()

LinearWaypointProvider

public LinearWaypointProvider(NPC npc)

Method Details

addWaypoint

public void addWaypoint(Waypoint waypoint)

cachePaths

public boolean cachePaths()

createEditor

public WaypointEditor createEditor(CommandSender sender,
 CommandContext args)

Description copied from interface: WaypointProvider

Creates an WaypointEditor with the given CommandSender.

Specified by:

createEditor in interface WaypointProvider

Parameters:

sender - The player to link the editor with

Returns:

The editor

cycleWaypoints

public boolean cycleWaypoints()

getCurrentWaypoint

public Waypoint getCurrentWaypoint()

isPaused

public boolean isPaused()

Description copied from interface: WaypointProvider

Returns whether this provider has paused execution of waypoints.

Specified by:

isPaused in interface WaypointProvider

Returns:

Whether the provider is paused.

load

public void load(DataKey key)

Specified by:

load in interface Persistable

onRemove

public void onRemove()

Description copied from interface: WaypointProvider

Called when the provider is removed from the NPC.

Specified by:

onRemove in interface WaypointProvider

onSpawn

public void onSpawn(NPC npc)

Description copied from interface: WaypointProvider

Called when the NPC attached to this provider is spawned.

Specified by:

onSpawn in interface WaypointProvider

Parameters:

npc - The attached NPC

save

public void save(DataKey key)

Specified by:

save in interface Persistable

setCachePaths

public void setCachePaths(boolean cachePaths)

setCycle

public void setCycle(boolean cycle)

setPaused

public void setPaused(boolean paused)

Description copied from interface: WaypointProvider

Pauses waypoint execution.

Specified by:

setPaused in interface WaypointProvider

Parameters:

paused - Whether to pause waypoint execution.

waypoints

public Iterable<Waypoint> waypoints()

Returns the modifiable list of waypoints.

Specified by:

waypoints in interface WaypointProvider.EnumerableWaypointProvider