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

Light Theme

Dark Theme

ANavigationData

Represents abstract Navigation Data (sub-classed as NavMesh, NavGraph, etc) Used as a common interface for all navigation types handled by NavigationSystem

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

ANavigationData

	AAbstractNavData
	ANavigationGraph
	ARecastNavMesh

References

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

Syntax

class ANavigationData :
public AActor,
public INavigationDataInterface

Remarks

Represents abstract Navigation Data (sub-classed as NavMesh, NavGraph, etc) Used as a common interface for all navigation types handled by NavigationSystem

Variables

	Name	Description
TArray< FNavPat...	ActivePaths	Container for all path objects generated with this Navigation Data instance.
FCriticalSectio...	ActivePathsLock	Synchronization object for paths registration from main thread and async pathfinding thread
TMap< const UCl...	AreaClassToIdMap	Mapping for SupportedAreas
uint32: 1	bAutoDestroyWhenNoNavigation	Should this instance auto-destroy when there's no navigation system on world when it gets created/loaded
uint32: 1	bCanBeMainNavData	If set, navigation data can act as default one in navigation system's queries
uint32: 1	bCanSpawnOnRebuild	If set, navigation data will be spawned in persistent level during rebuild if actor doesn't exist
uint32: 1	bEnableDrawing	If set to true then this navigation data will be drawing itself when requested as part of "show navigation"
uint32: 1	bForceRebuildOnLoad	Game-time config
uint32: 1	bIsBuildingOnLoad
uint32: 1	bRebuildingSuspended	Set via SetRebuildingSuspended and controlling if RebuildDirtyAreas get passed over to the generator instantly or cached in SuspendedDirtyAreas to be applied at later date with SetRebuildingSuspended(false) call
uint32: 1	bRegistered	Whether this instance is registered with Navigation System
uint32: 1	bSupportsDefaultAgent	Was it generated for default agent (SupportedAgents[0])
uint32	DataVersion	Navigation data versioning.
FSharedNavQuery...	DefaultQueryFilter	Query filter used when no other has been passed to relevant functions
FFindPathPtr	FindHierarchicalPathImplementation
FFindPathPtr	FindPathImplementation
FNavDataConfig	NavDataConfig
TSharedPtr< FNa...	NavDataGenerator
float	NextObservedPathsTickInSeconds	Contains how much time left to the next ObservedPaths processing
TArray< FNavPat...	ObservedPaths	Contains paths that requested observing its goal's location.
float	ObservedPathsTickInterval	All observed paths will be processed every ObservedPathsTickInterval seconds
TMap< UClass &#...	QueryFilters	Map of query filters by UNavigationQueryFilter class
FNavRaycastPtr	RaycastImplementation
TObjectPtr< UPr...	RenderingComp
TArray< FNavPat...	RepathRequests	Paths that requested re-calculation
ERuntimeGenerat...	RuntimeGeneration	Navigation data runtime generation options
TArray< FSuppor...	SupportedAreas	Serialized area class - ID mapping
TArray< FNaviga...	SuspendedDirtyAreas	Caches requests to rebuild dirty areas while nav rebuilding is suspended via SetRebuildingSuspended(true) call.
FTestPathPtr	TestHierarchicalPathImplementation
FTestPathPtr	TestPathImplementation

Constructors

	Name	Description
	ANavigationData ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	BatchProjectPoints ( TArray< FNavigationProjectionWork >..., const FVector& Extent, FSharedConstNavQueryFilter Filter, const UObject* Querier )	Batches ProjectPoint's work for efficiency
void	BatchProjectPoints ( TArray< FNavigationProjectionWork >..., FSharedConstNavQueryFilter Filter, const UObject* Querier )	Project batch of points using shared search filter.
void	BatchRaycast ( TArray< FNavigationRaycastWork >& ..., FSharedConstNavQueryFilter QueryFil..., const UObject* Querier )	Raycasts batched for efficiency
void	BeginBatchQuery()	Batch processing (important with async rebuilding)
ENavigationQ...	CalcPathCost ( const FVector& PathStart, const FVector& PathEnd, float& OutPathCost, FSharedConstNavQueryFilter QueryFil..., const UObject* Querier )	Calculates path from PathStart to PathEnd and retrieves its cost.
ENavigationQ...	CalcPathLength ( const FVector& PathStart, const FVector& PathEnd, float& OutPathLength, FSharedConstNavQueryFilter QueryFil..., const UObject* Querier )	Calculates path from PathStart to PathEnd and retrieves its length.
ENavigationQ...	CalcPathLengthAndCost ( const FVector& PathStart, const FVector& PathEnd, float& OutPathLength, float& OutPathCost, FSharedConstNavQueryFilter QueryFil..., const UObject* Querier )	Calculates path from PathStart to PathEnd and retrieves its length.
bool	CanBeMainNavData()
void	CancelBuild()	Cancels current build
bool	CanSpawnOnRebuild()
void	CleanUp()
void	CleanUpAndMarkPendingKill()
void	ConditionalConstructGenerator()	Creates new generator in case navigation supports it
UPrimitiveCo...	ConstructRenderingComponent()	All the rest
FNavPathShar...	CreatePathInstance ( const FPathFindingQueryData& Query... )	Created an instance of navigation path of specified type.
bool	DoesNodeContainLocation ( NavNodeRef NodeRef, const FVector& WorldSpaceLocation )	Checks if specified navigation node contains given location
bool	DoesSupportAgent ( const FNavAgentProperties& AgentPr... )
void	EnsureBuildCompletion()	Blocks until navigation build is complete
void	FillConfig ( FNavDataConfig& Dest )
void	FillNavigationDataChunkActor ( const FBox& QueryBounds, ANavigationDataChunkActor& DataChu..., FBox& OutTilesBounds )
FPathFinding...	FindHierarchicalPath ( const FNavAgentProperties& AgentPr..., const FPathFindingQuery& Query )	Synchronously looks for a path from to for agent with properties .
FPathFinding...	FindPath ( const FNavAgentProperties& AgentPr..., const FPathFindingQuery& Query )	Synchronously looks for a path from to for agent with properties .
void	FinishBatchQuery()	Finishes batch processing and release locks
const UClass...	GetAreaClass ( int32 AreaID )	Get class associated with AreaID
int32	GetAreaID ( const UClass* AreaClass )	Get ID assigned to AreaClas or -1 when not assigned
FBox	GetBounds()	Returns bounding box for the navmesh.
const FNavDa...	GetConfig()	Generation & data access.
FVector	GetDefaultQueryExtent()
FSharedConst...	GetDefaultQueryFilter()	Querying.
const INavig...	GetDefaultQueryFilterImpl()
FNavDataGene...	GetGenerator()	Retrieves navigation data generator
const FNavDa...	GetGenerator()
int32	GetMaxSupportedAreas()	Get max areas supported by this navigation data
uint16	GetNavDataUniqueID()
TArray< FBox...	GetNavigableBounds()	Returns list of navigable bounds.
TArray< FBox...	GetNavigableBoundsInLevel ( ULevel* InLevel )	Returns list of navigable bounds that belongs to specific level
int32	GetNewAreaID ( const UClass* AreaClass )	Get ID to assign for newly added area
int32	GetNumSuspendedDirtyAreas()	Retrieves the number of suspended dirty areas
FSharedConst...	GetQueryFilter ( TSubclassOf< UNavigationQueryFilter... )	Filters.
FNavLocation	GetRandomPoint ( FSharedConstNavQueryFilter Filter, const UObject* Querier )
bool	GetRandomPointInNavigableRadius ( const FVector& Origin, float Radius, FNavLocation& OutResult, FSharedConstNavQueryFilter Filter, const UObject* Querier )	Finds a random location in navigable space, in given Radius
bool	GetRandomReachablePointInRadius ( const FVector& Origin, float Radius, FNavLocation& OutResult, FSharedConstNavQueryFilter Filter, const UObject* Querier )	Finds a random location in Radius, reachable from Origin
ERuntimeGene...	GetRuntimeGenerationMode()
void	GetSupportedAreas ( TArray< FSupportedAreaData >& Area... )	Read all supported areas
float	GetWorldTimeStamp()
void	InstantiateAndRegisterRenderingComponent()
bool	IsAreaAssigned ( int32 AreaID )	Check if AreaID was assigned to class (class itself may not be loaded yet!)
bool	IsBuildingOnLoad()
bool	IsDrawingEnabled()
bool	IsRebuildingSuspended()	Retrieves if this NavData instance's navigation generation is suspended
bool	IsRegistered()
bool	IsSupportingDefaultAgent()
uint32	LogMemUsed()
bool	NeedsRebuild()
bool	NeedsRebuildOnLoad()
void	OnNavAreaAdded ( const UClass* NavAreaClass, int32 AgentIndex )	Areas.
void	OnNavAreaChanged()	Called after changes to registered area classes
void	OnNavAreaEvent ( const UClass* NavAreaClass, ENavAreaEvent::Type Event )
void	OnNavAreaRemoved ( const UClass* NavAreaClass )	Area was removed from navigation system
void	OnNavigationBoundsChanged()
void	OnRegistered()
void	OnStreamingLevelAdded ( ULevel* InLevel, UWorld* InWorld )
void	OnStreamingLevelRemoved ( ULevel* InLevel, UWorld* InWorld )
void	OnStreamingNavDataAdded ( ANavigationDataChunkActor& InActor )
void	OnStreamingNavDataRemoved ( ANavigationDataChunkActor& InActor )
void	OnUnregistered()
void	ProcessNavAreas ( const TSet< const UClass* >& ..., int32 AgentIndex )	Add all existing areas
void	PurgeUnusedPaths()	Removes from ActivePaths all paths that no longer have shared references (and are invalid in fact)
bool	Raycast ( const FVector& RayStart, const FVector& RayEnd, FVector& HitLocation, FSharedConstNavQueryFilter QueryFil..., const UObject* Querier )	Synchronously makes a raycast on navigation data using QueryFilter
void	RebuildAll()	Triggers rebuild in case navigation supports it
void	RebuildDirtyAreas ( const TArray< FNavigationDirtyArea ... )	Request navigation data update after changes in nav octree
void	RegisterActivePath ( FNavPathSharedPtr SharedPath )
void	RegisterAsNavAreaClassObserver()	Releases navigation generator if any has been created register self with navigation system as new NavAreaDefinition(s) observer
void	RegisterObservedPath ( FNavPathSharedPtr SharedPath )
void	RemoveQueryFilter ( TSubclassOf< UNavigationQueryFilter... )	Removes cached query filter
void	RequestRegistration()
void	RequestRePath ( FNavPathSharedPtr Path, ENavPathUpdateType::Type Reason )
void	RestrictBuildingToActiveTiles ( bool InRestrictBuildingToActiveTile... )
void	SetConfig ( const FNavDataConfig& Src )
void	SetIsBuildingOnLoad ( bool bValue )
void	SetNavRenderingEnabled ( bool bEnable )	Updates state of rendering component
void	SetRebuildingSuspended ( const bool bNewSuspend )	Configures this NavData instance's navigation generation to be suspended or active.
void	SetSupportsDefaultAgent ( bool bIsDefault )
void	StoreQueryFilter ( TSubclassOf< UNavigationQueryFilter..., FSharedConstNavQueryFilter NavFilte... )	Store cached query filter
bool	SupportsRuntimeGeneration()
bool	SupportsStreaming()
bool	TestHierarchicalPath ( const FNavAgentProperties& AgentPr..., const FPathFindingQuery& Query, int32* NumVisitedNodes )	Synchronously checks if path between two points exists using hierarchical graph FNavAgentProperties will be found automatically
bool	TestPath ( const FNavAgentProperties& AgentPr..., const FPathFindingQuery& Query, int32* NumVisitedNodes )	Synchronously checks if path between two points exists FNavAgentProperties will be found automatically
void	TickAsyncBuild ( float DeltaSeconds )	Ticks navigation build If the generator is set to time sliced rebuild then this function will only get called when there is sufficient time (effectively roughly once in n frames where n is the number of time sliced nav data generators currently building)
void	UpdateCustomLink ( const INavLinkCustomInterface*... )	Custom navigation links.

Overridden from AActor

	Name	Description
void	ApplyWorldOffset ( const FVector& InOffset, bool bWorldShift )	Called by owning level to shift an actor location and all relevant data structures by specified delta
bool	CanChangeIsSpatiallyLoadedFlag()	Returns true if this actor allows changing the spatially loaded flag.
void	Destroyed()	Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending
void	EndPlay ( const EEndPlayReason::Type EndPlayR... )	Overridable function called whenever this actor is being removed from a level
void	PostInitializeComponents()	Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
void	RerunConstructionScripts()	Rerun construction scripts, destroying all autogenerated components; will attempt to preserve the root component location.
bool	SupportsExternalPackaging()	Does this actor supports external packaging?
void	TickActor ( float DeltaTime, enum ELevelTick TickType, FActorTickFunction& ThisTickFuncti... )	Dispatches the once-per frame Tick() function for this actor

Overridden from UObject

	Name	Description
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostInitProperties()	Life cycle.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Overridden from INavigationDataInterface

		Name	Description
	bool	FindMoveAlongSurface ( const FNavLocation& StartLocation, const FVector& TargetPosition, FNavLocation& OutLocation, FSharedConstNavQueryFilter Filter, const UObject* Querier )	Tries to move current nav location towards target constrained to navigable area.
	bool	ProjectPoint ( const FVector& Point, FNavLocation& OutLocation, const FVector& Extent, FSharedConstNavQueryFilter Filter, const UObject* Querier )	Tries to project given Point to this navigation type, within given Extent.

Typedefs

Name	Description
FFindPathPtr
FNavRaycastPtr
FTestPathPtr

Deprecated Variables

		Name	Description
	uint32: 1	bRebuildAtRuntime_DEPRECATED	If true, the NavMesh can be dynamically rebuilt at runtime.

Deprecated Functions

		Name	Description
	void	DrawDebugPath ( FNavigationPath* Path, const FColor PathColor, UCanvas* Canvas, const bool bPersistent, const uint32 NextPathPointIndex )	Use version that takes LifeTime instead.
	void	DrawDebugPath ( FNavigationPath* Path, const FColor PathColor, UCanvas* Canvas, const bool bPersistent, const float LifeTime, const uint32 NextPathPointIndex )	Use version that takes LifeTime instead.