net.citizensnpcs.api.ai.tree

Class TimerDecorator

java.lang.Object

net.citizensnpcs.api.ai.tree.BehaviorGoalAdapter

net.citizensnpcs.api.ai.tree.TimerDecorator

All Implemented Interfaces:

Goal, Behavior

public class TimerDecorator
extends BehaviorGoalAdapter

Wraps a Behavior and enforces a tick limit, after which it will return BehaviorStatus.FAILURE and reset the child Behavior.

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 TimerDecorator	tickLimiter(Behavior wrapping, int tickLimit)

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

tickLimiter

public static TimerDecorator tickLimiter(Behavior wrapping,
                                         int tickLimit)