LinkGenerationConfig.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Templates/SubclassOf.h"
#include "AI/Navigation/NavigationTypes.h"
 
#include "LinkGenerationConfig.generated.h"
 
class UBaseGeneratedNavLinksProxy;
class UNavAreaBase;
 
#if WITH_RECAST
struct dtNavLinkBuilderJumpConfig;
#endif //WITH_RECAST
 
UENUM(meta = (Bitflags, UseEnumValuesAsMaskValuesInEditor = "true"))
enum class ENavLinkBuilderFlags : uint16
{
    CreateCenterPointLink       = 1 << 0,
    CreateExtremityLink         = 1 << 1,
};
ENUM_CLASS_FLAGS(ENavLinkBuilderFlags);
 
USTRUCT()
struct FNavLinkGenerationJumpConfig
{
    GENERATED_BODY()
 
    NAVIGATIONSYSTEM_API FNavLinkGenerationJumpConfig();
 
    // Note: We need to explicitly disable warnings on these constructors/operators for clang to be happy with deprecated variables
    PRAGMA_DISABLE_DEPRECATION_WARNINGS
    ~FNavLinkGenerationJumpConfig() = default;
    FNavLinkGenerationJumpConfig(const FNavLinkGenerationJumpConfig&) = default;
    FNavLinkGenerationJumpConfig(FNavLinkGenerationJumpConfig&&) = default;
    FNavLinkGenerationJumpConfig& operator=(const FNavLinkGenerationJumpConfig&) = default;
    FNavLinkGenerationJumpConfig& operator=(FNavLinkGenerationJumpConfig&&) = default;
    PRAGMA_ENABLE_DEPRECATION_WARNINGS
 
    UPROPERTY(EditAnywhere, Config, Category = Settings)
    bool bEnabled = true;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings)
    FName Name;
    
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpLength = 150.f; 
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpDistanceFromEdge = 10.f; 
 
    UPROPERTY(EditAnywhere, Config, Category = Settings)
    float JumpMaxDepth = 150.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpHeight = 50.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpEndsHeightTolerance = 80.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=1, ClampMin=1))
    float SamplingSeparationFactor = 1.f;
    
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float FilterDistanceThreshold = 80.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta = (Bitmask, BitmaskEnum = "/Script/NavigationSystem.ENavLinkBuilderFlags"))
    uint16 LinkBuilderFlags = (uint16)ENavLinkBuilderFlags::CreateCenterPointLink;
 
#if WITH_EDITORONLY_DATA
    UE_DEPRECATED(5.6, "AreaClass is deprecated")
    UPROPERTY(Config, meta = (DeprecatedProperty, DeprecationMessage = "Use DownDirectionAreaClass and UpDirectionAreaClass instead."))
    TSubclassOf<UNavAreaBase> AreaClass_DEPRECATED;
#endif //WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Config, Category = Settings)
    TSubclassOf<UNavAreaBase> DownDirectionAreaClass;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings)
    TSubclassOf<UNavAreaBase> UpDirectionAreaClass;
 
    UPROPERTY(EditAnywhere, Category= Settings)
    TSubclassOf<UBaseGeneratedNavLinksProxy> LinkProxyClass;
 
    UPROPERTY()
    FNavLinkId LinkProxyId;
 
    UPROPERTY(Transient)
    TObjectPtr<UBaseGeneratedNavLinksProxy> LinkProxy = nullptr;
 
    UPROPERTY(Transient)
    bool bLinkProxyRegistered = false;
 
    bool Serialize(FArchive& Ar);
 
#if WITH_RECAST 
    void CopyToDetourConfig(dtNavLinkBuilderJumpConfig& OutDetourConfig) const;
#endif //WITH_RECAST
};
 
template<> struct TStructOpsTypeTraits<FNavLinkGenerationJumpConfig> : public TStructOpsTypeTraitsBase2<FNavLinkGenerationJumpConfig>
{
    enum
    {
        WithSerializer = true
    };
};
 
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
struct dtNavLinkBuilderJumpDownConfig;
 
USTRUCT()
struct UE_DEPRECATED(5.7, "Use FNavLinkGenerationJumpConfig instead.") FNavLinkGenerationJumpDownConfig
{
    GENERATED_BODY()
 
    FNavLinkGenerationJumpDownConfig();
 
    // Note: We need to explicitly disable warnings on these constructors/operators for clang to be happy with deprecated variables
    ~FNavLinkGenerationJumpDownConfig() = default;
    FNavLinkGenerationJumpDownConfig(const FNavLinkGenerationJumpDownConfig&) = default;
    FNavLinkGenerationJumpDownConfig(FNavLinkGenerationJumpDownConfig&&) = default;
    FNavLinkGenerationJumpDownConfig& operator=(const FNavLinkGenerationJumpDownConfig&) = default;
    FNavLinkGenerationJumpDownConfig& operator=(FNavLinkGenerationJumpDownConfig&&) = default;
 
    UPROPERTY(Config)       // @todo Hidden for now. Since there is currently only one config, it has no real usage.
    bool bEnabled = true;
    
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpLength = 150.f; 
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpDistanceFromEdge = 10.f; 
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpMaxDepth = 150.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpHeight = 50.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float JumpEndsHeightTolerance = 80.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=1, ClampMin=1))
    float SamplingSeparationFactor = 1.f;
    
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta=(UIMin=0, ClampMin=0))
    float FilterDistanceThreshold = 80.f;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings, meta = (Bitmask, BitmaskEnum = "/Script/NavigationSystem.ENavLinkBuilderFlags"))
    uint16 LinkBuilderFlags = (uint16)ENavLinkBuilderFlags::CreateCenterPointLink;
 
#if WITH_EDITORONLY_DATA
    UE_DEPRECATED(5.6, "AreaClass is deprecated")
    UPROPERTY(Config, meta = (DeprecatedProperty, DeprecationMessage = "Use DownDirectionAreaClass and UpDirectionAreaClass instead."))
    TSubclassOf<UNavAreaBase> AreaClass_DEPRECATED;
#endif //WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Config, Category = Settings)
    TSubclassOf<UNavAreaBase> DownDirectionAreaClass;
 
    UPROPERTY(EditAnywhere, Config, Category = Settings)
    TSubclassOf<UNavAreaBase> UpDirectionAreaClass;
 
    UPROPERTY(EditAnywhere, Category= Settings)
    TSubclassOf<UBaseGeneratedNavLinksProxy> LinkProxyClass;
 
    UPROPERTY()
    FNavLinkId LinkProxyId;
 
    UPROPERTY(Transient)
    TObjectPtr<UBaseGeneratedNavLinksProxy> LinkProxy = nullptr;
 
    UPROPERTY(Transient)
    bool bLinkProxyRegistered = false;
 
    bool Serialize(FArchive& Ar);
 
#if WITH_RECAST 
    void CopyToDetourConfig(dtNavLinkBuilderJumpDownConfig& OutDetourConfig) const;
#endif //WITH_RECAST
};
 
template<> struct TStructOpsTypeTraits<FNavLinkGenerationJumpDownConfig> : public TStructOpsTypeTraitsBase2<FNavLinkGenerationJumpDownConfig>
{
    enum
    {
        WithSerializer = true
    };
};
PRAGMA_ENABLE_DEPRECATION_WARNINGS