net.citizensnpcs.api.ai.goals

Class WanderGoal

java.lang.Object

net.citizensnpcs.api.ai.tree.BehaviorGoalAdapter

net.citizensnpcs.api.ai.goals.WanderGoal

All Implemented Interfaces:

Goal, Behavior, Listener

public class WanderGoal
extends BehaviorGoalAdapter
implements Listener

A sample Goal/Behavior that will wander within a certain radius or QuadTree.

Method Summary

Modifier and Type	Method and Description
static WanderGoal	createWithNPC(NPC npc)
static WanderGoal	createWithNPCAndRange(NPC npc, int xrange, int yrange)
static WanderGoal	createWithNPCAndRangeAndTree(NPC npc, int xrange, int yrange, com.google.common.base.Supplier<ch.ethz.globis.phtree.PhTreeSolid<Boolean>> tree)
static WanderGoal	createWithNPCAndRangeAndTreeAndFallback(NPC npc, int xrange, int yrange, com.google.common.base.Supplier<ch.ethz.globis.phtree.PhTreeSolid<Boolean>> tree, com.google.common.base.Function<NPC,Location> fallback) The full builder method.
void	onFinish(NavigationCompleteEvent event)
void	pause()
void	reset() Resets the goal and any resources or state it is holding.
BehaviorStatus	run() Ticks the behavior, optionally changing the state that it is in.
void	setDelay(int delay)
void	setXYRange(int xrange, int yrange)
boolean	shouldExecute()
void	unpause()

Methods inherited from class net.citizensnpcs.api.ai.tree.BehaviorGoalAdapter

create, run, shouldExecute

Methods inherited from class java.lang.Object

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

Method Detail

onFinish

public void onFinish(NavigationCompleteEvent event)

pause

public void pause()

reset

public void reset()

Description copied from interface: Goal

Resets the goal and any resources or state it is holding.

Specified by:

reset in interface Goal

Specified by:

reset in interface Behavior

run

public BehaviorStatus run()

Description copied from interface: Behavior

Ticks the behavior, optionally changing the state that it is in.

Specified by:

run in interface Behavior

Returns:

The new status

setDelay

public void setDelay(int delay)

setXYRange

public void setXYRange(int xrange,
                       int yrange)

shouldExecute

public boolean shouldExecute()

Specified by:

shouldExecute in interface Behavior

Returns:

Whether the behavior is ready to run

unpause

public void unpause()

createWithNPC

public static WanderGoal createWithNPC(NPC npc)

createWithNPCAndRange

public static WanderGoal createWithNPCAndRange(NPC npc,
                                               int xrange,
                                               int yrange)

createWithNPCAndRangeAndTree

public static WanderGoal createWithNPCAndRangeAndTree(NPC npc,
                                                      int xrange,
                                                      int yrange,
                                                      com.google.common.base.Supplier<ch.ethz.globis.phtree.PhTreeSolid<Boolean>> tree)

createWithNPCAndRangeAndTreeAndFallback

public static WanderGoal createWithNPCAndRangeAndTreeAndFallback(NPC npc,
                                                                 int xrange,
                                                                 int yrange,
                                                                 com.google.common.base.Supplier<ch.ethz.globis.phtree.PhTreeSolid<Boolean>> tree,
                                                                 com.google.common.base.Function<NPC,Location> fallback)

The full builder method.

Parameters:

npc - the NPC to wander

xrange - x/z range, in blocks

yrange - y range, in blocks

tree - an optional PhTreeSolid supplier to allow only wandering within a certain PhTreeSolid

fallback - an optional fallback location

Returns:

the built goal