RealDocs

UBehaviorTreeComponent::IsRestartPending

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

Description

Returns true if there is a pending execution request that will switch the tree to a higher-priority node rather than simply continuing to the next sibling.

Caveats & Gotchas

  • Reflects ExecutionRequest state that is only set between a decorator/task triggering a request and the next flow update processing it — it's transient, not a stable flag.
  • Distinct from IsAbortPending: this is about the pending search's outcome (restart vs. continue), not whether a latent abort is currently in flight.

Signature

bool IsRestartPending() const

Return Type

bool

Example

Checking for a pending restart before acting C++
if (!OwnerComp.IsRestartPending())
{
    // Safe to assume the current branch will keep running unless something else changes
}

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.