1. Epic GamesDeveloper
  3. FNavigationPath

FNavigationPath

Unreal Engine C++ API Reference > Runtime > NavigationSystem

Inheritance Hierarchy

References

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

Syntax

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

Variables

  Type Name Description
Protected variable TWeakObjectPtr< AActor > Base Base actor, if exist path points locations will be relative to it
Protected variable uint32: 1 bDoAutoUpdateOnInvalidation If true path will request re-pathing if it gets invalidated due to underlying navigation changed
Protected variable 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)
Protected variable uint32: 1 bIsPartial "true" when path is only partially generated, when goal is unreachable and path represent best guess
Protected variable uint32: 1 bIsReady When false it means path instance has been created, but not filled with data yet
Protected variable uint32: 1 bObservingGoalActor Indicates whether at any point GoalActor was a valid Actor.
Protected variable uint32: 1 bReachedSearchLimit Set to true when path finding algorithm reached a technical limit (like limit of A* nodes).
Protected variable uint32: 1 bUpdateEndPointOnRepath If true path will use GetGoalLocation() for updating QueryData before repath
Protected variable uint32: 1 bUpdateStartPointOnRepath If true path will use GetPathFindingStartLocation() for updating QueryData before repath
Protected variable uint32: 1 bUpToDate "true" until navigation data used to generate this path has been changed/invalidated
Protected variable uint32: 1 bUseOnPathUpdatedNotify If true path will call OnPathUpdated notify
Protected variable uint32: 1 bWaitingForRepath Set when path is waiting for recalc from navigation data
Protected variable FSharedConstNavQueryFilter Filter DEPRECATED: filter used to build this path.
Protected variable double LastUpdateTimeStamp Gets set during path creation and on subsequent path's updates
Protected variable TWeakObjectPtr< ANavigationData > NavigationDataUsed Navigation data used to generate this path
Protected variable FPathObserverDelegate ObserverDelegate A delegate that will be called when path becomes invalid
Protected variable FPathFindingQueryData PathFindingQueryData Essential part of query used to generate this path
Protected variable TArray< FNavPathPoint > 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
Protected variable FNavPathType PathType  
Public variable TArray< NavNodeRef > ShortcutNodeRefs Additional node refs used during path following shortcuts

Constructors

  Type Name Description
Public function    
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS  
Public function  

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

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FDelegateHandle

AddObserver ( FPathObserverDelegate::FDelegate NewObserver
)

  
Public function PathClass *  
Public function Const const PathClass * Type safe casts
Public function Virtual Const bool Check if path contains any custom nav link
Public function Virtual Const bool

ContainsCustomLink ( FNavLinkId UniqueLinkId
)

  
Public function Virtual Const bool

ContainsNode ( NavNodeRef NodeRef
)

 Check if path contains given node
Public function Virtual Const void  
Public function Const bool  
Public function void Turns goal actor location's observation
Public function Virtual Const bool

DoesIntersectBox ( const FBox& Box,
const FVector& AgentLocation,
uint32 StartingIndex,
int32* IntersectingSegmentIndex,
FVector* AgentExtent
)

 Checks if given path, starting from StartingIndex, intersects with given AABB box.
Public function Virtual Const bool

DoesIntersectBox ( const FBox& Box,
uint32 StartingIndex,
int32* IntersectingSegmentIndex,
FVector* AgentExtent
)

 Checks if given path, starting from StartingIndex, intersects with given AABB box
Public function void  
Public function void

EnableRecalculationOnInvalidation ( bool bShouldAutoUpdate
)

 If enabled path will request recalculation if it gets invalidated due to a change to underlying navigation
Public function Const AActor *  
Public function Const FVector::FReal

GetCost ()

  
Public function Virtual Const FVector::FReal

GetCostFromIndex ( int32 PathPointIndex
)

 Get cost of path, starting from given point
Public function Virtual Const FVector::FReal

GetCostFromNode ( NavNodeRef PathNode
)

 Get cost of path, starting from given node
Public function Virtual Const FString  
Public function Const FVector  
Public function Const FVector  
Public function Const FSharedConstNavQueryFilter  
Public function Const const AActor *  
Public function Const const INavAgentInterface *  
Public function Const float  
Public function Const FVector If GoalActor is set it retrieved its navigation location, if not retrieved last path point location
Public function Const bool  
Public function Const FVector  
Public function Const double  
Public function Const FVector::FReal  
Public function Virtual Const FVector::FReal

GetLengthFromPosition ( FVector SegmentStart,
uint32 NextPathPointIndex
)

 Calculates total length of segments from NextPathPoint to the end of path, plus distance from CurrentPosition to NextPathPoint
Public function Const ANavigationData *  
Public function FPathObserverDelegate &  
Public function Const FVector Retrieved location to start path finding from (in case of path recalculation)
Public function Static bool

GetPathPoint ( const FNavigationPath* Path,
uint32 PathVertIdx,
FNavPathPoint& PathPoint
)

  
Public function Const FBasedPosition

GetPathPointLocation ( uint32 Index
)

 Get based position of path point
Public function TArray< FNavPathPoint > &  
Public function Const const TArray< FNavPathPoint > &  
Public function Const const UObject *  
Public function Const FPathFindingQueryData  
Public function Virtual Const FVector

GetSegmentDirection ( uint32 SegmentEndIndex
)

 Retrieves normalized direction vector to given path segment for '0'-th segment returns same as for 1st segment
Public function Const const AActor *  
Public function Const const INavAgentInterface *  
Public function Const FVector  
Public function Const double  
Public function void  
Public function Const bool  
Public function Const bool

IsReady ()

  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function Const bool  
Public function void  
Protected function Virtual void Optional notify called when path finishes update, before broadcasting to observes - requires bUseOnPathUpdatedNotify flag set
Public function void

RemoveObserver ( FDelegateHandle HandleOfObserverToRemove
)

  
Public function void  
Public function Virtual void Resets all variables describing generated path before attempting new pathfinding call.
Public function void

SetFilter ( FSharedConstNavQueryFilter InFilter
)

  
Public function void

SetGoalActorObservation ( const AActor& ActorToObserve,
float TetherDistance
)

 Enables path observing specified AActor's location and update itself if actor changes location
Public function void

SetGoalActorTetherDistance ( const float NewTetherDistace
)

 Modifies distance to the GoalActor at which we'll update the path
Public function 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!)
Public function void

SetIsPartial ( const bool bPartial
)

 FORCEINLINE void SetObserver(const FPathObserverDelegate& Observer) { ObserverDelegate = Observer; }.
Public function void

SetManualRepathWaiting ( const bool bInWaitingForRepath
)

  
Public function void

SetNavigationDataUsed ( const ANavigationData*const NewData
)

  
Public function void

SetQuerier ( const UObject* InQuerier
)

  
Public function void

SetQueryData ( const FPathFindingQueryData& QueryData
)

  
Public function void

SetSearchReachedLimit ( const bool bLimited
)

  
Public function void

SetSourceActor ( const AActor& InSourceActor
)

 Set's up the path to use SourceActor's location in case of recalculation
Public function void

SetTimeStamp ( double TimeStamp
)

  
Public function Const bool  
Public function Const bool  
Public function EPathObservationResult::Type  
Public function void  
Public function Const bool  

Operators

  Type Name Description
Public function FNavigationPath &

operator= ( const FNavigationPath& Other
)

  

Typedefs

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

Constants

Name Description
Type Type of path

Deprecated Functions

  Type Name Description
Public function Virtual Const bool

ContainsCustomLink ( uint32 UniqueLinkId
)

 Use version that takes FNavLinkId instead. This function only returns false.
Public function Virtual Const void

DebugDraw ( const ANavigationData* NavData,
const FColor PathColor,
UCanvas* Canvas,
const bool bPersistent,
const float LifeTime,
const uint32 NextPathPointIndex
)

 Use version that takes LifeTime instead.
Public function Virtual Const void

DebugDraw ( const ANavigationData* NavData,
FColor PathColor,
UCanvas* Canvas,
bool bPersistent,
const uint32 NextPathPointIndex
)

 Use version that takes LifeTime instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page