UBTTask_PredictLocation Class Reference

#include <BTTask_PredictLocation.h>

Inheritance diagram for UBTTask_PredictLocation:

Classes
struct	FBTTaskPredictLocationMemory

Public Member Functions
	UBTTask_PredictLocation ()

Public Attributes
bool	bUseCustomPredictionTime = false
float	PredictionTime = 0.5f
FBlackboardKeySelector	TargetEnemy
FBlackboardKeySelector	TargetFireLocation
bool	bUseCustomDelayDuration = false
float	DelayDuration = 0.1f

Protected Member Functions
virtual EBTNodeResult::Type	ExecuteTask (UBehaviorTreeComponent &OwnerComp, uint8 *NodeMemory) override
virtual EBTNodeResult::Type	AbortTask (UBehaviorTreeComponent &OwnerComp, uint8 *NodeMemory) override
virtual void	TickTask (UBehaviorTreeComponent &OwnerComp, uint8 *NodeMemory, float DeltaSeconds) override
virtual uint16	GetInstanceMemorySize () const override
virtual FString	GetStaticDescription () const override

Detailed Description

The UBTTask_PredictLocation class is a behavior tree task node used to predict the location of a target enemy. It inherits from UBTTaskNode.

It has the following public variables:

• bUseCustomPredictionTime: a boolean indicating whether to use a custom prediction time (default is false)
• PredictionTime: a float indicating the prediction time for target enemy's location (default is 0.5)
• TargetEnemy: a FBlackboardKeySelector representing the key for the target enemy
• TargetFireLocation: a FBlackboardKeySelector representing the key for the target fire location
• bUseCustomDelayDuration: a boolean indicating whether to use a custom delay duration (default is false)
• DelayDuration: a float indicating the delay duration (default is 0.1)

It has the following protected functions:

• ExecuteTask: a function called to execute the task
• AbortTask: a function called to abort the task
• TickTask: a function called every frame to update the task

It has the following private struct:

• FBTTaskPredictLocationMemory: a struct holding task-specific memory data

See also

UBTTaskNode

Constructor & Destructor Documentation

UBTTask_PredictLocation()

UBTTask_PredictLocation::UBTTask_PredictLocation

(

)

{
    NodeName = TEXT("Predict Location");
    INIT_TASK_NODE_NOTIFY_FLAGS();
}

Member Function Documentation

AbortTask()

EBTNodeResult::Type UBTTask_PredictLocation::AbortTask ( UBehaviorTreeComponent & OwnerComp, uint8 * NodeMemory )

overrideprotectedvirtual

{
    return EBTNodeResult::Aborted;
}

ExecuteTask()

EBTNodeResult::Type UBTTask_PredictLocation::ExecuteTask ( UBehaviorTreeComponent & OwnerComp, uint8 * NodeMemory )

overrideprotectedvirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTTask_PredictLocation::ExecuteTask);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Behaviors);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Tasks);
    FBTTaskPredictLocationMemory* PredictLocationMemory = reinterpret_cast<FBTTaskPredictLocationMemory*>(NodeMemory);
    if(PredictLocationMemory == nullptr){return EBTNodeResult::Failed;}
 
    if(!bUseCustomDelayDuration)
    {
        DelayDuration = GetWorld()->GetDeltaSeconds();
    }
    const UBlackboardComponent* BlackboardComp = OwnerComp.GetBlackboardComponent();
    if(BlackboardComp != nullptr)
    {
        PredictLocationMemory->TargetActor = Cast<AActor>(BlackboardComp->GetValueAsObject(TargetEnemy.SelectedKeyName));
        if(PredictLocationMemory->TargetActor != nullptr)
        {
            IAIActionsInterface* AIActions = Cast<IAIActionsInterface>(OwnerComp.GetAIOwner());
            if(AIActions != nullptr)
            {
                AIActions->PredictLocation(PredictLocationMemory->TargetActor);
            }
        }
    }
    return EBTNodeResult::InProgress;
}

GetInstanceMemorySize()

uint16 UBTTask_PredictLocation::GetInstanceMemorySize ( ) const

overrideprotectedvirtual

{
    return sizeof(FBTTaskPredictLocationMemory);
}

GetStaticDescription()

FString UBTTask_PredictLocation::GetStaticDescription ( ) const

overrideprotectedvirtual

{
    FString Description;
    if(bUseCustomPredictionTime)
    {
        Description += FString::Printf(TEXT("\nCustom Prediction Time: %i"), FMath::RoundToInt(PredictionTime));
    }
    if(bUseCustomDelayDuration)
    {
        Description += FString::Printf(TEXT("\nCustom Prediction Time: %i"), FMath::RoundToInt(PredictionTime));
    }
    if(TargetEnemy.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\nTarget Enemy: %s"), *TargetEnemy.SelectedKeyName.ToString());
    }
    else
    {
        Description += TEXT("\nTarget Enemy: None");
    }
    if(TargetFireLocation.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\nTarget Fire Location: %s"), *TargetFireLocation.SelectedKeyName.ToString());
    }
    else
    {
        Description += TEXT("\nTarget Fire Location: None");
    }
    return Description;
}

TickTask()

void UBTTask_PredictLocation::TickTask ( UBehaviorTreeComponent & OwnerComp, uint8 * NodeMemory, float DeltaSeconds )

overrideprotectedvirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTTask_PredictLocation::TickTask);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Behaviors);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Tasks);
    FBTTaskPredictLocationMemory* PredictLocationMemory = reinterpret_cast<FBTTaskPredictLocationMemory*>(NodeMemory);
    if(PredictLocationMemory == nullptr){FinishLatentTask(OwnerComp, EBTNodeResult::Failed);}
    if(GetWorld()->GetTimeSeconds() - PredictLocationMemory->StartTime >= DelayDuration)
    {
        FActorPerceptionBlueprintInfo SenseInfo;
        if(OwnerComp.GetAIOwner() != nullptr && OwnerComp.GetAIOwner()->GetAIPerceptionComponent() != nullptr && PredictLocationMemory->TargetActor != nullptr)
        {
            const bool bSuccess = OwnerComp.GetAIOwner()->GetAIPerceptionComponent()->GetActorsPerception(PredictLocationMemory->TargetActor, SenseInfo);
            if(bSuccess)
            {
                FAIStimulus PredictionInfo;
                for(const auto Info : SenseInfo.LastSensedStimuli)
                {
                    if(UAIBPLib::GetSenseFromStimulus(Info) == EAISense::Prediction)
                    {
                        PredictionInfo = Info;
                        break;
                    }
                }
                if(PredictionInfo.IsValid())
                {
                    UBlackboardComponent* BlackboardComp = OwnerComp.GetBlackboardComponent();
                    if(BlackboardComp != nullptr)
                    {
                        BlackboardComp->SetValueAsVector(TargetFireLocation.SelectedKeyName, PredictionInfo.StimulusLocation);
                    }
                }
            }
        }
        FinishLatentTask(OwnerComp, EBTNodeResult::Succeeded);
    }
}

Member Data Documentation

bUseCustomDelayDuration

bool UBTTask_PredictLocation::bUseCustomDelayDuration = false

bUseCustomPredictionTime

bool UBTTask_PredictLocation::bUseCustomPredictionTime = false

DelayDuration

float UBTTask_PredictLocation::DelayDuration = 0.1f

PredictionTime

float UBTTask_PredictLocation::PredictionTime = 0.5f

TargetEnemy

FBlackboardKeySelector UBTTask_PredictLocation::TargetEnemy

TargetFireLocation

FBlackboardKeySelector UBTTask_PredictLocation::TargetFireLocation

---

The documentation for this class was generated from the following files:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKit/Public/Behavior/Tasks/BTTask_PredictLocation.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKit/Private/Behavior/Tasks/BTTask_PredictLocation.cpp