Package 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 SummaryNested classes/interfaces inherited from interface net.citizensnpcs.trait.waypoint.WaypointProviderWaypointProvider.EnumerableWaypointProvider
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddDestination(Waypoint waypoint) voidaddDestinations(Collection<Waypoint> waypoint) voidvoidaddGuides(Collection<Waypoint> helper) createEditor(CommandSender sender, CommandContext args) Creates anWaypointEditorwith the givenCommandSender.booleanisPaused()Returns whether this provider has paused execution of waypoints.voidvoidonRemove()Called when the provider is removed from the NPC.voidCalled when theNPCattached to this provider is spawned.voidvoidsetPaused(boolean paused) Pauses waypoint execution.Returns destination and guide waypoints.
- 
Constructor Details- 
GuidedWaypointProviderpublic GuidedWaypointProvider()
 
- 
- 
Method Details- 
addDestination
- 
addDestinations
- 
addGuide
- 
addGuides
- 
createEditorDescription copied from interface:WaypointProviderCreates anWaypointEditorwith the givenCommandSender.- Specified by:
- createEditorin interface- WaypointProvider
- Parameters:
- sender- The player to link the editor with
- args-
- Returns:
- The editor
 
- 
isPausedpublic boolean isPaused()Description copied from interface:WaypointProviderReturns whether this provider has paused execution of waypoints.- Specified by:
- isPausedin interface- WaypointProvider
- Returns:
- Whether the provider is paused.
 
- 
load- Specified by:
- loadin interface- Persistable
 
- 
onRemovepublic void onRemove()Description copied from interface:WaypointProviderCalled when the provider is removed from the NPC.- Specified by:
- onRemovein interface- WaypointProvider
 
- 
onSpawnDescription copied from interface:WaypointProviderCalled when theNPCattached to this provider is spawned.- Specified by:
- onSpawnin interface- WaypointProvider
- Parameters:
- npc- The attached NPC
 
- 
save- Specified by:
- savein interface- Persistable
 
- 
setPausedpublic void setPaused(boolean paused) Description copied from interface:WaypointProviderPauses waypoint execution.- Specified by:
- setPausedin interface- WaypointProvider
- Parameters:
- paused- Whether to pause waypoint execution.
 
- 
waypointsReturns destination and guide waypoints.- Specified by:
- waypointsin interface- WaypointProvider.EnumerableWaypointProvider
 
 
-