Package net.citizensnpcs.api.ai.goals

Class FollowPathGoal

java.lang.Object

net.citizensnpcs.api.ai.tree.BehaviorGoalAdapter

net.citizensnpcs.api.ai.goals.FollowPathGoal

All Implemented Interfaces:

Goal, Behavior

public class FollowPathGoal
extends BehaviorGoalAdapter

A sample Goal/Behavior that simply moves an NPC through a list of Locations.

Constructor Summary

Constructors

Constructor	Description
FollowPathGoal(NPC npc, List<MoveToGoal> path)

Method Summary

Modifier and Type	Method	Description
static FollowPathGoal	create(NPC npc, List<MoveToGoal> path)
static FollowPathGoal	createFromLocations(NPC npc, List<Location> path)
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.
boolean	shouldExecute()	Returns whether the behavior is ready to run.

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

Constructor Details

FollowPathGoal

public FollowPathGoal(NPC npc,
 List<MoveToGoal> path)

Method Details

reset

public void reset()

Description copied from interface: Goal

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

run

public BehaviorStatus run()

Description copied from interface: Behavior

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

Returns:

The new state

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.

create

public static FollowPathGoal create(NPC npc,
 List<MoveToGoal> path)

createFromLocations

public static FollowPathGoal createFromLocations(NPC npc,
 List<Location> path)