com.almasb.fxgl.ai.btree.leaf

Class Success<E>

java.lang.Object

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

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

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

Type Parameters:

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

public class Success<E>
extends LeafTask<E>

Success is a leaf that immediately succeeds.

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, guard, status, TASK_CLONER, tree

Constructor Summary

Constructors

Constructor and Description
Success() Creates a Success 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 Success 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, getGuard, getObject, 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

Success

public Success()

Creates a Success task.

Method Detail

execute

public Task.Status execute()

Executes this Success task.

Specified by:

execute in class LeafTask<E>

Returns:

Status#SUCCEEDED.

copyTo

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

Description copied from class: Task

Copies this task to the given task. This method is invoked by Task.cloneTask() only if Task.TASK_CLONER is null which is its default value.

Specified by:

copyTo in class Task<E>

Parameters:

task - the task to be filled

Returns:

the given task for chaining