Choose your operating system:
Windows
macOS
Linux
| TSharedFromThis
|
Module |
|
Header |
/Engine/Source/Runtime/NavigationSystem/Public/NavigationData.h |
Include |
#include "NavigationData.h" |
struct FNavigationPath : public TSharedFromThis< FNavigationPath, ESPMode::ThreadSafe >
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 |
|
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 |
|
ObserverDelegate |
A delegate that will be called when path becomes invalid |
|
|
PathFindingQueryData |
Essential part of query used to generate this path |
|
|
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 |
|
|
PathType |
||
|
ShortcutNodeRefs |
Additional node refs used during path following shortcuts |
Name | Description | |
---|---|---|
|
FNavigationPath() |
|
|
FNavigationPath |
Name | Description | |
---|---|---|
|
~FNavigationPath() |
Name | Description | ||
---|---|---|---|
|
FDelegateHan... |
AddObserver ( |
|
|
PathClass &#... |
CastPath() |
|
|
const PathCl... |
CastPath() |
Type safe casts |
|
ContainsAnyCustomLink() |
Check if path contains any custom nav link |
|
|
ContainsCustomLink ( |
Check if path contains specific custom nav link |
|
|
ContainsNode ( |
Check if path contains given node |
|
|
DescribeSelfToVisLog ( |
||
|
DidSearchReachedLimit() |
||
|
DisableGoalActorObservation() |
Turns goal actor location's observation |
|
|
DoesIntersectBox |
Checks if given path, starting from StartingIndex, intersects with given AABB box. |
|
|
DoesIntersectBox |
Checks if given path, starting from StartingIndex, intersects with given AABB box |
|
|
DoneUpdating ( |
||
|
EnableRecalculationOnInvalidation ( |
If enabled path will request recalculation if it gets invalidated due to a change to underlying navigation |
|
|
AActor * |
GetBaseActor() |
|
|
float |
GetCost() |
|
|
float |
GetCostFromIndex ( |
Get cost of path, starting from given point |
|
float |
GetCostFromNode ( |
Get cost of path, starting from given node |
|
GetDescription() |
||
|
GetDestinationLocation() |
||
|
GetEndLocation() |
||
|
FSharedConst... |
GetFilter() |
|
|
const AActor... |
GetGoalActor() |
|
|
const INavAg... |
GetGoalActorAsNavAgent() |
|
|
float |
GetGoalActorTetherDistance() |
|
|
GetGoalLocation() |
If GoalActor is set it retrieved its navigation location, if not retrieved last path point location |
|
|
GetIgnoreInvalidation() |
||
|
GetLastRepathGoalLocation() |
||
|
float |
GetLastUpdateTime() |
|
|
float |
GetLength() |
|
|
float |
GetLengthFromPosition |
Calculates total length of segments from NextPathPoint to the end of path, plus distance from CurrentPosition to NextPathPoint |
|
ANavigationD... |
GetNavigationDataUsed() |
|
|
FPathObserve... |
GetObserver() |
|
|
GetPathFindingStartLocation() |
Retrieved location to start path finding from (in case of path recalculation) |
|
|
GetPathPoint ( |
||
|
FBasedPositi... |
GetPathPointLocation ( |
Get based position of path point |
|
GetPathPoints() |
||
|
const TArray... |
GetPathPoints() |
|
|
const UObjec... |
GetQuerier() |
|
|
FPathFinding... |
GetQueryData() |
|
|
GetSegmentDirection ( |
Retrieves normalized direction vector to given path segment for '0'-th segment returns same as for 1st segment |
|
|
const AActor... |
GetSourceActor() |
|
|
const INavAg... |
GetSourceActorAsNavAgent() |
|
|
GetStartLocation() |
||
|
float |
GetTimeStamp() |
|
|
Invalidate() |
||
|
IsPartial() |
||
|
IsReady() |
||
|
IsUpToDate() |
||
|
IsValid() |
||
|
IsWaitingForRepath() |
||
|
MarkReady() |
||
|
OnPathUpdated ( |
Optional notify called when path finishes update, before broadcasting to observes - requires bUseOnPathUpdatedNotify flag set |
|
|
RemoveObserver ( |
||
|
RePathFailed() |
||
|
ResetForRepath() |
Resets all variables describing generated path before attempting new pathfinding call. |
|
|
SetFilter ( |
||
|
SetGoalActorObservation ( |
Enables path observing specified AActor's location and update itself if actor changes location |
|
|
SetGoalActorTetherDistance ( |
Modifies distance to the GoalActor at which we'll update the path |
|
|
SetIgnoreInvalidation ( |
If ignoring, path will stay bUpToDate after being invalidated due to a change to underlying navigation (observer and auto repath will NOT be triggered!) |
|
|
SetIsPartial ( |
FORCEINLINE void SetObserver(const FPathObserverDelegate& Observer) { ObserverDelegate = Observer; }. |
|
|
SetManualRepathWaiting ( |
||
|
SetNavigationDataUsed ( |
||
|
SetQuerier ( |
||
|
SetQueryData ( |
||
|
SetSearchReachedLimit ( |
||
|
SetSourceActor ( |
Set's up the path to use SourceActor's location in case of recalculation |
|
|
SetTimeStamp ( |
||
|
ShouldUpdateEndPointOnRepath() |
||
|
ShouldUpdateStartPointOnRepath() |
||
|
EPathObserva... |
TickPathObservation() |
|
|
UpdateLastRepathGoalLocation() |
||
|
WillRecalculateOnInvalidation() |
Name |
Description |
---|---|
FPathObserverDelegate |
DECLARE_DELEGATE_OneParam(FPathObserverDelegate, FNavigationPath*);. |
Name |
Description |
---|---|
Type |
Type of path |
Name | Description | ||
---|---|---|---|
|
DebugDraw ( |
Use version that takes LifeTime instead. |
|
|
DebugDraw ( |
Use version that takes LifeTime instead. |