Package net.citizensnpcs.api.ai.tree

Class Selector

java.lang.Object

net.citizensnpcs.api.ai.tree.BehaviorGoalAdapter

net.citizensnpcs.api.ai.tree.Composite

net.citizensnpcs.api.ai.tree.Selector

All Implemented Interfaces:

Goal, Behavior

public class Selector
extends Composite

A selector of sub-goals, that chooses a single Behavior to execute from a list. The default selection function is a random selection but this can be specified in the builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Selector.Builder

Method Summary

Modifier and Type	Method	Description
Behavior	getNextBehavior()
Function<List<Behavior>,Behavior>	getSelectionFunction()
void	reset()	Resets the goal and any resources or state it is holding.
boolean	retryChildren()
BehaviorStatus	run()	Runs the behavior for one 'tick', optionally changing the state that it is in.
static Selector.Builder	selecting(Collection<Behavior> behaviors)
static Selector.Builder	selecting(Behavior... behaviors)
String	toString()

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

addBehavior, getBehaviors, removeBehavior, shouldExecute, stopExecution, tickParallel

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, wait, wait, wait

Method Details

getNextBehavior

public Behavior getNextBehavior()

getSelectionFunction

public Function<List<Behavior>,Behavior> getSelectionFunction()

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

Overrides:

reset in class Composite

retryChildren

public boolean retryChildren()

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

toString

public String toString()

Overrides:

toString in class Object

selecting

public static Selector.Builder selecting(Behavior... behaviors)

selecting

public static Selector.Builder selecting(Collection<Behavior> behaviors)