Package net.citizensnpcs.api.ai.tree

Class Precondition

java.lang.Object

net.citizensnpcs.api.ai.tree.BehaviorGoalAdapter

net.citizensnpcs.api.ai.tree.Precondition

All Implemented Interfaces:

Goal, Behavior

public abstract class Precondition
extends BehaviorGoalAdapter

Field Summary

Fields

Modifier and Type	Field	Description
protected final Supplier<Boolean>	condition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Precondition(Supplier<Boolean> condition)

Method Summary

Modifier and Type	Method	Description
static Precondition	runPrecondition(Supplier<Boolean> condition)	Creates a Precondition that returns either BehaviorStatus.SUCCESS or BehaviorStatus.FAILURE depending on the underlying condition's return status.
static Precondition	wrappingPrecondition(Behavior wrapping, Supplier<Boolean> condition)	Creates a Precondition that wraps the shouldExecute method in Behavior.

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

Methods inherited from interface net.citizensnpcs.api.ai.tree.Behavior

reset, run, shouldExecute

Methods inherited from interface net.citizensnpcs.api.ai.Goal

reset

Field Details

condition

protected final Supplier<Boolean> condition

Constructor Details

Precondition

protected Precondition(Supplier<Boolean> condition)

Method Details

runPrecondition

public static Precondition runPrecondition(Supplier<Boolean> condition)

Creates a Precondition that returns either BehaviorStatus.SUCCESS or BehaviorStatus.FAILURE depending on the underlying condition's return status.

Parameters:

condition - The condition to check while executing

Returns:

The precondition behavior

wrappingPrecondition

public static Precondition wrappingPrecondition(Behavior wrapping,
 Supplier<Boolean> condition)

Creates a Precondition that wraps the shouldExecute method in Behavior. When shouldExecute is called, the given condition will be checked before the wrapped behavior's method is called.

Parameters:

wrapping - The behavior to wrap calls to

condition - The execution condition

Returns:

The precondition behavior