UBTTask_InteractWithTarget Class Reference

#include <BTTask_InteractWithTarget.h>

Inheritance diagram for UBTTask_InteractWithTarget:

Classes
struct	FBTTaskInteractWithTargetMemory

Public Member Functions
	UBTTask_InteractWithTarget ()

Public Attributes
float	DelayDuration = 0.2f
int32	Attempts = 4
FBlackboardKeySelector	TargetObject
FBlackboardKeySelector	bIsSomethingInTheWay
bool	bDebuggingMode = false

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

UBTTask_InteractWithTarget is a behavior tree task node that is used to interact with a target object. It executes a series of attempts to interact with the target object, with a delay between attempts.

Constructor & Destructor Documentation

UBTTask_InteractWithTarget()

UBTTask_InteractWithTarget::UBTTask_InteractWithTarget

(

)

{
    NodeName = TEXT("Interact With Target");
    INIT_TASK_NODE_NOTIFY_FLAGS();
#if WITH_EDITOR
    bDebuggingMode = true;
#endif // WITH_EDITOR
 
}

Member Function Documentation

AbortTask()

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

overrideprotectedvirtual

{
    FBTTaskInteractWithTargetMemory* InteractMemory = reinterpret_cast<FBTTaskInteractWithTargetMemory*>(NodeMemory);
    if(InteractMemory == nullptr){FinishLatentTask(OwnerComp, EBTNodeResult::Failed);}
    InteractMemory->TotalAttempts = 0;
    InteractMemory->StartTime = 0.0f;
    InteractMemory->TargetActor = nullptr;
    return EBTNodeResult::Aborted;
}

ExecuteTask()

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

overrideprotectedvirtual

Executes the task of interacting with the target actor.

This method is responsible for picking up an object (target actor) by calling the PickupObject() method of the AI owner. It gets the target actor from the blackboard component using the selected key name specified in the "TargetObject" variable. If the target actor is not found or if the pickup operation fails, it returns "Succeeded". Otherwise, it returns "InProgress". The start time of the task is also recorded in the "StartTime" member variable.

Parameters

OwnerComp	The behavior tree component that is executing this task.
NodeMemory	Pointer to the memory allocated for this node.

Returns

The execution result of the task, which can be "Succeeded" if the pickup operation was successful, "InProgress" if the pickup operation is currently in progress, or eventually "Failed" if the pickup operation fails.

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTTask_InteractWithTarget::ExecuteTask);
    FBTTaskInteractWithTargetMemory* InteractMemory = reinterpret_cast<FBTTaskInteractWithTargetMemory*>(NodeMemory);
    if(InteractMemory == nullptr){return EBTNodeResult::Failed;}
    InteractMemory->StartTime = GetWorld()->GetTimeSeconds();
    if(InteractMemory->TotalAttempts == -1)
    {
        InteractMemory->TotalAttempts = Attempts;
    }
    const UBlackboardComponent* BlackboardComp = OwnerComp.GetBlackboardComponent();
    if(BlackboardComp != nullptr)
    {
        InteractMemory->TargetActor = Cast<AActor>(BlackboardComp->GetValueAsObject(TargetObject.SelectedKeyName));
        if(InteractMemory->TargetActor == nullptr){return EBTNodeResult::Succeeded;}
        IAIActionsInterface* AIActions = Cast<IAIActionsInterface>(OwnerComp.GetAIOwner());
        if(AIActions != nullptr)
        {
            const bool bSucceeded = AIActions->PickupObject(InteractMemory->TargetActor);
            if(bSucceeded)
            {
                return EBTNodeResult::Succeeded;
            }
        }
    }
    InteractMemory->TotalAttempts--;
    return EBTNodeResult::InProgress;
}

GetInstanceMemorySize()

uint16 UBTTask_InteractWithTarget::GetInstanceMemorySize ( ) const

overrideprotectedvirtual

{
    return sizeof(FBTTaskInteractWithTargetMemory);
}

GetStaticDescription()

FString UBTTask_InteractWithTarget::GetStaticDescription ( ) const

overrideprotectedvirtual

{
    FString Description;// = Super::GetStaticDescription();
    Description += FString::Printf(TEXT("\nAttempts: %s Delay between: %i"), *FString::FromInt(Attempts), FMath::RoundToInt(DelayDuration));
    if(bDebuggingMode)
    {
        Description += FString::Printf(TEXT("\n DEBUG ACTIVE"));
    }
 
    if(TargetObject.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\nTarget Object: %s"), *TargetObject.SelectedKeyName.ToString());
    }
    else
    {
        Description += TEXT("\nTarget Object: None");
    }
    if(bIsSomethingInTheWay.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\n Something In The Way Set"));
    }
    else
    {
        Description += TEXT("\nSomething In The Way NULL");
    }
    return Description;
}

TickTask()

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

overrideprotectedvirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTTask_InteractWithTarget::TickTask);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Behaviors);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Tasks);
    const FBTTaskInteractWithTargetMemory* InteractMemory = reinterpret_cast<FBTTaskInteractWithTargetMemory*>(NodeMemory);
    if(InteractMemory == nullptr){FinishLatentTask(OwnerComp, EBTNodeResult::Failed);}
    if(GetWorld()->GetTimeSeconds() - InteractMemory->StartTime >= DelayDuration)
    {
        ExecuteTask(OwnerComp, NodeMemory);
        if(Attempts <= 0)
        {
            //-     Couldn't pick up item       //
            UBlackboardComponent* BlackboardComp = OwnerComp.GetBlackboardComponent();
            if(BlackboardComp != nullptr)
            {
                BlackboardComp->SetValueAsBool(bIsSomethingInTheWay.SelectedKeyName, true);
                BlackboardComp->SetValueAsObject(TargetObject.SelectedKeyName, InteractMemory->TargetActor);
            }
            FinishLatentTask(OwnerComp, EBTNodeResult::Succeeded);
        }
    }
}

Member Data Documentation

Attempts

int32 UBTTask_InteractWithTarget::Attempts = 4

bDebuggingMode

bool UBTTask_InteractWithTarget::bDebuggingMode = false

bIsSomethingInTheWay

FBlackboardKeySelector UBTTask_InteractWithTarget::bIsSomethingInTheWay

DelayDuration

float UBTTask_InteractWithTarget::DelayDuration = 0.2f

TargetObject

FBlackboardKeySelector UBTTask_InteractWithTarget::TargetObject

---

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_InteractWithTarget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/AIToolKit/Source/AIToolKit/Private/Behavior/Tasks/BTTask_InteractWithTarget.cpp