1. Epic GamesDeveloper
  3. UNavLinkCustomComponent

UNavLinkCustomComponent

Encapsulates NavLinkCustomInterface interface, can be used with Actors not relevant for navigation

Unreal Engine C++ API Reference > Runtime > NavigationSystem

Inheritance Hierarchy

References

   
Module NavigationSystem
Header /Engine/Source/Runtime/NavigationSystem/Public/NavLinkCustomComponent.h
Include #include "NavLinkCustomComponent.h"

Syntax

class UNavLinkCustomComponent :  
    public UNavRelevantComponent,  
    public INavLinkCustomInterface

Remarks

Encapsulates NavLinkCustomInterface interface, can be used with Actors not relevant for navigation

Additional functionality:

  • can be toggled
  • can create obstacle area for easier/forced separation of link end points
  • can broadcast state changes to nearby agents

Variables

  Type Name Description
Protected variable FNavLinkAuxiliaryId AuxiliaryCustomLinkId Assigned in the constructor.
Protected variable uint32: 1 bCreateBoxObstacle If set, box obstacle area will be added to generation
Protected variable uint32: 1 bLinkEnabled Is link currently in enabled state? (area class)
Protected variable uint32: 1 bNotifyWhenDisabled Should link notify nearby agents when it changes state to disabled
Protected variable uint32: 1 bNotifyWhenEnabled Should link notify nearby agents when it changes state to enabled
Protected variable TEnumAsByte< ECollisionChannel > BroadcastChannel Trace channel for state change broadcast
Protected variable float BroadcastInterval Interval for state change broadcast (0 = single broadcast)
Protected variable float BroadcastRadius Radius of state change broadcast
Protected variable FNavLinkId CustomLinkId Link Id assigned by navigation system
Protected variable TSubclassOf< UNavArea > DisabledAreaClass Area class to use when link is disabled
Protected variable TSubclassOf< UNavArea > EnabledAreaClass Area class to use when link is enabled
Protected variable TEnumAsByte< ENavLinkDirection::Type > LinkDirection Direction of link
Protected variable FVector LinkRelativeEnd End point, relative to owner
Protected variable FVector LinkRelativeStart Start point, relative to owner
Protected variable TArray< TWeakObjectPtr< UObject > > MovingAgents List of agents moving though this link
Protected variable TSubclassOf< UNavArea > ObstacleAreaClass Area class for simple box obstacle
Protected variable FVector ObstacleExtent Extent of simple box obstacle
Protected variable FVector ObstacleOffset Offset of simple box obstacle
Protected variable FBroadcastFilter OnBroadcastFilter Delegate to call when link is reached
Protected variable FOnMoveReachedLink OnMoveReachedLink Delegate to call when link is reached
Protected variable FDelegateHandle OnNavAreaRegisteredDelegateHandle  
Protected variable FDelegateHandle OnNavAreaUnregisteredDelegateHandle  
Protected variable FNavAgentSelector SupportedAgents Restrict area only to specified agents
Protected variable FTimerHandle TimerHandle_BroadcastStateChange Handle for efficient management of BroadcastStateChange timer

Constructors

  Type Name Description
Public function  

UNavLinkCustomComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddNavigationObstacle ( TSubclassOf< UNavArea > AreaClass,
const FVector& BoxExtent,
const FVector& BoxOffset
)

 Add box obstacle during generation of navigation data this can be used to create empty area under doors
Public function void  
Protected function void Notify nearby agents about link changing state
Public function void Removes simple obstacle
Protected function void

CollectNearbyAgents ( TArray< UObject* >& NotifyList
)

 Gather agents to notify about state change
Public function Const TSubclassOf< UNavArea >  
Public function Const TSubclassOf< UNavArea >  
Public function Const FVector Get link end point in world space
Public function Virtual Const FNavigationLink  
Public function Const TSubclassOf< UNavArea >  
Public function Const FVector Get link start point in world space
Public function Const FNavAgentSelector  
Public function Const bool Check is any agent is currently moving though this link
Public function Const bool  
Protected function void

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

  
Protected function void

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

  
Public function void

SendBroadcastWhenDisabled ( bool bEnabled
)

  
Public function void

SendBroadcastWhenEnabled ( bool bEnabled
)

  
Public function void

SetBroadcastData ( float Radius,
ECollisionChannel TraceChannel,
float Interval
)

 Set properties of trigger around link entry point(s), that will notify nearby agents about link state change
Public function void

SetBroadcastFilter ( UserClass* TargetOb,
typename FBroadcastFilter::TConstMethodPtr< UserClass > InFunc
)

  
Public function void

SetBroadcastFilter ( UserClass* TargetOb,
typename FBroadcastFilter::TMethodPtr< UserClass > InFunc
)

  
Public function void

SetBroadcastFilter ( FBroadcastFilter const& InDelegate
)

 Set delegate to filter
Public function void Set area class to use when link is disabled
Public function void

SetEnabled ( bool bNewEnabled
)

 Change state of smart link (used area class)
Public function void Set area class to use when link is enabled
Public function void

SetLinkData ( const FVector& RelativeStart,
const FVector& RelativeEnd,
ENavLinkDirection::Type Direction
)

 Set basic link data: end points and direction
Public function void

SetMoveReachedLink ( FOnMoveReachedLink const& InDelegate
)

 Set delegate to notify about reaching this link during path following
Public function void

SetMoveReachedLink ( UserClass* TargetOb,
typename FOnMoveReachedLink::TMethodPtr< UserClass > InFunc
)

  
Public function void

SetMoveReachedLink ( UserClass* TargetOb,
typename FOnMoveReachedLink::TConstMethodPtr< UserClass > InFunc
)

  
Public function void

SetSupportedAgents ( const FNavAgentSelector& InSupportedAgents
)

  

Overridden from UNavRelevantComponent

  Type Name Description
Public function Virtual Const void  

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
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 Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from INavRelevantInterface

  Type Name Description
Public function Virtual Const void Prepare navigation modifiers

Overridden from INavLinkCustomInterface

  Type Name Description
Public function Virtual Const FNavLinkAuxiliaryId  
Public function Virtual Const FNavLinkId

GetId ()

 Get unique ID number for custom link Owner should get its unique ID by calling INavLinkCustomInterface::GetUniqueId() and store it
Public function Virtual Const TSubclassOf< UNavArea > Get basic link data: area class (null = default walkable)
Public function Virtual Const void

GetLinkData ( FVector& LeftPt,
FVector& RightPt,
ENavLinkDirection::Type& Direction
)

 Get basic link data: two points (relative to owner) and direction
Public function Virtual Const void

GetSupportedAgents ( FNavAgentSelector& OutSupportedAgents
)

 Get agents supported by this link
Public function Virtual Const bool

IsLinkPathfindingAllowed ( const UObject* Querier
)

 Check if link allows path finding Querier is usually an AIController trying to find path
Public function Virtual void

OnLinkMoveFinished ( UObject* PathComp
)

 Notify called when agent finishes using this link for movement
Public function Virtual bool

OnLinkMoveStarted ( UObject* PathComp,
const FVector& DestPoint
)

 Notify called when agent starts using this link for movement.
Public function Virtual void

UpdateLinkId ( FNavLinkId NewUniqueId
)

 Update unique ID number for custom link by navigation system.

Typedefs

Name Description
FBroadcastFilter  
FOnMoveReachedLink  

Deprecated Variables

  Type Name Description
Protected variable uint32 NavLinkUserId LinkIds are now based on FNavLinkId. Use CustomLinkId instead. This Id is no longer used by the engine.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page