1. Epic GamesDeveloper
  3. ANavLinkProxy

ANavLinkProxy

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

API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/Navigation

Inheritance Hierarchy

  • AActor
  • INavLinkHostInterface
  • INavRelevantInterface
  • ANavLinkProxy

References

   
Module AIModule
Header /Engine/Source/Runtime/AIModule/Classes/Navigation/NavLinkProxy.h
Include #include "Navigation/NavLinkProxy.h"

Syntax

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

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bSmartLinkIsRelevant Smart link: toggle relevancy
Protected variable FDelegateHandle OnNavAreaRegisteredDelegateHandle  
Protected variable FDelegateHandle OnNavAreaUnregisteredDelegateHandle  
Protected variable UProperty BlueprintAssignable FSmartLinkReachedSignature OnSmartLinkReached  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TArray< FNavigationLink > PointLinks Navigation links (point to point) added to navigation data
Public variable UProperty TArray< FNavigationSegmentLink > SegmentLinks Navigation links (segment to segment) added to navigation data

Constructors

  Type Name Description
Public function  

ANavLinkProxy ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void  
Protected function Virtual void  
Public function UFunction Category, Meta callineditor void Copies navlink end points from the first entry in PointLinks array.
Public function Virtual Const FBox

GetComponentsBoundingBox ( bool bNonColliding,
bool bIncludeFromChildActors
)

  
Public function Const UNavLinkRenderingComponent * Returns EdRenderComp subobject
Public function Virtual Const FBox  
Public function Virtual Const void

GetNavigationData ( FNavigationRelevantData& Data
)

  
Public function Virtual Const bool

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

  
Public function Virtual Const bool

GetNavigationLinksClasses ( TArray< TSubclassOf< UNavLinkDefinition > >& OutClasses
)

  
Public function Const UNavLinkCustomComponent * Returns SmartLinkComp subobject
Public function Const UBillboardComponent * Returns SpriteComponent subobject
Public function Const UFunction BlueprintCallable, Category bool Check if any agent is moving through smart link right now
Public function Virtual Const bool  
Public function Const UFunction BlueprintCallable, Category bool Check if smart link is enabled
Protected function void

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

  
Protected function void

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

  
Protected function void

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

  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function UFunction BlueprintImplementableEvent void

ReceiveSmartLinkReached ( AActor* Agent,
const FVector& Destination
)

 Called when agent reaches smart link during path following, use ResumePathFollowing() to give control back
Public function UFunction BlueprintCallable, Category void

ResumePathFollowing ( AActor* Agent
)

 Resume normal path following
Public function UFunction BlueprintCallable, Category void

SetSmartLinkEnabled ( bool bEnabled
)

 Change state of smart link

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page