UBTTask_GetNextPatrolPoint Class Reference

#include <BTTask_GetNextPatrolPoint.h>

Inheritance diagram for UBTTask_GetNextPatrolPoint:

Classes
struct	FBTTaskPatrolMemory

Public Member Functions
	UBTTask_GetNextPatrolPoint ()

Public Attributes
bool	bMoveToBridge = false
int32	GetPointAttempts = 4
bool	bOverrideRadius = false
float	Radius = 10.0f
FBlackboardKeySelector	NextPatrolPoint
FBlackboardKeySelector	NextBridgePatrolPoint
FBlackboardKeySelector	MoveTargetLocation
FBlackboardKeySelector	WaitTime
FBlackboardKeySelector	bBridgeAvailable
FBlackboardKeySelector	bPatrolBackwards
bool	bDebuggingMode = false
bool	bShowText = true
float	DebugPointSize = 20.0f
float	DebugPointDuration = 10.0f
FColor	TargetLocationColor = FColor::Yellow
FColor	PatrolPointColor = FColor::Red

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

Detailed Description

Class for a behavior tree task node that retrieves the next patrol point for an AI character.

Constructor & Destructor Documentation

UBTTask_GetNextPatrolPoint()

UBTTask_GetNextPatrolPoint::UBTTask_GetNextPatrolPoint

(

)

{
    NodeName = TEXT("Get Next Patrol Point");
#if WITH_EDITOR
    bDebuggingMode = true;
#endif // WITH_EDITOR
 
}

Member Function Documentation

ExecuteTask()

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

overrideprotectedvirtual

{
    TRACE_CPUPROFILER_EVENT_SCOPE(UBTTask_GetNextPatrolPoint::ExecuteTask);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Behaviors);
    SCOPE_CYCLE_COUNTER(STATGROUP_AIToolKit_Tasks);
    FBTTaskPatrolMemory* PatrolMemory = reinterpret_cast<FBTTaskPatrolMemory*>(NodeMemory);
    if(PatrolMemory == nullptr){return EBTNodeResult::Failed;}
    UBlackboardComponent* BlackboardComp = OwnerComp.GetBlackboardComponent();
    if(BlackboardComp != nullptr)
    {
        //-     Get next Patrol point (Bridge or next in sequence   //
        if(bMoveToBridge)
        {
            PatrolMemory->TargetPatrolPointActor = Cast<AActor>(BlackboardComp->GetValueAsObject(NextBridgePatrolPoint.SelectedKeyName));
        }
        else
        {
            PatrolMemory->TargetPatrolPointActor = Cast<AActor>(BlackboardComp->GetValueAsObject(NextPatrolPoint.SelectedKeyName));
        }
        if(PatrolMemory->TargetPatrolPointActor != nullptr)
        {
            //-     Get Patrol point Interface      //
            PatrolMemory->TargetPatrolPoint = Cast<IPatrolInterface>(PatrolMemory->TargetPatrolPointActor);
            if(PatrolMemory->TargetPatrolPoint != nullptr)
            {
                if(OwnerComp.GetAIOwner() != nullptr)
                {
                    //- Set Move Location Around Patrol Point   //
                    const UNavigationSystemV1* NavSystem = UNavigationSystemV1::GetNavigationSystem(OwnerComp.GetAIOwner());
                    if(NavSystem != nullptr)
                    {
                        PatrolMemory->RandomPoint = FNavLocation(PatrolMemory->TargetPatrolPointActor->GetActorLocation());
                        for(int32 i = 0; i < GetPointAttempts; i++)
                        {
                            PatrolMemory->Radius = PatrolMemory->TargetPatrolPoint->GetRadius() + Radius;
                            if(bOverrideRadius)
                            {
                                PatrolMemory->Radius = Radius;
                            }
                            const bool bFoundPoint = NavSystem->GetRandomReachablePointInRadius(PatrolMemory->TargetPatrolPointActor->GetActorLocation(), PatrolMemory->Radius, PatrolMemory->RandomPoint);
                            if(bFoundPoint)
                            {
                                if(bDebuggingMode){UE_LOG(LogAIToolKit, Warning, TEXT("Point found"));}
                                break;
                            }
                        }
                        BlackboardComp->SetValueAsVector(MoveTargetLocation.SelectedKeyName, PatrolMemory->RandomPoint);
                        if(bDebuggingMode && GetWorld() != nullptr)
                        {
                            DrawDebugPoint(GetWorld(), PatrolMemory->TargetPatrolPointActor->GetActorLocation(), DebugPointSize, PatrolPointColor, false, DebugPointDuration);
                            DrawDebugPoint(GetWorld(), PatrolMemory->RandomPoint, DebugPointSize, TargetLocationColor, false, DebugPointDuration);
                            if(bShowText)
                            {
                                const FString ActorName = OwnerComp.GetAIOwner()->GetPawn()->GetName();
                                const FString PrintMessage = (ActorName + " Target Patrol Point");
                                DrawDebugString(GetWorld(), PatrolMemory->RandomPoint, PrintMessage, nullptr, FColor::White, DebugPointDuration);
                            }
                        }
                    }
                }
                //- Set Wait time   //
                const bool bWaitRandom = PatrolMemory->TargetPatrolPoint->GetTimeToWait(PatrolMemory->TimeToWaitMin, PatrolMemory->TimeToWaitMax);
                PatrolMemory->WaitTime = PatrolMemory->TimeToWaitMin;
                if(bWaitRandom)
                {
                    PatrolMemory->WaitTime = FMath::RandRange(PatrolMemory->TimeToWaitMin, PatrolMemory->TimeToWaitMax);
                }
                BlackboardComp->SetValueAsFloat(WaitTime.SelectedKeyName, PatrolMemory->WaitTime);
 
                //- Set Patrol Direction At next point  //
                PatrolMemory->bPatrolBackwards = BlackboardComp->GetValueAsBool(bPatrolBackwards.SelectedKeyName);
 
                //- If dead end change direction    //
                if(PatrolMemory->TargetPatrolPoint->GetIsDeadEnd())
                {
                    if(bDebuggingMode){UE_LOG(LogAIToolKit, Warning, TEXT("Dead End"));}
                    BlackboardComp->SetValueAsBool(bPatrolBackwards.SelectedKeyName, !PatrolMemory->bPatrolBackwards);
                    PatrolMemory->bPatrolBackwards = !PatrolMemory->bPatrolBackwards;
                }
 
                
                //- Patrol Direction, if moving forward, get next point and bridge if available //
                AActor* NextPoint;
 
                if(PatrolMemory->bPatrolBackwards)// || PatrolMemory->NextPatrolPointActor == nullptr)
                {
                    PatrolMemory->NextPatrolPointActor = PatrolMemory->TargetPatrolPoint->GetNextPatrolPointActor(PatrolMemory->bIsBridgeAvailable);
                    PatrolMemory->PreviousPatrolPointActor = PatrolMemory->TargetPatrolPoint->GetPreviousPatrolPointActor(PatrolMemory->bIsBridgeAvailable);
                    PatrolMemory->NextBridgePatrolPointActor = PatrolMemory->TargetPatrolPoint->GetNextBridgePatrolPointActor();
                    NextPoint = PatrolMemory->PreviousPatrolPointActor;
                    // BlackboardComp->SetValueAsObject(NextPatrolPoint.SelectedKeyName, PatrolMemory->PreviousPatrolPointActor);
                }
                else
                {
                    PatrolMemory->PreviousPatrolPointActor = PatrolMemory->TargetPatrolPoint->GetPreviousPatrolPointActor(PatrolMemory->bIsBridgeAvailable);
                    PatrolMemory->NextPatrolPointActor = PatrolMemory->TargetPatrolPoint->GetNextPatrolPointActor(PatrolMemory->bIsBridgeAvailable);
                    PatrolMemory->NextBridgePatrolPointActor = PatrolMemory->TargetPatrolPoint->GetNextBridgePatrolPointActor();
                    NextPoint = PatrolMemory->NextPatrolPointActor;
                    // BlackboardComp->SetValueAsObject(NextPatrolPoint.SelectedKeyName, PatrolMemory->NextPatrolPointActor);
                }
                if(PatrolMemory->PreviousPatrolPointActor == nullptr)
                {
                    NextPoint = PatrolMemory->NextPatrolPointActor;
                }
                if(PatrolMemory->NextPatrolPointActor == nullptr)
                {
                    NextPoint = PatrolMemory->PreviousPatrolPointActor;
                }
                BlackboardComp->SetValueAsObject(NextPatrolPoint.SelectedKeyName, NextPoint);
 
                
                //- Set Is Bridge Available, and next bridge point  //
                BlackboardComp->SetValueAsBool(bBridgeAvailable.SelectedKeyName, PatrolMemory->bIsBridgeAvailable);
                BlackboardComp->SetValueAsObject(NextBridgePatrolPoint.SelectedKeyName, PatrolMemory->NextBridgePatrolPointActor);
 
            }
        }
    }
    return EBTNodeResult::Succeeded;
}

GetInstanceMemorySize()

uint16 UBTTask_GetNextPatrolPoint::GetInstanceMemorySize ( ) const

overrideprotectedvirtual

{
    return sizeof(FBTTaskPatrolMemory);
}

GetStaticDescription()

FString UBTTask_GetNextPatrolPoint::GetStaticDescription ( ) const

overrideprotectedvirtual

{
    FString Description;
    if(bDebuggingMode)
    {
        Description += FString::Printf(TEXT("\n DEBUG ACTIVE"));
    }
    Description += FString::Printf(TEXT("\n Move To Bridge: %s"), bMoveToBridge ? TEXT("True") : TEXT("False"));
    Description += FString::Printf(TEXT("\n Radius: %s"), bOverrideRadius ? *FString::Printf(TEXT("\n OVERRIDEN %f"), Radius) : *FString::Printf(TEXT("\n  %i"),  FMath::RoundToInt(Radius)));
    Description += FString::Printf(TEXT("\n Attempts: %i"), GetPointAttempts);
 
    if(!MoveTargetLocation.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\nMoveTargetLocation: NULL"));
    }
    if(!WaitTime.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\n Wait Time: NULL"));
    }
    if(!bBridgeAvailable.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\n Bridge Available: NULL"));
    }
    if(!bPatrolBackwards.SelectedKeyName.IsValid())
    {
        Description += FString::Printf(TEXT("\n Patrol Backward: NULL"));
    }
 
    return Description;
}

Member Data Documentation

bBridgeAvailable

FBlackboardKeySelector UBTTask_GetNextPatrolPoint::bBridgeAvailable

bDebuggingMode

bool UBTTask_GetNextPatrolPoint::bDebuggingMode = false

bMoveToBridge

bool UBTTask_GetNextPatrolPoint::bMoveToBridge = false

bOverrideRadius

bool UBTTask_GetNextPatrolPoint::bOverrideRadius = false

bPatrolBackwards

FBlackboardKeySelector UBTTask_GetNextPatrolPoint::bPatrolBackwards

bShowText

bool UBTTask_GetNextPatrolPoint::bShowText = true

DebugPointDuration

float UBTTask_GetNextPatrolPoint::DebugPointDuration = 10.0f

DebugPointSize

float UBTTask_GetNextPatrolPoint::DebugPointSize = 20.0f

GetPointAttempts

int32 UBTTask_GetNextPatrolPoint::GetPointAttempts = 4

MoveTargetLocation

FBlackboardKeySelector UBTTask_GetNextPatrolPoint::MoveTargetLocation

NextBridgePatrolPoint

FBlackboardKeySelector UBTTask_GetNextPatrolPoint::NextBridgePatrolPoint

NextPatrolPoint

FBlackboardKeySelector UBTTask_GetNextPatrolPoint::NextPatrolPoint

PatrolPointColor

FColor UBTTask_GetNextPatrolPoint::PatrolPointColor = FColor::Red

Radius

float UBTTask_GetNextPatrolPoint::Radius = 10.0f

TargetLocationColor

FColor UBTTask_GetNextPatrolPoint::TargetLocationColor = FColor::Yellow

WaitTime

FBlackboardKeySelector UBTTask_GetNextPatrolPoint::WaitTime

---

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