AITask_MoveTo.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Engine/EngineTypes.h"
#include "AITypes.h"
#include "Navigation/PathFollowingComponent.h"
#include "Tasks/AITask.h"
#include "AITask_MoveTo.generated.h"
 
class AAIController;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FMoveTaskCompletedSignature, TEnumAsByte<EPathFollowingResult::Type>, Result, AAIController*, AIController);
DECLARE_MULTICAST_DELEGATE_TwoParams(FMoveTaskFinishedSignature, TEnumAsByte<EPathFollowingResult::Type>, AAIController*);
 
UCLASS(MinimalAPI)
class UAITask_MoveTo : public UAITask
{
    GENERATED_BODY()
 
public:
    AIMODULE_API UAITask_MoveTo(const FObjectInitializer& ObjectInitializer);
 
    AIMODULE_API void ConditionalPerformMove();
 
    AIMODULE_API void SetUp(AAIController* Controller, const FAIMoveRequest& InMoveRequest);
 
    EPathFollowingResult::Type GetMoveResult() const { return MoveResult; }
    bool WasMoveSuccessful() const { return MoveResult == EPathFollowingResult::Success; }
    bool WasMovePartial() const { return Path.IsValid() && Path->IsPartial(); }
 
    UFUNCTION(BlueprintCallable, Category = "AI|Tasks", meta = (AdvancedDisplay = "AcceptanceRadius,StopOnOverlap,AcceptPartialPath,bUsePathfinding,bUseContinuousGoalTracking,ProjectGoalOnNavigation,RequireNavigableEndLocation", DefaultToSelf = "Controller", BlueprintInternalUseOnly = "TRUE", DisplayName = "Move To Location or Actor"))
    static AIMODULE_API UAITask_MoveTo* AIMoveTo(AAIController* Controller, FVector GoalLocation, AActor* GoalActor = nullptr,
        float AcceptanceRadius = -1.f, EAIOptionFlag::Type StopOnOverlap = EAIOptionFlag::Default, EAIOptionFlag::Type AcceptPartialPath = EAIOptionFlag::Default,
        bool bUsePathfinding = true, bool bLockAILogic = true, bool bUseContinuousGoalTracking = false, EAIOptionFlag::Type ProjectGoalOnNavigation = EAIOptionFlag::Default,
        EAIOptionFlag::Type RequireNavigableEndLocation = EAIOptionFlag::Default);
 
    FAIMoveRequest& GetMoveRequestRef() { return MoveRequest; }
 
    AIMODULE_API void SetContinuousGoalTracking(bool bEnable);
 
    FMoveTaskFinishedSignature OnMoveTaskFinished;
protected:
    UPROPERTY(BlueprintAssignable)
    FGenericGameplayTaskDelegate OnRequestFailed;
 
    UPROPERTY(BlueprintAssignable)
    FMoveTaskCompletedSignature OnMoveFinished;
 
    UPROPERTY()
    FAIMoveRequest MoveRequest;
 
    FDelegateHandle PathFinishDelegateHandle;
 
    FDelegateHandle PathUpdateDelegateHandle;
 
    FTimerHandle MoveRetryTimerHandle;
 
    FTimerHandle PathRetryTimerHandle;
 
    FAIRequestID MoveRequestID;
 
    FNavPathSharedPtr Path;
 
    TEnumAsByte<EPathFollowingResult::Type> MoveResult;
    uint8 bUseContinuousTracking : 1;
 
    AIMODULE_API virtual void Activate() override;
    AIMODULE_API virtual void OnDestroy(bool bOwnerFinished) override;
 
    AIMODULE_API virtual void Pause() override;
    AIMODULE_API virtual void Resume() override;
 
    AIMODULE_API void FinishMoveTask(EPathFollowingResult::Type InResult);
 
    AIMODULE_API void SetObservedPath(FNavPathSharedPtr InPath);
 
    AIMODULE_API virtual void ResetObservers();
 
    AIMODULE_API virtual void ResetTimers();
 
    AIMODULE_API void ConditionalUpdatePath();
 
    AIMODULE_API virtual void PerformMove();
 
    AIMODULE_API virtual void OnPathEvent(FNavigationPath* InPath, ENavPathEvent::Type Event);
 
    AIMODULE_API virtual void OnRequestFinished(FAIRequestID RequestID, const FPathFollowingResult& Result);
};