com.almasb.fxgl.ai.btree.leaf

Class Failure<E>

java.lang.Object

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

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

com.almasb.fxgl.ai.btree.leaf.Failure<E>

Type Parameters:

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

public class Failure<E>
extends LeafTask<E>

Failure is a leaf that immediately fails.

Author:

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.Task

control, status, tree

Constructor Summary

Constructors

Constructor and Description
Failure() Creates a Failure task.

Method Summary

Modifier and Type	Method and Description
protected Task<E>	copyTo(Task<E> task) Copies this task to the given task.
Task.Status	execute() Executes this Failure task.

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

addChildToTask, childFail, childRunning, childSuccess, getChild, getChildCount, run

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

Failure

public Failure()

Creates a Failure task.

Method Detail

execute

public Task.Status execute()

Executes this Failure task.

Specified by:

execute in class LeafTask<E>

Returns:

Status#FAILED.

copyTo

protected Task<E> copyTo(Task<E> task)

Description copied from class: Task

Copies this task to the given task.

Specified by:

copyTo in class Task<E>

Parameters:

task - the task to be filled

Returns:

the given task for chaining