net.citizensnpcs.api.ai.tree

Class Decorator

java.lang.Object

net.citizensnpcs.api.ai.tree.BehaviorGoalAdapter

net.citizensnpcs.api.ai.tree.Decorator

All Implemented Interfaces:

Goal, Behavior

public class Decorator
extends BehaviorGoalAdapter

A decorator is a wrapper over a Behavior, which can add functionality such as filtering BehaviorStatuses, conditions, timer loops and more without knowing the internals of the behavior it wraps. Note that there are often simpler alternatives to a full-blown decorator, which has to be generic for many different scenarios.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Decorator.Builder

Method Summary

Modifier and Type	Method and Description
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.
boolean	shouldExecute()
static Decorator.Builder	wrapping(Behavior toWrap)

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

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

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

Returns:

The new status

shouldExecute

public boolean shouldExecute()

Returns:

Whether the behavior is ready to run

wrapping

public static Decorator.Builder wrapping(Behavior toWrap)