Warning: preg_replace(): Compilation failed: invalid range in character class at offset 4 in /home/customer/www/qualgame.com/public_html/wp-content/plugins/crayon-syntax-highlighter/crayon_langs.class.php on line 340
BtEngine | BtEngineSDK

BtEngine

BtEngine
Hierarchy:
Namespace BehaviorTreeEngine
Parent class N/A
Description:
BtEngine is the main class API that provides static member functions to manage, control and access all the runtime engine, forest, tree, and node instances and properties.
Static Functions – Engine Properties:
SetForestFile Sets the forest xml file name.
GetForestFile Gets the forest xml file name.
EnableParallelOp Enables or disables parallel operation, e.g., tree specific operation (enabled by default).
IsEnabledParallelOp Determines whether parallel operation is enabled or not.
GetForestCount Gets the number of forest instances.
GetEnginePropWrap Gets an engine property wrapper that contains all the information of the engine with the specified detail level.
Static Functions – Engine Operations:
Start Starts the engine with the forest xml file name that was previously set.
Start Starts the engine with the specified forest xml file name.
Update Updates the engine.
Shutdown Shuts down the engine.
IsOn Determines whether the engine is on.
Static Functions – Group Tree Operations – Engine Level:
PlayAll Asynchronously starts to execute all tree instances in each forest with previously specified target loop count (0 by default) and basic play mode (Stop-By-Execut-Loop-Count by default).
PlayAll Asynchronously starts to execute all tree instances in each forest with the specified target loop count and basic play mode.
PauseAll Asynchronously pauses all tree instances in each forest.
ResumeAll Asynchronously resumes to execute all tree instances that were paused in each forest with tree specific remaining loop count.
StopAll Asynchronously stops all tree instances in each forest.
ResetAll Asynchronously resets all tree instances in each forest.
LoadAll Asynchronously instantiates all the trees and forests whose instances don’t exist from the forest xml file and tree xml files.
DestroyAll Asynchronously deletes all forest instances and all tree instances in each forest.
Static Functions – Forest Properties:
Exist Determines whether a forest instance with the specified (forest) name/index exists.
GetNodeType Gets the node type of a forest instance with the specified (forest) name/index.
GetIndex
GetName
Gets the index/name of a forest instance with the specified (forest) name/index.
GetTreeCount Gets the number of tree instances in a forest with the specified (forest) name/index.
GetForestPropWrap Gets a forest property wrapper that contains all the information of a forest instance with the specified detail level and (forest) name/index.
Static Functions – Group Tree Operations – Forest Level:
Play Asynchronously starts to execute all tree instances in a forest with the specified (forest) name/index, previously specified target loop count (0 by default) and basic play mode (Stop-By-Execute-Loop-Count by default).
Play Asynchronously starts to execute all tree instances in a forest with the specified (forest) name/index, target loop count and basic play mode.
Pause Asynchronously pauses all tree instances in a forest with the specified (forest) name/index.
Resume Asynchronously resumes to execute all tree instances that were paused in a forest with the specified (forest) name/index and tree specific remaining loop count.
Stop Asynchronously stops all tree instances in a forest with the specified (forest) name/index.
Reset Asynchronously resets all tree instances in a forest with the specified (forest) name/index.
Load Asynchronously instantiates all the trees whose instances don’t exist in a forest with the specified (forest) name/index, as well as the forest itself if its instance doesn’t exist, form the forest xml file and tree xml files.
Destroy Asynchronously deletes the forest instance and all tree instances in it with the specified (forest) name/index.
Static Functions – Tree Properties:
Exist Determines whether a tree instance with the specified (forest, tree) names/indices exists.
GetNodeType Gets the node type of a tree instance with the specified (forest, tree) names/indices.
GetIndex
GetName
Gets the index/name of a tree instance with the specified (forest, tree) names/indices.
GetTreeStatus Gets the status of a tree instance with the specified (forest, tree) names/indices.
GetBasicPlayMode Gets the basic play mode of a tree instance with the specified (forest, tree) names/indices.
GetTgtLoopCount Gets the target loop count of a tree instance with the specified (forest, tree) names/indices.
GetAccuLoopCount Gets the accumulated loop count of a tree instance with the specified (forest, tree) names/indices.
GetNodeCount Gets the number of node instances in a tree with the specified (forest, tree) names/indices.
GetTreePropWrap Gets a tree property wrapper that contains all the information of a tree instance with the specified detail level, and (forest, tree) names/indices.
Static Functions – Tree Operations:
Play Asynchronously starts to execute a tree instance with the specified (forest, tree) names/indices, previously specified target loop count (0 by default) and basic play mode (Stop-By-Execute-Loop-Count by default).
Play Asynchronously starts to execute a tree instance with the specified (forest, tree) names/indices, target loop count and basic play mode.
Pause Asynchronously pauses a tree instance with the specified (forest, tree) names/indices.
Resume Asynchronously resumes to execute a tree instance if it was paused with the specified (forest, tree) names/indices and its remaining loop count.
Stop Asynchronously stops a tree instance with the specified (forest, tree) names/indices.
Reset Asynchronously resets a tree instance with the specified (forest, tree) names/indices.
Load Asynchronously instantiates a tree if its instance doesn’t exist with the specified (forest, tree) names/indices, as well as the forest itself if its instance doesn’t exist, from the forest xml file and tree xml file.
Destroy Asynchronously deletes a tree instance with the specified (forest, tree) names/indices, as well as the forest instance if there is no other tree instance left in the forest.
Static Functions – Node Properties:
Exist Determines whether a node instance with the specified (forest, tree, node) names/indices exists.
GetNodeType Gets the node type of a node instance with the specified (forest, tree, node) names/indices.
GetIndex
GetName
Gets the index/name of a node instance with the specified (forest, tree, node) names/indices.
GetNodePolicy Gets the node policy of a node instance with specified (forest, tree, node) names/indices.
GetNodePropWrap Gets a node property wrapper that contains all the information of a node instance with the specified (forest, tree, node) names/indices.

 

BtEngine.NodeUserAttr
Hierarchy:
Namespace BehaviorTreeEngine
Parent class N/A
Description:
BtEngine.NodeUserAttr is the class API that provides static member functions to access node user attributes which can be added to each node in the Node Attribute Table Window from Bt Studio.
Static Functions:
Get Gets a dictionary that contains all the user attribute key-value pairs.
Count Gets the number of user attributes.
ContainsKey Determines whether a node contains a user attribute associated with the specified key.
GetValue Gets the value of a user attribute associated with the specified key.

 

BtEngine.MonoBehaviorNode
Hierarchy:
Namespace BehaviorTreeEngine
Parent class N/A
Description:
BtEngine.MonoBehaviorNode is the class API that provides static member functions to manage mono behavior nodes.
Static Functions:
Register Registers the specified mono behavior node associated with the specified index for searching and invoking node operations.
RegisterAllByName Registers all existing mono behavior nodes that were registered by their indices with their names.
IsRegistered Determines whether a mono behavior node with the specified index/name is registered.
Find Finds a mono behavior node associated with the specified index/name.
Deregister Deregisters a mono behavior node with the specified index/name.
DeregisterAll Deregisters all mono behavior nodes.
Count Gets the number of mono behavior nodes.
GetEnumerable Get the IEnumerable interface to all registered mono behavior nodes.