com.almasb.fxgl.ai.btree.decorator

Class UntilFail<E>

java.lang.Object

com.almasb.fxgl.ai.btree.Task<E>

com.almasb.fxgl.ai.btree.Decorator<E>

com.almasb.fxgl.ai.btree.LoopDecorator<E>

com.almasb.fxgl.ai.btree.decorator.UntilFail<E>

Type Parameters:

E - type of the blackboard object that tasks use to read or modify game state

public class UntilFail<E>
extends LoopDecorator<E>

The UntilFail decorator will repeat the wrapped task until that task fails, which makes the decorator succeed.

Notice that a wrapped task that always succeeds without entering the running status will cause an infinite loop in the current frame.

Author:

implicit-invocation, davebaol

Nested Class Summary

Nested classes/interfaces inherited from class com.almasb.fxgl.ai.btree.Task

Task.Status

Field Summary

Fields inherited from class com.almasb.fxgl.ai.btree.LoopDecorator

loop

Fields inherited from class com.almasb.fxgl.ai.btree.Decorator

child

Fields inherited from class com.almasb.fxgl.ai.btree.Task

control, status, tree

Constructor Summary

Constructors

Constructor and Description
UntilFail() Creates an UntilFail decorator with no child.
UntilFail(Task<E> task) Creates an UntilFail decorator with the given child.

Method Summary

Modifier and Type	Method and Description
void	childFail(Task<E> runningTask) This method will be called when one of the children of this task fails.
void	childSuccess(Task<E> runningTask) This method will be called when one of the children of this task succeeds.

Methods inherited from class com.almasb.fxgl.ai.btree.LoopDecorator

childRunning, condition, run

Methods inherited from class com.almasb.fxgl.ai.btree.Decorator

addChildToTask, copyTo, getChild, getChildCount

Methods inherited from class com.almasb.fxgl.ai.btree.Task

addChild, cancel, cancelRunningChildren, checkGuard, cloneTask, end, fail, getEntity, getGuard, getStatus, reset, running, setControl, setGuard, start, success

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UntilFail

public UntilFail()

Creates an UntilFail decorator with no child.

UntilFail

public UntilFail(Task<E> task)

Creates an UntilFail decorator with the given child.

Parameters:

task - the child task to wrap

Method Detail

childSuccess

public void childSuccess(Task<E> runningTask)

Description copied from class: Task

This method will be called when one of the children of this task succeeds.

Overrides:

childSuccess in class Decorator<E>

Parameters:

runningTask - the task that succeeded

childFail

public void childFail(Task<E> runningTask)

Description copied from class: Task

This method will be called when one of the children of this task fails.

Overrides:

childFail in class Decorator<E>

Parameters:

runningTask - the task that failed