com.almasb.fxgl.ai.btree.utils

Class BehaviorTreeLibrary

java.lang.Object

com.almasb.fxgl.ai.btree.utils.BehaviorTreeLibrary

public class BehaviorTreeLibrary
extends Object

A BehaviorTreeLibrary is a repository of behavior tree archetypes. Behavior tree archetypes never run. Indeed, they are only cloned to create behavior tree instances that can run.

Author:

davebaol

Field Summary

Fields

Modifier and Type	Field and Description
protected BehaviorTreeParser<?>	parser
protected ObjectMap<String,BehaviorTree<?>>	repository

Constructor Summary

Constructors

Constructor and Description
BehaviorTreeLibrary()

Method Summary

Modifier and Type	Method and Description
<T> BehaviorTree<T>	createBehaviorTree(String treeReference) Creates the BehaviorTree for the specified reference.
<T> BehaviorTree<T>	createBehaviorTree(String treeReference, T blackboard) Creates the BehaviorTree for the specified reference and blackboard object.
<T> Task<T>	createRootTask(String treeReference) Creates the root task of BehaviorTree for the specified reference.
boolean	hasArchetypeTree(String treeReference) Returns true if an archetype tree with the specified reference is registered in this library.
void	registerArchetypeTree(String treeReference, BehaviorTree<?> archetypeTree) Registers the BehaviorTree archetypeTree with the specified reference.
protected BehaviorTree<?>	retrieveArchetypeTree(String treeReference) Retrieves the archetype tree from the library.

Methods inherited from class java.lang.Object

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

Field Detail

repository

protected ObjectMap<String,BehaviorTree<?>> repository

parser

protected BehaviorTreeParser<?> parser

Constructor Detail

BehaviorTreeLibrary

public BehaviorTreeLibrary()

Method Detail

createRootTask

public <T> Task<T> createRootTask(String treeReference)

Creates the root task of BehaviorTree for the specified reference.

Parameters:

treeReference - the tree identifier, typically a path

Returns:

the root task of the tree cloned from the archetype.

Throws:

RuntimeException - if the reference cannot be successfully parsed.

TaskCloneException - if the archetype cannot be successfully parsed.

createBehaviorTree

public <T> BehaviorTree<T> createBehaviorTree(String treeReference)

Creates the BehaviorTree for the specified reference.

Parameters:

treeReference - the tree identifier, typically a path

Returns:

the tree cloned from the archetype.

Throws:

RuntimeException - if the reference cannot be successfully parsed.

TaskCloneException - if the archetype cannot be successfully parsed.

createBehaviorTree

public <T> BehaviorTree<T> createBehaviorTree(String treeReference,
                                              T blackboard)

Creates the BehaviorTree for the specified reference and blackboard object.

Parameters:

treeReference - the tree identifier, typically a path

blackboard - the blackboard object (it can be null).

Returns:

the tree cloned from the archetype.

Throws:

RuntimeException - if the reference cannot be successfully parsed.

TaskCloneException - if the archetype cannot be successfully parsed.

retrieveArchetypeTree

protected BehaviorTree<?> retrieveArchetypeTree(String treeReference)

Retrieves the archetype tree from the library. If the library doesn't contain the archetype tree it is loaded and added to the library.

Parameters:

treeReference - the tree identifier, typically a path

Returns:

the archetype tree.

Throws:

RuntimeException - if the reference cannot be successfully parsed.

registerArchetypeTree

public void registerArchetypeTree(String treeReference,
                                  BehaviorTree<?> archetypeTree)

Registers the BehaviorTree archetypeTree with the specified reference. Existing archetypes in the repository with the same treeReference will be replaced.

Parameters:

treeReference - the tree identifier, typically a path.

archetypeTree - the archetype tree.

Throws:

IllegalArgumentException - if the archetypeTree is null

hasArchetypeTree

public boolean hasArchetypeTree(String treeReference)

Returns true if an archetype tree with the specified reference is registered in this library.

Parameters:

treeReference - the tree identifier, typically a path.

Returns:

true if the archetype is registered already; false otherwise.