UBehaviorTreeComponent::UnregisterAuxNodesUpTo
#include "BehaviorTree/BehaviorTreeComponent.h"
Access: public
Description
Unregisters all auxiliary nodes (decorators and services) whose execution index is less important than the given index. Used when a higher-priority branch takes over.
Caveats & Gotchas
- • "Less important" compares by search order, not just position — an FBTNodeIndex encodes both instance and node index, so this can affect nodes across a specific priority range rather than a single instance.
- • Rarely called from custom node code — it's part of the tree's internal search bookkeeping invoked when active branches change.
Signature
void UnregisterAuxNodesUpTo(const FBTNodeIndex& Index);Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| Index | const FBTNodeIndex& | Execution index; all aux nodes (decorators/services) less important than this index are unregistered. | — |
Return Type
void Example
Internal call during a priority-based search C++
// Executed internally when a higher-priority branch becomes active
OwnerComp.UnregisterAuxNodesUpTo(NewActiveNodeIndex);See Also
Tags
Version History
Introduced in: 4.0
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?