| ActionNode |
| Hierarchy: |
| Namespace |
BehaviorTreeEngine |
| Parent class |
TreeNonRootNode |
| Description: |
| Action Node represents a type of Leaf Node that is used to alter the state of the game. The ActionNode class is a MonoBehaviorNodeBase and performs the corresponding responses of an Action Node instance from the behavior tree engine on the Unity engine side. The ActionNode class inherits some virtual functions of OnStep, OnConstruct, OnDestruct, OnReset, OnPause and OnStop for a derived class, i.e., NewActionNode, to override. |
| Inherited Variables: |
| nodeType |
The node type of this mono behavior node. |
| forestIndex |
The forest index of this mono behavior node. |
| treeIndex |
The tree index of this mono behavior node. |
| nodeIndex |
The node index of this mono behavior node. |
| forestName |
The forest name of this mono behavior node. |
| treeName |
The tree name of this mono behavior node. |
| nodeName |
The node name of this mono behavior node. |
| Inherited Functions: |
| Init |
Initialize the properties of this mono behavior node. |
| OnStep |
A node operation that is invoked when executing the Action Node. |
| OnConstruct |
A node operation that is invoked when loading the tree. |
| OnDestruct |
A node operation that is invoked when destroying the tree. |
| OnReset |
A node operation that is invoked when resetting the tree. |
| OnPause |
A node operation that is invoked when pausing the tree. |
| OnStop |
A node operation that is invoked when stopping the tree. |
| Deprecated Functions: |
| OnExecute, OnReport, OnNotify, OnTest. |
|
| ActionNode.nodeType |
| Signature: |
| MonoBehaviorNodeType ActionNode.nodeType |
| Description: |
| The node type of this mono behavior node, which is always MonoBehaviorNodeType.Action. |
|
| ActionNode.OnStep |
| Signature: |
| bool ActionNode.OnStep() |
| Description: |
| A node operation that is invoked when executing the Action Node. This operation is getting invoked every frame repeatedly until returning a true. Based on the Action Node Policy, the OnStep operation of the Action Node always reports a fixed node status of either Success or Failure after performing the node task to its parent node. Override this method in a derived class of ActionNode. |
| Return Value: |
| True when this operation has done repeat; false otherwise. |
|
| ActionNode.OnConstruct |
| Signature: |
| void ActionNode.OnConstruct() |
| Description: |
| A node operation that is invoked when loading the tree. Override this method in a derived class of ActionNode. |
|
| ActionNode.OnDestruct |
| Signature: |
| void ActionNode.OnDestruct() |
| Description: |
| A node operation that is invoked when destroying the tree. Override this method in a derived class of ActionNode. |
|
| ActionNode.OnReset |
| Signature: |
| void ActionNode.OnReset() |
| Description: |
| A node operation that is invoked when resetting the tree. Override this method in a derived class of ActionNode. |
|
| ActionNode.OnPause |
| Signature: |
| void ActionNode.OnPause() |
| Description: |
| A node operation that is invoked when pausing the tree. Override this method in a derived class of ActionNode. |
|
| ActionNode.OnStop |
| Signature: |
| void ActionNode.OnStop() |
| Description: |
| A node operation that is invoked when stopping the tree. Override this method in a derived class of ActionNode. |
