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 > FNavigationPath

Light Theme

Dark Theme

FNavigationPath

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FNavigationPath

FAbstractNavigationPath

FNavMeshPath

FMetaNavMeshPath

References

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

Syntax

struct FNavigationPath : public TSharedFromThis< FNavigationPath, ESPMode::ThreadSafe >

Variables

	Name	Description
TWeakObjectPtr<...	Base	Base actor, if exist path points locations will be relative to it
uint32: 1	bDoAutoUpdateOnInvalidation	If true path will request re-pathing if it gets invalidated due to underlying navigation changed
uint32: 1	bIgnoreInvalidation	If true path will keep bUpToDate value after getting invalidated due to underlying navigation changed (observer and auto repath will NOT be triggered!) it's NOT safe to use if path relies on navigation data references (e.g. poly corridor)
uint32: 1	bIsPartial	"true" when path is only partially generated, when goal is unreachable and path represent best guess
uint32: 1	bIsReady	When false it means path instance has been created, but not filled with data yet
uint32: 1	bObservingGoalActor	Indicates whether at any point GoalActor was a valid Actor.
uint32: 1	bReachedSearchLimit	Set to true when path finding algorithm reached a technical limit (like limit of A* nodes).
uint32: 1	bUpdateEndPointOnRepath	If true path will use GetGoalLocation() for updating QueryData before repath
uint32: 1	bUpdateStartPointOnRepath	If true path will use GetPathFindingStartLocation() for updating QueryData before repath
uint32: 1	bUpToDate	"true" until navigation data used to generate this path has been changed/invalidated
uint32: 1	bUseOnPathUpdatedNotify	If true path will call OnPathUpdated notify
uint32: 1	bWaitingForRepath	Set when path is waiting for recalc from navigation data
FSharedConstNav...	Filter	DEPRECATED: filter used to build this path.
float	LastUpdateTimeStamp	Gets set during path creation and on subsequent path's updates
TWeakObjectPtr<...	NavigationDataUsed	Navigation data used to generate this path
FPathObserverDe...	ObserverDelegate	A delegate that will be called when path becomes invalid
FPathFindingQue...	PathFindingQueryData	Essential part of query used to generate this path
TArray< FNavPat...	PathPoints	IMPORTANT: path is assumed to be valid if it contains MORE than ONE point point 0 is path's starting point - if it's the only point on the path then there's no path per se
FNavPathType	PathType
TArray< NavNode...	ShortcutNodeRefs	Additional node refs used during path following shortcuts

Constructors

	Name	Description
	FNavigationPath()
	FNavigationPath ( const TArray< FVector >& Points, AActor* Base )

Destructors

	Name	Description
	~FNavigationPath()

Functions

	Name	Description
FDelegateHan...	AddObserver ( FPathObserverDelegate::FDelegate Ne... )
PathClass &#...	CastPath()
const PathCl...	CastPath()	Type safe casts
bool	ContainsAnyCustomLink()	Check if path contains any custom nav link
bool	ContainsCustomLink ( uint32 UniqueLinkId )	Check if path contains specific custom nav link
bool	ContainsNode ( NavNodeRef NodeRef )	Check if path contains given node
void	DebugDraw ( const ANavigationData* NavData, FColor PathColor, UCanvas* Canvas, bool bPersistent, const uint32 NextPathPointIndex )
void	DescribeSelfToVisLog ( FVisualLogEntry* Snapshot )
bool	DidSearchReachedLimit()
void	DisableGoalActorObservation()	Turns goal actor location's observation
bool	DoesIntersectBox ( const FBox& Box, const FVector& AgentLocation, uint32 StartingIndex, int32* IntersectingSegmentInde..., FVector* AgentExtent )	Checks if given path, starting from StartingIndex, intersects with given AABB box.
bool	DoesIntersectBox ( const FBox& Box, uint32 StartingIndex, int32* IntersectingSegmentInde..., FVector* AgentExtent )	Checks if given path, starting from StartingIndex, intersects with given AABB box
void	DoneUpdating ( ENavPathUpdateType::Type UpdateType )
void	EnableRecalculationOnInvalidation ( bool bShouldAutoUpdate )	If enabled path will request recalculation if it gets invalidated due to a change to underlying navigation
AActor *	GetBaseActor()
float	GetCost()
float	GetCostFromIndex ( int32 PathPointIndex )	Get cost of path, starting from given point
float	GetCostFromNode ( NavNodeRef PathNode )	Get cost of path, starting from given node
FString	GetDescription()
FVector	GetDestinationLocation()
FVector	GetEndLocation()
FSharedConst...	GetFilter()
const AActor...	GetGoalActor()
const INavAg...	GetGoalActorAsNavAgent()
float	GetGoalActorTetherDistance()
FVector	GetGoalLocation()	If GoalActor is set it retrieved its navigation location, if not retrieved last path point location
bool	GetIgnoreInvalidation()
FVector	GetLastRepathGoalLocation()
float	GetLastUpdateTime()
float	GetLength()
float	GetLengthFromPosition ( FVector SegmentStart, uint32 NextPathPointIndex )	Calculates total length of segments from NextPathPoint to the end of path, plus distance from CurrentPosition to NextPathPoint
ANavigationD...	GetNavigationDataUsed()
FPathObserve...	GetObserver()
FVector	GetPathFindingStartLocation()	Retrieved location to start path finding from (in case of path recalculation)
bool	GetPathPoint ( const FNavigationPath* Path, uint32 PathVertIdx, FNavPathPoint& PathPoint )
FBasedPositi...	GetPathPointLocation ( uint32 Index )	Get based position of path point
TArray< FNav...	GetPathPoints()
const TArray...	GetPathPoints()
const UObjec...	GetQuerier()
FPathFinding...	GetQueryData()
FVector	GetSegmentDirection ( uint32 SegmentEndIndex )	Retrieves normalized direction vector to given path segment for '0'-th segment returns same as for 1st segment
const AActor...	GetSourceActor()
const INavAg...	GetSourceActorAsNavAgent()
FVector	GetStartLocation()
float	GetTimeStamp()
void	Invalidate()
bool	IsPartial()
bool	IsReady()
bool	IsUpToDate()
bool	IsValid()
bool	IsWaitingForRepath()
void	MarkReady()
void	OnPathUpdated ( ENavPathUpdateType::Type UpdateType )	Optional notify called when path finishes update, before broadcasting to observes - requires bUseOnPathUpdatedNotify flag set
void	RemoveObserver ( FDelegateHandle HandleOfObserverToR... )
void	RePathFailed()
void	ResetForRepath()	Resets all variables describing generated path before attempting new pathfinding call.
void	SetFilter ( FSharedConstNavQueryFilter InFilter )
void	SetGoalActorObservation ( const AActor& ActorToObserve, float TetherDistance )	Enables path observing specified AActor's location and update itself if actor changes location
void	SetGoalActorTetherDistance ( const float NewTetherDistace )	Modifies distance to the GoalActor at which we'll update the path
void	SetIgnoreInvalidation ( bool bShouldIgnore )	If ignoring, path will stay bUpToDate after being invalidated due to a change to underlying navigation (observer and auto repath will NOT be triggered!)
void	SetIsPartial ( const bool bPartial )	FORCEINLINE void SetObserver(const FPathObserverDelegate& Observer) { ObserverDelegate = Observer; }.
void	SetManualRepathWaiting ( const bool bInWaitingForRepath )
void	SetNavigationDataUsed ( const ANavigationData*const Ne... )
void	SetQuerier ( const UObject* InQuerier )
void	SetQueryData ( const FPathFindingQueryData& Query... )
void	SetSearchReachedLimit ( const bool bLimited )
void	SetSourceActor ( const AActor& InSourceActor )	Set's up the path to use SourceActor's location in case of recalculation
void	SetTimeStamp ( float TimeStamp )
bool	ShouldUpdateEndPointOnRepath()
bool	ShouldUpdateStartPointOnRepath()
EPathObserva...	TickPathObservation()
void	UpdateLastRepathGoalLocation()
bool	WillRecalculateOnInvalidation()

Typedefs

Name	Description
FPathObserverDelegate	DECLARE_DELEGATE_OneParam(FPathObserverDelegate, FNavigationPath*);.

Constants

Name	Description
Type	Type of path

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

Take our survey

Dismiss