1. Epic GamesDeveloper
  3. FMetaNavMeshPath

FMetaNavMeshPath

[FMetaNavMeshPath](API\Runtime\AIModule\Navigation\FMetaNavMeshPath) allows creating hierarchical or guided navmesh paths

API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/Navigation

Inheritance Hierarchy

References

   
Module AIModule
Header /Engine/Source/Runtime/AIModule/Classes/Navigation/MetaNavMeshPath.h
Include #include "Navigation/MetaNavMeshPath.h"

Syntax

struct FMetaNavMeshPath : public FNavMeshPath

Remarks

FMetaNavMeshPath allows creating hierarchical or guided navmesh paths

Waypoints array defines list of locations that will be used to create actual FNavMeshPath data during path following. On path following start and upon reaching waypoint, path will request update from owning navmesh with following parameters:

  • start location set to agent location
  • end location set to target waypoint (or goal actor for last one)
  • goal actor set only for last section

Since path updates itself for moving agent it really shouldn't be reused by others.

Variables

  Type Name Description
Protected variable FVector::FReal ApproximateLength Sum of 3D distance along waypoints, used for approximating length of path
Protected variable TWeakObjectPtr< AActor > PathGoal Stored goal actor
Protected variable float PathGoalTetherDistance Stored goal actor's tether distance
Protected variable int32 TargetWaypointIdx Current target of path following
Protected variable TArray< FMetaPathWayPoint > Waypoints List of waypoints, including start and end of path
Protected variable float WaypointSwitchRadius Update navmesh path when this close to target waypoint

Constructors

  Type Name Description
Public function    
Public function  

FMetaNavMeshPath ( const TArray< FMetaPathWayPoint >& InWaypoints,
const ANavigationData& NavData
)

  
Public function  

FMetaNavMeshPath ( const TArray< FMetaPathWayPoint >& InWaypoints,
const AController& Owner
)

  
Public function  

FMetaNavMeshPath ( const TArray< FVector >& InWaypoints,
const ANavigationData& NavData
)

  
Public function  

FMetaNavMeshPath ( const TArray< FVector >& InWaypoints,
const AController& Owner
)

  

Functions

  Type Name Description
Public function Virtual bool

ConditionalMoveToNextSection ( const FVector& AgentLocation,
EMetaPathUpdateReason Reason
)

 Try switching to next waypoint, depends on WaypointSwitchRadius
Public function Virtual void

CopyFrom ( const FMetaNavMeshPath& Other
)

 Copy properties of other meta path
Public function bool

ForceMoveToNextSection ( const FVector& AgentLocation
)

 Force switching to next waypoint
Public function Const AActor * Returns cached path goal
Public function Const int32 Returns number of waypoints
Public function Const int32 Returns index of current target waypoint
Public function Const const TArray< FMetaPathWayPoint > & Returns waypoint array
Public function Const float Returns radius for switching to next waypoint during path following
Public function Virtual void

Initialize ( const FVector& AgentLocation
)

 Initialize path for path following
Public function Const bool Returns true if path at last waypoint
Protected function bool

MoveToNextSection ( const FVector& AgentLocation
)

 Switch to next waypoint
Public function bool

SetWaypoints ( const TArray< FMetaPathWayPoint >& InWaypoints
)

 Tries to set waypoints, fails when path is ready being followed
Public function bool

SetWaypoints ( const TArray< FVector >& InWaypoints
)

 Tries to set waypoints, fails when path is ready being followed
Public function void

SetWaypointSwitchRadius ( float InSwitchRadius
)

 Sets radius for switching to next waypoint during path following
Public function Virtual bool

UpdatePath ( const FVector& AgentLocation
)

 Updates underlying navmesh path for current target waypoint

Overridden from FNavigationPath

  Type Name Description
Public function Virtual Const void

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

  
Public function Virtual Const void  
Public function Virtual Const FVector::FReal

GetCostFromIndex ( int32 PathPointIndex
)

 Returns approximate cost of path, ignores parameter
Public function Virtual Const FVector::FReal

GetLengthFromPosition ( FVector SegmentStart,
uint32 NextPathPointIndex
)

 Returns approximate length of path, ignores parameters

Typedefs

Name Description
Super  

Constants

Name Description
Type  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page