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

References

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

Syntax

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 bool bSmartLinkIsRelevant Smart link: toggle relevancy
Protected variable FDelegateHandle OnNavAreaRegisteredDelegateHandle  
Protected variable FDelegateHandle OnNavAreaUnregisteredDelegateHandle  
Protected variable FSmartLinkReachedSignature OnSmartLinkReached  
Public variable TArray< FNavigationLink > PointLinks Navigation links (point to point) added to navigation data
Public variable 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 void Copies navlink end points from the first entry in PointLinks array.
Public function Const UNavLinkRenderingComponent * Returns EdRenderComp subobject
Public function Const UNavLinkCustomComponent * Returns SmartLinkComp subobject
Public function Const UBillboardComponent * Returns SpriteComponent subobject
Public function Const bool Check if any agent is moving through smart link right now
Public function Const 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 void

ReceiveSmartLinkReached ( AActor* Agent,
const FVector& Destination
)

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

SetSmartLinkEnabled ( bool bEnabled
)

 Change state of smart link

Overridden from AActor

  Type Name Description
Protected function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual Const FBox

GetComponentsBoundingBox ( bool bNonColliding,
bool bIncludeFromChildActors
)

 Returns the world space bounding box of all components in this Actor.
Public function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from INavLinkHostInterface

  Type Name Description
Public function Virtual Const bool Optional way of retrieving navigation link data - if INavLinkHostInterface implementer defines custom navigation links then it can just retrieve a list of links
Public function Virtual Const bool Retrieves UNavLinkDefinition derived UClasses hosted by this interface implementer

Overridden from INavRelevantInterface

  Type Name Description
Public function Virtual Const FBox Get bounds for navigation octree
Public function Virtual Const void Prepare navigation modifiers
Public function Virtual Const bool Are modifiers active?

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page