Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > NavigationSystem > UNavLinkCustomComponent

Light Theme

Dark Theme

UNavLinkCustomComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UNavRelevantComponent

UNavLinkCustomComponent

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

	Name	Description
uint32: 1	bCreateBoxObstacle	If set, box obstacle area will be added to generation
uint32: 1	bLinkEnabled	Is link currently in enabled state? (area class)
uint32: 1	bNotifyWhenDisabled	Should link notify nearby agents when it changes state to disabled
uint32: 1	bNotifyWhenEnabled	Should link notify nearby agents when it changes state to enabled
TEnumAsByte< EC...	BroadcastChannel	Trace channel for state change broadcast
float	BroadcastInterval	Interval for state change broadcast (0 = single broadcast)
float	BroadcastRadius	Radius of state change broadcast
TSubclassOf< UN...	DisabledAreaClass	Area class to use when link is disabled
TSubclassOf< UN...	EnabledAreaClass	Area class to use when link is enabled
TEnumAsByte< EN...	LinkDirection	Direction of link
FVector	LinkRelativeEnd	End point, relative to owner
FVector	LinkRelativeStart	Start point, relative to owner
TArray< TWeakOb...	MovingAgents	List of agents moving though this link
uint32	NavLinkUserId	Link Id assigned by navigation system
TSubclassOf< UN...	ObstacleAreaClass	Area class for simple box obstacle
FVector	ObstacleExtent	Extent of simple box obstacle
FVector	ObstacleOffset	Offset of simple box obstacle
FBroadcastFilte...	OnBroadcastFilter	Delegate to call when link is reached
FOnMoveReachedL...	OnMoveReachedLink	Delegate to call when link is reached
FNavAgentSelect...	SupportedAgents	Restrict area only to specified agents
FTimerHandle	TimerHandle_BroadcastStateChange	Handle for efficient management of BroadcastStateChange timer

Constructors

	Name	Description
	UNavLinkCustomComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
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
void	ApplyComponentInstanceData ( FNavLinkCustomInstanceData* Co... )
void	BroadcastStateChange()	Notify nearby agents about link changing state
void	ClearNavigationObstacle()	Removes simple obstacle
void	CollectNearbyAgents ( TArray< UObject* >& NotifyLis... )	Gather agents to notify about state change
TSubclassOf<...	GetDisabledArea()
TSubclassOf<...	GetEnabledArea()
FVector	GetEndPoint()	Get link end point in world space
FNavigationL...	GetLinkModifier()
FVector	GetStartPoint()	Get link start point in world space
FNavAgentSel...	GetSupportedAgents()
bool	HasMovingAgents()	Check is any agent is currently moving though this link
bool	IsEnabled()
void	SendBroadcastWhenDisabled ( bool bEnabled )
void	SendBroadcastWhenEnabled ( bool bEnabled )
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
void	SetBroadcastFilter ( UserClass* TargetOb, typename FBroadcastFilter::TUObject... )
void	SetBroadcastFilter ( UserClass* TargetOb, typename FBroadcastFilter::TUObject... )
void	SetBroadcastFilter ( FBroadcastFilter const& InDelegate )	Set delegate to filter
void	SetDisabledArea ( TSubclassOf< UNavArea > AreaClass )	Set area class to use when link is disabled
void	SetEnabled ( bool bNewEnabled )	Change state of smart link (used area class)
void	SetEnabledArea ( TSubclassOf< UNavArea > AreaClass )	Set area class to use when link is enabled
void	SetLinkData ( const FVector& RelativeStart, const FVector& RelativeEnd, ENavLinkDirection::Type Direction )	Set basic link data: end points and direction
void	SetMoveReachedLink ( FOnMoveReachedLink const& InDelega... )	Set delegate to notify about reaching this link during path following
void	SetMoveReachedLink ( UserClass* TargetOb, typename FOnMoveReachedLink::TUObje... )
void	SetMoveReachedLink ( UserClass* TargetOb, typename FOnMoveReachedLink::TUObje... )
void	SetSupportedAgents ( const FNavAgentSelector& InSupport... )

Overridden from UNavRelevantComponent

		Name	Description
	void	CalcAndCacheBounds()

Overridden from UActorComponent

	Name	Description
TStructOnSco...	GetComponentInstanceData()	Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

		Name	Description
	void	PostEditImport()	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
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Overridden from INavRelevantInterface

		Name	Description
	void	GetNavigationData ( FNavigationRelevantData& Data )	Prepare navigation modifiers

Overridden from INavLinkCustomInterface

	Name	Description
TSubclassOf<...	GetLinkAreaClass()	Get basic link data: area class (null = default walkable)
void	GetLinkData ( FVector& LeftPt, FVector& RightPt, ENavLinkDirection::Type& Direction )	Get basic link data: two points (relative to owner) and direction
uint32	GetLinkId()	Get unique ID number for custom link Owner should get its unique ID by calling INavLinkCustomInterface::GetUniqueId() and store it
void	GetSupportedAgents ( FNavAgentSelector& OutSupportedAge... )	Get agents supported by this link
bool	IsLinkPathfindingAllowed ( const UObject* Querier )	Check if link allows path finding Querier is usually an AIController trying to find path
void	OnLinkMoveFinished ( UObject* PathComp )	Notify called when agent finishes using this link for movement
bool	OnLinkMoveStarted ( UObject* PathComp, const FVector& DestPoint )	Notify called when agent starts using this link for movement.
void	UpdateLinkId ( uint32 NewUniqueId )	Update unique ID number for custom link by navigation system

Typedefs

Name	Description
FBroadcastFilter
FOnMoveReachedLink

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss