com.badlogic.gdx.ai.btree.utils

Class BehaviorTreeLibrary

java.lang.Object

com.badlogic.gdx.ai.btree.utils.BehaviorTreeLibrary

public class BehaviorTreeLibrary
extends java.lang.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.

Field Summary

Fields

Modifier and Type	Field and Description
protected BehaviorTreeParser<?>	parser
protected com.badlogic.gdx.utils.ObjectMap<java.lang.String,BehaviorTree<?>>	repository
protected com.badlogic.gdx.assets.loaders.FileHandleResolver	resolver

Constructor Summary

Constructors

Constructor and Description
BehaviorTreeLibrary() Creates a BehaviorTreeLibrary using the new internal resolver returned by the call GdxAI.getFileSystem().newResolver(FileType.Internal).
BehaviorTreeLibrary(com.badlogic.gdx.assets.loaders.FileHandleResolver resolver) Creates a BehaviorTreeLibrary with the given resolver.
BehaviorTreeLibrary(com.badlogic.gdx.assets.loaders.FileHandleResolver resolver, int parseDebugLevel) Creates a BehaviorTreeLibrary with the given resolver and debug level.
BehaviorTreeLibrary(int parseDebugLevel) Creates a BehaviorTreeLibrary with the given debug level and using the new internal resolver returned by the call GdxAI.getFileSystem().newResolver(FileType.Internal).

Method Summary

Modifier and Type	Method and Description
<T> BehaviorTree<T>	createBehaviorTree(java.lang.String treeReference) Creates the BehaviorTree for the specified reference.
<T> BehaviorTree<T>	createBehaviorTree(java.lang.String treeReference, T blackboard) Creates the BehaviorTree for the specified reference and blackboard object.
<T> Task<T>	createRootTask(java.lang.String treeReference) Creates the root task of BehaviorTree for the specified reference.
boolean	hasArchetypeTree(java.lang.String treeReference) Returns true if an archetype tree with the specified reference is registered in this library.
void	registerArchetypeTree(java.lang.String treeReference, BehaviorTree<?> archetypeTree) Registers the BehaviorTree archetypeTree with the specified reference.
protected BehaviorTree<?>	retrieveArchetypeTree(java.lang.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 com.badlogic.gdx.utils.ObjectMap<java.lang.String,BehaviorTree<?>> repository

resolver

protected com.badlogic.gdx.assets.loaders.FileHandleResolver resolver

parser

protected BehaviorTreeParser<?> parser

Constructor Detail

BehaviorTreeLibrary

public BehaviorTreeLibrary()

Creates a BehaviorTreeLibrary using the new internal resolver returned by the call GdxAI.getFileSystem().newResolver(FileType.Internal).

BehaviorTreeLibrary

public BehaviorTreeLibrary(int parseDebugLevel)

Creates a BehaviorTreeLibrary with the given debug level and using the new internal resolver returned by the call GdxAI.getFileSystem().newResolver(FileType.Internal).

Parameters:

parseDebugLevel - the debug level the parser will use

BehaviorTreeLibrary

public BehaviorTreeLibrary(com.badlogic.gdx.assets.loaders.FileHandleResolver resolver)

Creates a BehaviorTreeLibrary with the given resolver.

Parameters:

resolver - the FileHandleResolver

BehaviorTreeLibrary

public BehaviorTreeLibrary(com.badlogic.gdx.assets.loaders.FileHandleResolver resolver,
                           int parseDebugLevel)

Creates a BehaviorTreeLibrary with the given resolver and debug level.

Parameters:

resolver - the FileHandleResolver

parseDebugLevel - the debug level the parser will use

Method Detail

createRootTask

public <T> Task<T> createRootTask(java.lang.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:

com.badlogic.gdx.utils.SerializationException - if the reference cannot be successfully parsed.

TaskCloneException - if the archetype cannot be successfully parsed.

createBehaviorTree

public <T> BehaviorTree<T> createBehaviorTree(java.lang.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:

com.badlogic.gdx.utils.SerializationException - if the reference cannot be successfully parsed.

TaskCloneException - if the archetype cannot be successfully parsed.

createBehaviorTree

public <T> BehaviorTree<T> createBehaviorTree(java.lang.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:

com.badlogic.gdx.utils.SerializationException - if the reference cannot be successfully parsed.

TaskCloneException - if the archetype cannot be successfully parsed.

retrieveArchetypeTree

protected BehaviorTree<?> retrieveArchetypeTree(java.lang.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:

com.badlogic.gdx.utils.SerializationException - if the reference cannot be successfully parsed.

registerArchetypeTree

public void registerArchetypeTree(java.lang.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:

java.lang.IllegalArgumentException - if the archetypeTree is null

hasArchetypeTree

public boolean hasArchetypeTree(java.lang.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.