Package 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 block region.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WanderGoal.Builder

Method Summary

Modifier and Type	Method	Description
static WanderGoal.Builder	builder(NPC npc)
void	pause()
void	reset()	Resets the goal and any resources or state it is holding.
BehaviorStatus	run()	Runs the behavior for one 'tick', optionally changing the state that it is in.
void	setDelay(int delayTicks)
void	setPathfind(boolean pathfind)
void	setXYRange(int xrange, int yrange)
boolean	shouldExecute()	Returns whether the behavior is ready to run.
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 Details

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 Behavior

Specified by:

reset in interface Goal

run

public BehaviorStatus run()

Description copied from interface: Behavior

Runs the behavior for one 'tick', optionally changing the state that it is in.

Specified by:

run in interface Behavior

Returns:

The new state

setDelay

public void setDelay(int delayTicks)

setPathfind

public void setPathfind(boolean pathfind)

setXYRange

public void setXYRange(int xrange,
 int yrange)

shouldExecute

public boolean shouldExecute()

Description copied from interface: Behavior

Returns whether the behavior is ready to run. Note this is called once when deciding whether to start execution of a leaf node. The actual execution status is determined by the return value of Behavior.run() which is repeatedly called by the executing node.

Specified by:

shouldExecute in interface Behavior

unpause

public void unpause()

builder

public static WanderGoal.Builder builder(NPC npc)