NavArea.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_4
#include "CoreMinimal.h"
#endif
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Templates/SubclassOf.h"
#include "AI/Navigation/NavAreaBase.h"
#include "AI/Navigation/NavAgentSelector.h"
#include "NavArea.generated.h"
 
UCLASS(DefaultToInstanced, abstract, Config=Engine, Blueprintable, MinimalAPI)
class UNavArea : public UNavAreaBase
{
    GENERATED_BODY()
 
public: 
    UPROPERTY(EditAnywhere, Category=NavArea, config, meta=(ClampMin = "0.0"))
    float DefaultCost;
 
protected:
    UPROPERTY(EditAnywhere, Category=NavArea, config, meta=(ClampMin = "0.0"))
    float FixedAreaEnteringCost;
 
public:
    UPROPERTY(EditAnywhere, Category=NavArea, config)
    FColor DrawColor;
 
    UPROPERTY(EditAnywhere, Category=NavArea, config)
    FNavAgentSelector SupportedAgents;
 
    // DEPRECATED AGENT CONFIG
#if CPP
    union
    {
        struct
        {
#endif
    UPROPERTY(config)
    uint32 bSupportsAgent0 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent1 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent2 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent3 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent4 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent5 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent6 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent7 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent8 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent9 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent10 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent11 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent12 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent13 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent14 : 1;
    UPROPERTY(config)
    uint32 bSupportsAgent15 : 1;
#if CPP
        };
        uint32 SupportedAgentsBits;
    };
#endif
 
    NAVIGATIONSYSTEM_API UNavArea(const FObjectInitializer& ObjectInitializer = FObjectInitializer::Get());
 
    NAVIGATIONSYSTEM_API virtual void FinishDestroy() override;
    NAVIGATIONSYSTEM_API virtual void PostLoad() override;
    NAVIGATIONSYSTEM_API virtual void PostInitProperties() override;
    NAVIGATIONSYSTEM_API virtual void Serialize(FArchive& Ar) override;
#if WITH_EDITOR
    NAVIGATIONSYSTEM_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent);
#endif // WITH_EDITOR
 
    inline uint16 GetAreaFlags() const { return AreaFlags; }
    inline bool HasFlags(uint16 InFlags) const { return (InFlags & AreaFlags) != 0; }
 
    inline bool IsSupportingAgent(int32 AgentIndex) const { return SupportedAgents.Contains(AgentIndex); }
 
    virtual void InitializeArea() {};
 
    virtual float GetFixedAreaEnteringCost() { return FixedAreaEnteringCost; }
 
    static NAVIGATIONSYSTEM_API FColor GetColor(UClass* AreaDefinitionClass);
 
    NAVIGATIONSYSTEM_API virtual void CopyFrom(TSubclassOf<UNavArea> AreaClass);
 
protected:
 
    uint16 AreaFlags;
    
    NAVIGATIONSYSTEM_API void RegisterArea();
};