RealDocs

UBehaviorTreeComponent::UnregisterAuxNodesInRange

function AIModule Since 4.0
#include "BehaviorTree/BehaviorTreeComponent.h"
Access: public

Description

Unregisters all auxiliary nodes whose execution index falls strictly between FromIndex and ToIndex.

Caveats & Gotchas

  • The comparison is exclusive on both ends (FromIndex < AuxIndex < ToIndex), so nodes exactly at the boundary indices are left registered.
  • Used internally during search updates to clear decorators/services made irrelevant by a partial branch change; not intended for direct use from task or decorator code.

Signature

void UnregisterAuxNodesInRange(const FBTNodeIndex& FromIndex, const FBTNodeIndex& ToIndex);

Parameters

Name Type Description Default
FromIndex const FBTNodeIndex& Exclusive lower bound of the execution index range.
ToIndex const FBTNodeIndex& Exclusive upper bound of the execution index range.

Return Type

void

Example

Internal call during a search update C++
// Executed internally to clear aux nodes made irrelevant by a partial branch change
OwnerComp.UnregisterAuxNodesInRange(SearchStart, SearchEnd);

Tags

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.