Property Wrappers

Table of contents

1. EnginePropWrap
2. ForestPropWrap
3. TreePropWrap
4. NodePropWrap

1. EnginePropWrap
Hierarchy:
Namespace BehaviorTreeEngine
Parent class N/A
Description:
A property wrapper class that contains a copy of basic properties of the engine.
Variables:
forestFile The name of the forest xml file that is currently set in the engine.
forestList A list of forest property wrappers of the existing forest instances in the engine.
2. ForestPropWrap
Hierarchy:
Namespace BehaviorTreeEngine
Parent class N/A
Description:
A property wrapper class that contains a copy of basic properties of a forest instance.
Variables:
forestName The name of the underlying forest instance.
forestIndex The index of the underlying forest instance.
forestUserAttr The user defined attributes of the underlying forest instance.
treeList A list of tree property wrappers of all the existing tree instances in the underlying forest instance.
3. TreePropWrap
Hierarchy:
Namespace BehaviorTreeEngine
Parent class N/A
Description:
A property wrapper that contains a copy of basic properties of a tree instance.
Variables:
treeName The name of the underlying tree instance.
treeIndex The index of the underlying tree instance.
treeStatus The status of the underlying tree instance.
basicPlayMode The basic play mode of the underlying tree instance.
tgtLoopCount The target loop count of the underlying tree instance.
accuLoopCount The accumulated loop count of the underlying tree instance.
treeUserAttr The user defined attributes of the underlying tree instance.
nodeList A list of node property wrappers of all the existing node instances in the underlying tree instance.
4. NodePropWrap
Hierarchy:
Namespace BehaviorTreeEngine
Parent class N/A
Description:
A property wrapper class that contains a copy of basic properties of a node instance.
Variables:
nodeName The name of the underlying node instance.
nodeIndex The index of the underlying node instance.
nodeType The node type of the underlying node instance.
parallelNodePolicy The parallel node policy of the underlying node instance if the node type is parallel node.
actionNodePolicy The action node policy of the underlying node instance if the node type is action node.
nodeUserAttr The user defined attributes of the underlying node instance.