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 > AIModule > Navigation > FMetaNavMeshPath

Light Theme

Dark Theme

FMetaNavMeshPath

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

FNavigationPath

FNavMeshPath

FMetaNavMeshPath

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

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

Constructors

	Name	Description
	FMetaNavMeshPath()
	FMetaNavMeshPath ( const TArray< FMetaPathWayPoint >&..., const ANavigationData& NavData )
	FMetaNavMeshPath ( const TArray< FMetaPathWayPoint >&..., const AController& Owner )
	FMetaNavMeshPath ( const TArray< FVector >& InWaypoin..., const ANavigationData& NavData )
	FMetaNavMeshPath ( const TArray< FVector >& InWaypoin..., const AController& Owner )

Functions

	Name	Description
bool	ConditionalMoveToNextSection ( const FVector& AgentLocation, EMetaPathUpdateReason Reason )	Try switching to next waypoint, depends on WaypointSwitchRadius
void	CopyFrom ( const FMetaNavMeshPath& Other )	Copy properties of other meta path
bool	ForceMoveToNextSection ( const FVector& AgentLocation )	Force switching to next waypoint
AActor *	GetMetaPathGoal()	Returns cached path goal
int32	GetNumWaypoints()	Returns number of waypoints
int32	GetTargetWaypointIndex()	Returns index of current target waypoint
const TArray...	GetWaypointArray()	Returns waypoint array
float	GetWaypointSwitchRadius()	Returns radius for switching to next waypoint during path following
void	Initialize ( const FVector& AgentLocation )	Initialize path for path following
bool	IsLastSection()	Returns true if path at last waypoint
bool	MoveToNextSection ( const FVector& AgentLocation )	Switch to next waypoint
bool	SetWaypoints ( const TArray< FMetaPathWayPoint >&... )	Tries to set waypoints, fails when path is ready being followed
bool	SetWaypoints ( const TArray< FVector >& InWaypoin... )	Tries to set waypoints, fails when path is ready being followed
void	SetWaypointSwitchRadius ( float InSwitchRadius )	Sets radius for switching to next waypoint during path following
bool	UpdatePath ( const FVector& AgentLocation )	Updates underlying navmesh path for current target waypoint

Overridden from FNavigationPath

	Name	Description
void	DebugDraw ( const ANavigationData* NavData, const FColor PathColor, UCanvas* Canvas, const bool bPersistent, const float LifeTime, const uint32 NextPathPointIndex )
void	DescribeSelfToVisLog ( FVisualLogEntry* Snapshot )
float	GetCostFromIndex ( int32 PathPointIndex )	Returns approximate length of path, ignores parameter
float	GetLengthFromPosition ( FVector SegmentStart, uint32 NextPathPointIndex )	Returns approximate length of path, ignores parameters

Typedefs

Name	Description
Super

Constants

Name	Description
Type

Deprecated Functions

		Name	Description
	TArray< FVec...	GetWaypoints()	Waypoint type of MetaPaths has been changed. Use the new GetWaypointArray