Navigation
API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/BehaviorTree > API/Runtime/AIModule/BehaviorTree/Tasks
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UBTNode
- UBTTaskNode
- UBTTask_BlueprintBase
References
| Module | AIModule |
| Header | /Engine/Source/Runtime/AIModule/Classes/BehaviorTree/Tasks/BTTask_BlueprintBase.h |
| Include | #include "BehaviorTree/Tasks/BTTask_BlueprintBase.h" |
Syntax
class UBTTask_BlueprintBase : public UBTTaskNode
Remarks
Base class for blueprint based task nodes. Do NOT use it for creating native c++ classes!
When task receives Abort event, all latent actions associated this instance are being removed. This prevents from resuming activity started by Execute, but does not handle external events. Please use them safely (unregister at abort) and call IsTaskExecuting() when in doubt.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TObjectPtr< AActor > | ActorOwner | Cached actor owner of BehaviorTreeComponent. |
 |
TObjectPtr< AAIController > | AIOwner | Cached AIController owner of BehaviorTreeComponent. |
 |
uint32: 1 | bIsAborting | Set when task enters Aborting state |
 |
uint32: 1 | bShowPropertyDetails | Show detailed information about properties |
 |
uint32: 1 | bStoreFinishResult | If set, execution is inside blueprint's ReceiveExecute(Abort) event FinishExecute(Abort) function should store their result in CurrentCallResult variable |
 |
TEnumAsByte< EBTNodeResult::Type > | CurrentCallResult | Temporary variable for ReceiveExecute(Abort)-FinishExecute(Abort) chain |
 |
FString | CustomDescription | |
 |
TArray< FProperty * > | PropertyData | Properties that should be copied |
 |
uint32: 2 | ReceiveAbortImplementations | Set if ReceiveAbort is implemented by blueprint |
 |
uint32: 2 | ReceiveExecuteImplementations | Set if ReceiveExecute is implemented by blueprint |
 |
uint32: 2 | ReceiveTickImplementations | Set if ReceiveTick is implemented by blueprint |
 |
FIntervalCountdown | TickInterval | If any of the Tick functions is implemented, how often should they be ticked. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UBTTask_BlueprintBase
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | FinishAbort () |
Aborts task execution |
 |
void | FinishExecute
(
bool bSuccess |
Finishes task execution with Success or Fail result |
  |
bool | Check if task is currently being aborted | |
  |
bool | Check if task is currently being executed | |
 |
void | ReceiveAbort
(
AActor* OwnerActor |
If blueprint graph contains this event, task will stay active until FinishAbort is called that if both generic and AI event versions are implemented only the more suitable one will be called, meaning the AI version if called for AI, generic one otherwise |
 |
void | ReceiveAbortAI
(
AAIController* OwnerController, |
Alternative AI version of ReceiveAbort |
 |
void | ReceiveExecute
(
AActor* OwnerActor |
Entry point, task will stay active until FinishExecute is called. |
 |
void | ReceiveExecuteAI
(
AAIController* OwnerController, |
Alternative AI version of ReceiveExecute |
 |
void | ReceiveTick
(
AActor* OwnerActor, |
Tick function that if both generic and AI event versions are implemented only the more suitable one will be called, meaning the AI version if called for AI, generic one otherwise |
 |
void | ReceiveTickAI
(
AAIController* OwnerController, |
Alternative AI version of tick function. |
 |
void | SetFinishOnMessage
(
FName MessageName |
Task execution will be finished (with result 'Success') after receiving specified message |
 |
void | SetFinishOnMessageWithId
(
FName MessageName, |
Task execution will be finished (with result 'Success') after receiving specified message with indicated ID |
Overridden from UBTTaskNode
| Type | Name | Description | |
|---|---|---|---|
  |
EBTNodeResult::Type | AbortTask
(
UBehaviorTreeComponent& OwnerComp, |
Aborts this task, should return Aborted or InProgress (use FinishLatentAbort() when returning InProgress) this function should be considered as const (don't modify state of object) if node is not instanced! |
  |
EBTNodeResult::Type | ExecuteTask
(
UBehaviorTreeComponent& OwnerComp, |
Starts this task, should return Succeeded, Failed or InProgress (use FinishLatentTask() when returning InProgress) this function should be considered as const (don't modify state of object) if node is not instanced! |
  |
void | OnTaskFinished
(
UBehaviorTreeComponent& OwnerComp, |
Called when task execution is finished this function should be considered as const (don't modify state of object) if node is not instanced! bNotifyTaskFinished must be set to true for this function to be called Calling INIT_TASK_NODE_NOTIFY_FLAGS in the constructor of the task will set this flag automatically |
  |
void | TickTask
(
UBehaviorTreeComponent& OwnerComp, |
Ticks this task |
Overridden from UBTNode
| Type | Name | Description | |
|---|---|---|---|
   |
void | DescribeRuntimeValues
(
const UBehaviorTreeComponent& OwnerComp, |
Gathers description of all runtime parameters |
   |
FString | ||
  |
void | InitializeFromAsset
(
UBehaviorTree& Asset |
Initialize any asset related data |
  |
void | OnInstanceDestroyed
(
UBehaviorTreeComponent& OwnerComp |
Called when node instance is removed from tree |
  |
void | Gets called only for instanced nodes(bCreateNodeInstance == true). | |
   |
bool | Get whether this node is using a blueprint for its logic |