1. Epic GamesDeveloper
  3. ANavLinkProxy

ANavLinkProxy

[ANavLinkProxy](API\Runtime\AIModule\ANavLinkProxy) connects areas of Navmesh that don't have a direct navigation path.

API > API/Runtime > API/Runtime/AIModule

ANavLinkProxy connects areas of Navmesh that don't have a direct navigation path. It directly supports Simple Links (see PointLinks array). There can be multiple Simple links per ANavLinkProxy instance. Simple links are designed to statically link areas of Navmesh and are associated with a particular area class that the link provides. Smart Link functionality is provided via UNavLinkCustomComponent, see SmartLinkComp. They are designed to be able to be dynamically toggled between enabled and disabled and provide different area classes for both cases. The area classes can be dynamically modified without navmesh rebuilds. There can only be at most one smart link per ANavLinkProxy instance. Both simple and smart links on a single ANavLinkProxy instance, can be set / enabled at once, as well as either or neither of them.

   
Name ANavLinkProxy
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/Navigation/NavLinkProxy.h
Include Path #include "Navigation/NavLinkProxy.h"

Syntax

UCLASS (Blueprintable, AutoCollapseCategories=(SmartLink, Actor), HideCategories=(Input),  
       MinimalAPI)  
class ANavLinkProxy :  
    public AActor ,  
    public INavLinkHostInterface ,  
    public INavRelevantInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ANavLinkProxy ( const FObjectInitializer& ObjectInitializer
)

   Navigation/NavLinkProxy.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bSmartLinkIsRelevant bool Smart link: toggle relevancy Navigation/NavLinkProxy.h
  • EditAnywhere
  • Category=SmartLink
PointLinks TArray< FNavigationLink > Navigation links (point to point) added to navigation data Navigation/NavLinkProxy.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=SimpleLink
SegmentLinks TArray< FNavigationSegmentLink > Navigation links (segment to segment) added to navigation data Navigation/NavLinkProxy.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
EdRenderComp TObjectPtr< UNavLinkRenderingComponent > Editor Preview Navigation/NavLinkProxy.h  
SmartLinkComp TObjectPtr< UNavLinkCustomComponent > Smart link: can affect path following Navigation/NavLinkProxy.h
  • VisibleAnywhere
  • Category=SmartLink
SpriteComponent TObjectPtr< UBillboardComponent >   Navigation/NavLinkProxy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Copies navlink end points from the first entry in PointLinks array. Navigation/NavLinkProxy.h
  • CallInEditor
  • Category=SmartLink
  • Meta=(DisplayName="CopyEndPointsFromSimpleLink")

UNavLinkRenderingComponent * GetEdRenderComp()

 Returns EdRenderComp subobject Navigation/NavLinkProxy.h  

virtual FBox GetNavigationBounds()

   Navigation/NavLinkProxy.h  

virtual void GetNavigationData ( FNavigationRelevantData& Data
) const

   Navigation/NavLinkProxy.h  

virtual bool GetNavigationLinksArray ( TArray< FNavigationLink >& OutLink,
TArray< FNavigationSegmentLink >& OutSegments
) const

   Navigation/NavLinkProxy.h  

virtual bool GetNavigationLinksClasses ( TArray< TSubclassOf< UNavLinkDefinition > >& OutClasses
) const

   Navigation/NavLinkProxy.h  

UNavLinkCustomComponent * GetSmartLinkComp()

 Returns SmartLinkComp subobject Navigation/NavLinkProxy.h  

UBillboardComponent * GetSpriteComponent()

 Returns SpriteComponent subobject Navigation/NavLinkProxy.h  

bool HasMovingAgents()

 Check if any agent is moving through smart link right now Navigation/NavLinkProxy.h
  • BlueprintCallable
  • Category="AI|Navigation"

virtual bool IsNavigationRelevant()

   Navigation/NavLinkProxy.h  

bool IsSmartLinkEnabled()

 Check if smart link is enabled Navigation/NavLinkProxy.h
  • BlueprintCallable
  • Category="AI|Navigation"

void ReceiveSmartLinkReached ( AActor* Agent,
const FVector& Destination
)

 Called when agent reaches smart link during path following, use ResumePathFollowing() to give control back Navigation/NavLinkProxy.h
  • BlueprintImplementableEvent

void ResumePathFollowing ( AActor* Agent
)

 Resume normal path following Navigation/NavLinkProxy.h
  • BlueprintCallable
  • Category="AI|Navigation"

void SetSmartLinkEnabled ( bool bEnabled
)

 Change state of smart link Navigation/NavLinkProxy.h
  • BlueprintCallable
  • Category="AI|Navigation"

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual FBox GetComponentsBoundingBox ( bool bNonColliding,
bool bIncludeFromChildActors
) const

   Navigation/NavLinkProxy.h  

virtual void PostRegisterAllComponents()

   Navigation/NavLinkProxy.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Navigation/NavLinkProxy.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Navigation/NavLinkProxy.h  

virtual void PostEditImport()

   Navigation/NavLinkProxy.h  

virtual void PostEditUndo()

   Navigation/NavLinkProxy.h  

virtual void PostInitProperties()

   Navigation/NavLinkProxy.h  

virtual void PostLoad()

   Navigation/NavLinkProxy.h  

Protected

Name Remarks Include Path Unreal Specifiers

void NotifySmartLinkReached ( UNavLinkCustomComponent* LinkComp,
UObject* PathingAgent,
const FVector& DestPoint
)

   Navigation/NavLinkProxy.h  

void OnNavAreaRegistered ( const UWorld& World,
const UClass* NavAreaClass
)

   Navigation/NavLinkProxy.h  

void OnNavAreaUnregistered ( const UWorld& World,
const UClass* NavAreaClass
)

   Navigation/NavLinkProxy.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   Navigation/NavLinkProxy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page