net.citizensnpcs.trait.waypoint

Class GuidedWaypointProvider

java.lang.Object

net.citizensnpcs.trait.waypoint.GuidedWaypointProvider

All Implemented Interfaces:

Persistable, WaypointProvider, WaypointProvider.EnumerableWaypointProvider

public class GuidedWaypointProvider
extends Object
implements WaypointProvider.EnumerableWaypointProvider

Stores guided waypoint info. Guided waypoints are a list of Waypoints that will be navigated between randomly. Helper waypoints can be used to guide navigation between the random waypoints i.e. navigating between guide waypoints. For example, you might have a "realistic" NPC that walks between houses using helper waypoints placed along the roads.

Nested Class Summary

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

WaypointProvider.EnumerableWaypointProvider

Constructor Summary

Constructors

Constructor and Description
GuidedWaypointProvider()

Method Summary

Modifier and Type	Method and Description
void	addHelperWaypoint(Waypoint helper)
void	addHelperWaypoints(Collection<Waypoint> helper)
void	addWaypoint(Waypoint waypoint)
void	addWaypoints(Collection<Waypoint> waypoint)
WaypointEditor	createEditor(CommandSender sender, CommandContext args) Creates an WaypointEditor with the given CommandSender.
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	setPaused(boolean paused) Pauses waypoint execution.
Iterable<Waypoint>	waypoints() Returns available and helper waypoints.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuidedWaypointProvider

public GuidedWaypointProvider()

Method Detail

addHelperWaypoint

public void addHelperWaypoint(Waypoint helper)

addHelperWaypoints

public void addHelperWaypoints(Collection<Waypoint> helper)

addWaypoint

public void addWaypoint(Waypoint waypoint)

addWaypoints

public void addWaypoints(Collection<Waypoint> waypoint)

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

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

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 available and helper waypoints.

Specified by:

waypoints in interface WaypointProvider.EnumerableWaypointProvider