com.almasb.fxgl.ai.btree.decorator

Class Include<E>

java.lang.Object

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

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

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

Type Parameters:

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

@TaskConstraint(minChildren=0,
                maxChildren=0)
public class Include<E>
extends Decorator<E>

An Include decorator grafts a subtree. When the subtree is grafted depends on the value of the lazy attribute: at clone-time if is false, at run-time if is true.

Author:

davebaol, implicit-invocation

Nested Class Summary

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

Task.Status

Field Summary

Fields

Modifier and Type	Field and Description
boolean	lazy Optional task attribute indicating whether the subtree should be included at clone-time (false, the default) or at run-time (true).
String	subtree Mandatory task attribute indicating the path of the subtree to include.

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
Include() Creates a non-lazy Include decorator without specifying the subtree.
Include(String subtree) Creates a non-lazy Include decorator for the specified subtree.
Include(String subtree, boolean lazy) Creates an eager or lazy Include decorator for the specified subtree.

Method Summary

Modifier and Type	Method and Description
Task<E>	cloneTask() Returns a clone of the referenced subtree if this Import is eager; otherwise returns a clone of itself.
protected Task<E>	copyTo(Task<E> task) Copies this Include to the given task.
void	start() The first call of this method lazily sets its child to the referenced subtree created through the BehaviorTreeLibraryManager.

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

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

subtree

public String subtree

Mandatory task attribute indicating the path of the subtree to include.

lazy

public boolean lazy

Optional task attribute indicating whether the subtree should be included at clone-time (false, the default) or at run-time (true).

Constructor Detail

Include

public Include()

Creates a non-lazy Include decorator without specifying the subtree.

Include

public Include(String subtree)

Creates a non-lazy Include decorator for the specified subtree.

Parameters:

subtree - the subtree reference, usually a path

Include

public Include(String subtree,
               boolean lazy)

Creates an eager or lazy Include decorator for the specified subtree.

Parameters:

subtree - the subtree reference, usually a path

lazy - whether inclusion should happen at clone-time (false) or at run-time (true)

Method Detail

start

public void start()

The first call of this method lazily sets its child to the referenced subtree created through the BehaviorTreeLibraryManager. Subsequent calls do nothing since the child has already been set. A UnsupportedOperationException is thrown if this Include is eager.

Overrides:

start in class Task<E>

Throws:

UnsupportedOperationException - if this Include is eager

cloneTask

public Task<E> cloneTask()

Returns a clone of the referenced subtree if this Import is eager; otherwise returns a clone of itself.

Overrides:

cloneTask in class Task<E>

Returns:

the cloned task

copyTo

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

Copies this Include to the given task. A TaskCloneException is thrown if this Include is eager.

Overrides:

copyTo in class Decorator<E>

Parameters:

task - the task to be filled

Returns:

the given task for chaining

Throws:

TaskCloneException - if this Include is eager.