net.citizensnpcs.trait.waypoint

Class WanderWaypointProvider

java.lang.Object

net.citizensnpcs.trait.waypoint.WanderWaypointProvider

All Implemented Interfaces:

Function<NPC,Location>, Supplier<ch.ethz.globis.phtree.PhTreeSolid<Boolean>>, Persistable, WaypointProvider

public class WanderWaypointProvider
extends Object
implements WaypointProvider, com.google.common.base.Supplier<ch.ethz.globis.phtree.PhTreeSolid<Boolean>>, com.google.common.base.Function<NPC,Location>

A wandering waypoint provider that wanders between either a box centered at the current location or inside a region defined by a list of boxes.

Nested Class Summary

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

WaypointProvider.EnumerableWaypointProvider

Field Summary

Fields

Modifier and Type	Field and Description
int	delay
int	xrange
int	yrange

Constructor Summary

Constructors

Constructor and Description
WanderWaypointProvider()

Method Summary

Modifier and Type	Method and Description
void	addRegionCentre(Location centre)
void	addRegionCentres(Collection<Location> centre)
Location	apply(NPC npc)
WaypointEditor	createEditor(CommandSender sender, CommandContext args) Creates an WaypointEditor with the given CommandSender.
ch.ethz.globis.phtree.PhTreeSolid<Boolean>	get()
List<Location>	getRegionCentres()
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	removeRegionCentre(Location centre)
void	removeRegionCentres(Collection<Location> centre)
void	save(DataKey key)
void	setPaused(boolean paused) Pauses waypoint execution.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

delay

public int delay

xrange

public int xrange

yrange

public int yrange

Constructor Detail

WanderWaypointProvider

public WanderWaypointProvider()

Method Detail

addRegionCentre

public void addRegionCentre(Location centre)

addRegionCentres

public void addRegionCentres(Collection<Location> centre)

apply

public Location apply(NPC npc)

Specified by:

apply in interface Function<NPC,Location>

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

get

public ch.ethz.globis.phtree.PhTreeSolid<Boolean> get()

Specified by:

get in interface Supplier<ch.ethz.globis.phtree.PhTreeSolid<Boolean>>

getRegionCentres

public List<Location> getRegionCentres()

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

removeRegionCentre

public void removeRegionCentre(Location centre)

removeRegionCentres

public void removeRegionCentres(Collection<Location> centre)

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.