PatrolPathPoint.h

Go to the documentation of this file.

// Fill out your copyright notice in the Description page of Project Settings.
 
#pragma once
 
#include "CoreMinimal.h"
#include "GameFramework/Actor.h"
#include "Interfaces/BaseInterface.h"
#include "Interfaces/PatrolInterface.h"
#include "PatrolPathPoint.generated.h"
 
UCLASS()
class AITOOLKIT_API APatrolPathPoint : public AActor, public IPatrolInterface, public IBaseInterface
{
    GENERATED_BODY()
    
public: 
    APatrolPathPoint();
 
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    APatrolPathPoint* GetNextPatrolPoint(bool& bIsBridgeAvailable) const;
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    APatrolPathPoint* GetPreviousPatrolPoint(bool& bIsBridgeAvailable) const;
    UFUNCTION(BlueprintCallable, Category="AI Tool Kit")
    APatrolPathPoint* GetNextBridgePatrolPoint() const;
 
    //- Patrol interface for AI Tasks   //
    virtual bool GetTimeToWait(float& WaitMin, float& WaitMax) const override;
    virtual AActor* GetNextPatrolPointActor(bool& bIsBridgeAvailable) const override;
    virtual AActor* GetNextBridgePatrolPointActor() const override;
    virtual AActor* GetPreviousPatrolPointActor(bool& bIsBridgeAvailable) const override;
    virtual float GetRadius() const override {return Radius;};
    virtual bool GetIsDeadEnd() const override;
 
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    virtual void SetGravityEnabled(const bool bValue) override{return;};
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    virtual FString GetObjectDisplayName() const override {return "Patrol Point";};
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    virtual FInteractionData GetInteractionData() const override{ return InteractionData;};
    UFUNCTION(BlueprintCallable, Category = "Base Helpers")
    virtual bool GetIsCharacter() const override{return false;};
 
    virtual void OnFinishSpawning() override;
 
protected:
    virtual void BeginPlay() override;
    
    virtual void OnConstruction(const FTransform& Transform) override;
 
    //-     Components      //
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="AI Tool Kit")
    class USceneComponent* SceneRoot;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="AI Tool Kit")
    class UAIPerceptionStimuliSourceComponent* AIStimuliComponent;
    
// #if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="AI Tool Kit")
    class UBillboardComponent* PreviewIcon;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="AI Tool Kit")
    class UArrowComponent* ArrowComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="AI Tool Kit")
    class UCableComponent* PathCableComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="AI Tool Kit")
    class UCableComponent* BridgePathCableComponent;
    UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category="AI Tool Kit")
    class USphereComponent* SphereRadiusComponent;
 
// #endif // WITH_EDITOR
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    FInteractionData InteractionData = FInteractionData(EInteractionType::None, EAIStimuliType::PatrolPoint);
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    int32 PathNumber = 0;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    int32 PathStartNumber = 0;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    bool bFinalPoint = false;
    //- Dead end used to reverse direction back //
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    bool bDeadEnd = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    bool bUseDirection = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    FLinearColor PathColor = FLinearColor::Blue;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    UMaterial* Material;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path")
    int32 PathGroup = 1;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Radius")
    float Radius = 50.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Bridge")
    bool bCanBridge = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Bridge")
    bool bBridgeEnd = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Bridge")
    int32 BridgeToPathGroup = 0;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Bridge")
    int32 BridgeToPathNumber = 0;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Bridge")
    FLinearColor BridgePathColor = FLinearColor::Red;
 
    //- How long should I wait at this point, if false, will use MIN    //
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Wait")
    bool bWaitRandomTime = true;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Wait")
    float TimeToWaitMin = 0.0f;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Wait")
    float TimeToWaitMax = 1.0f;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Debugging")
    bool bDebuggingMode = false;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Editor")
    bool bUpdate = false;
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="AI Tool Kit|Path|Editor")
    bool bMoveAllNumbersUp1 = false;
 
    //~         Interaction Data Manipulation               ~//
    virtual bool SetInteractionHidden(const EInteractionType Interaction, const bool bValue) override
    {return InteractionData.SetInteractionHidden(Interaction, bValue);};
    virtual void SetOnlyInteractionVisible(const EInteractionType Interaction) override
    {InteractionData.SetOnlyInteractionVisible(Interaction);}
    
    virtual bool SetInteractionAvailable(const EInteractionType Interaction, const bool bValue) override
    {return InteractionData.SetInteractionAvailable(Interaction, bValue);}
    
    virtual bool SetInteractionHold(const EInteractionType Interaction, const bool bValue) override
    {return InteractionData.SetInteractionHold(Interaction, bValue);}
    
    virtual TArray<FInteractionType> GetVisibleInteractions() const override
    {return InteractionData.GetVisibleInteractions();}
    virtual bool GetInteraction(FInteractionType& Type, const EInteractionType Interaction) const override
    {return InteractionData.GetInteraction(Type, Interaction);}
    virtual bool GetDefaultInteraction(FInteractionType& Type) const override
    {return InteractionData.GetDefaultInteraction(Type);}
    //~         Interaction Data Manipulation               ~//
 
 
private:
    void RemoveVisualizers() const;
    void UpdateVisualizers();
    void UpdateAllNumbers();
    
    TArray<APatrolPathPoint*> GetAllPathPoints() const;
    TArray<APatrolPathPoint*> GetAllPathPointsInGroup(const int32 GroupNumber) const;
 
 
    UPROPERTY()
    APatrolPathPoint* NextPathPoint;
    UPROPERTY()
    APatrolPathPoint* NextBridgePathPoint;
    UPROPERTY()
    APatrolPathPoint* PreviousPathPoint;
 
};