NavLinkCustomInterface.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 "Templates/SubclassOf.h"
#include "UObject/Interface.h"
#include "NavAreas/NavArea.h"
#include "AI/Navigation/NavLinkDefinition.h"
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_4
#include "Engine/World.h"
#endif
#include "Engine/WorldInitializationValues.h"
#include "NavLinkCustomInterface.generated.h"
 
UINTERFACE(MinimalAPI, meta=(CannotImplementInterfaceInBlueprint))
class UNavLinkCustomInterface : public UInterface
{
    GENERATED_UINTERFACE_BODY()
};
 
class INavLinkCustomInterface
{
    GENERATED_IINTERFACE_BODY()
 
    
    virtual void GetLinkData(FVector& LeftPt, FVector& RightPt, ENavLinkDirection::Type& Direction) const {};
 
    virtual void GetSupportedAgents(FNavAgentSelector& OutSupportedAgents) const {};
 
    virtual TSubclassOf<UNavArea> GetLinkAreaClass() const { return nullptr; }
 
    virtual FNavLinkAuxiliaryId GetAuxiliaryId() const { return FNavLinkAuxiliaryId::Invalid; }
 
    UE_DEPRECATED(5.3, "LinkIds are now based on a FNavLinkId. Call GetId() instead. This function only returns Invalid Id.")
    virtual uint32 GetLinkId() const final { return static_cast<uint32>(FNavLinkId::Invalid.GetId()); }
 
    virtual FNavLinkId GetId() const { return FNavLinkId::Invalid; }
 
    UE_DEPRECATED(5.3, "LinkIds are now based on a FNavLinkId. Call the version of this function that takes a FNavLinkId. This function now has no effect.")
    virtual void UpdateLinkId(uint32 NewUniqueId) final {}
 
    virtual void UpdateLinkId(FNavLinkId NewUniqueId) {}
 
    NAVIGATIONSYSTEM_API virtual UObject* GetLinkOwner() const;
 
    virtual bool IsLinkPathfindingAllowed(const UObject* Querier) const { return true; }
 
    virtual bool OnLinkMoveStarted(class UObject* PathComp, const FVector& DestPoint) { return false; }
 
    virtual void OnLinkMoveFinished(class UObject* PathComp) {}
 
    virtual bool IsLinkUsingCustomReachCondition(const UObject* PathComp) const { return false; }
 
    virtual bool HasReachedLinkStart(const UObject* PathComp, const FVector& CurrentLocation, const FNavPathPoint& LinkStart, const FNavPathPoint& LinkEnd) const { return true; }
 
    UE_DEPRECATED(5.3, "LinkIds are now based on FNavLinkId using FNavLinkId::GenerateUniqueId(). This function will still generate an incremental Id however it does not work well in all circumstances.")
    static NAVIGATIONSYSTEM_API uint32 GetUniqueId();
 
    UE_DEPRECATED(5.3, "LinkIds are now based on FNavLinkId. If your project is still using any of the old incremental Ids (saved in actors in levels or licensee code) then this function must be called still (typically by existing engine code), otherwise it is not necessary.")
    static NAVIGATIONSYSTEM_API void UpdateUniqueId(FNavLinkId AlreadyUsedId);
 
    UE_DEPRECATED(5.3, "LinkIds are now based on FNavLinkId. You may need to call the other version of this function that takes a FNavLinkId. This function has no effect.")
    static void UpdateUniqueId(uint32 AlreadyUsedId) {}
 
    static NAVIGATIONSYSTEM_API FNavigationLink GetModifier(const INavLinkCustomInterface* CustomNavLink);
    
    UE_DEPRECATED(5.3, "LinkIds are now based on a FNavLinkId Hash. If your project is still using any of the old incremental Ids then this function must be called still (typically by existing engine code), otherwise it is not necessary.")
    static NAVIGATIONSYSTEM_API void ResetUniqueId();
 
    static NAVIGATIONSYSTEM_API void OnPreWorldInitialization(UWorld* World, const FWorldInitializationValues IVS);
 
    UE_DEPRECATED(5.3, "LinkIds are now based on FNavLinkId using FNavLinkId::GenerateUniqueId().")
    static uint32 NextUniqueId;
};