com.almasb.fxgl.ai.btree.branch

Class Sequence<E>

java.lang.Object

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

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

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

com.almasb.fxgl.ai.btree.branch.Sequence<E>

Type Parameters:

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

Direct Known Subclasses:

RandomSequence

public class Sequence<E>
extends SingleRunningChildBranch<E>

A Sequence is a branch task that runs every children until one of them fails. If a child task succeeds, the selector will start and run the next child task.

Author:

implicit-invocation

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

currentChildIndex, randomChildren

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

children

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

control, status, tree

Constructor Summary

Constructors

Constructor and Description
Sequence() Creates a Sequence branch with no children.
Sequence(Array<Task<E>> tasks) Creates a Sequence branch with the given children.
Sequence(Task<E>... tasks) Creates a Sequence branch with the given children.

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

cancelRunningChildren, childRunning, copyTo, createRandomChildren, reset, run, start

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

addChildToTask, getChild, getChildCount

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Sequence

public Sequence()

Creates a Sequence branch with no children.

Sequence

public Sequence(Array<Task<E>> tasks)

Creates a Sequence branch with the given children.

Parameters:

tasks - the children of this task

Sequence

public Sequence(Task<E>... tasks)

Creates a Sequence branch with the given children.

Parameters:

tasks - the children of this task

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 SingleRunningChildBranch<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 SingleRunningChildBranch<E>

Parameters:

runningTask - the task that failed