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

Light Theme

Dark Theme

UNavigationSystemV1

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNavigationSystemBase

UNavigationSystemV1

References

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

Syntax

class UNavigationSystemV1 : public UNavigationSystemBase

Variables

	Name	Description
ANavigationData...	AbstractNavData	Special navigation data for managing direct paths, not part of NavDataSet!
float	ActiveTilesUpdateInterval	Minimal time, in seconds, between active tiles set update
TMap< FNavAgent...	AgentToNavDataMap
TArray< FAsyncP...	AsyncPathFindingCompletedQueries	Queued async pathfinding results computed by the dedicated task in the last frame and ready to dispatch in the next update.
TArray< FAsyncP...	AsyncPathFindingQueries	Queued async pathfinding queries to process in the next update.
FGraphEventRef	AsyncPathFindingTask	Graph event that the main thread will wait for to synchronize with the async pathfinding task, if any.
TAtomic< bool >	bAbortAsyncQueriesRequested	Flag used by main thread to ask the async pathfinding task to stop and postpone remaining queries, if any.
uint32: 1	bAllowClientSideNavigation	If false, will not create nav collision when connecting as a client
uint8: 1	bAsyncBuildPaused
uint32: 1	bAutoCreateNavigationData	Should navigation system spawn default Navigation Data when there's none and there are navigation bounds present?
uint8: 1	bCleanUpDone	Set when the NavSys instance has been cleaned up. This is an irreversible state
uint32: 1	bGenerateNavigationOnlyAroundNavigationInvokers	If set to true navigation will be generated only around registered "navigation enforcers" This has a range of consequences (including how navigation octree operates) so it needs to be a conscious decision.
uint32: 1	bInitialBuildingLocked	If set to true will result navigation system not rebuild navigation until a call to ReleaseInitialBuildingLock() is called.
uint8: 1	bInitialLevelsAdded
uint8: 1	bInitialSetupHasBeenPerformed
uint32: 1	bShouldDiscardSubLevelNavData	If true, games should ignore navigation data inside loaded sublevels
uint32: 1	bSkipAgentHeightCheckWhenPickingNavData	False by default, if set to true will result in not caring about nav agent height when trying to match navigation data to passed in nav agent
uint32: 1	bSpawnNavDataInNavBoundsLevel	If true will try to spawn the navigation data instance in the sublevel with navigation bounds, if false it will spawn in the persistent level
uint32: 1	bSupportRebuilding	Gets set to true if gathering navigation data (like in navoctree) is required due to the need of navigation generation Is always true in Editor Mode.
uint32: 1	bTickWhilePaused	If true, will update navigation even when the game is paused
uint32: 1	bWholeWorldNavigable	If set to true (default) navigation will be generated only within special navigation bounds volumes (like ANavMeshBoundsVolume).
uint8: 1	bWorldInitDone
TSoftClassPtr< ...	CrowdManagerClass
int32	CurrentlyDrawnNavDataIndex	Indicates which of multiple navigation data instances to draw
TMap< uint32, F...	CustomLinksMap	Map of all custom navigation links, that are relevant for path following
ENavDataGatheri...	DataGatheringMode	Sets how navigation data should be gathered when building collision information
FName	DefaultAgentName	If not None indicates which of navigation datas and supported agents are going to be used as the default ones.
FNavigationDirt...	DefaultDirtyAreasController
FNavigationOctr...	DefaultOctreeController
float	DirtyAreaWarningSizeThreshold	-1 by default, if set to a positive value dirty areas with any dimensions in 2d over the threshold created at runtime will be logged
FDelegateHandle	HotReloadDelegateHandle
uint8	InitialNavBuildingLockFlags	Set of locking flags applied on startup of navigation system
ANavigationData...	MainNavData
TSet< const UCl...	NavAreaClasses
uint8	NavBuildingLockFlags
FCriticalSectio...	NavDataRegistration
TArray< ANaviga...	NavDataRegistrationQueue
FCriticalSectio...	NavDataRegistrationSection	Async queries
TArray< ANaviga...	NavDataSet
FBox	NavigableWorldBounds	Cached navigable world bounding box
FNavRegenTimeSl...	NavRegenTimeSliceManager
uint8	NavUpdateLockFlags
FOnNavDataGener...	OnNavDataRegisteredEvent
FOnNavDataGener...	OnNavigationGenerationFinishedDelegate
FOnNavigationIn...	OnNavigationInitDone
FNavigationSyst...	OperationMode
TArray< FNaviga...	PendingNavBoundsUpdates	List of pending navigation bounds update requests (add, remove, update size)
TSet< FNavigati...	RegisteredNavBounds	All areas where we build/have navigation
TArray< FNavDat...	SupportedAgents	List of agents types supported by this navigation system
FNavAgentSelect...	SupportedAgentsMask	NavigationSystem's properties in Project Settings define all possible supported agents, but a specific navigation system can choose to support only a subset of agents.

Constructors

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

Destructors

	Name	Description
	~UNavigationSystemV1()

Functions

	Name	Description
void	AbortAsyncFindPathRequest ( uint32 AsynPathQueryID )	Removes query indicated by given ID from queue of path finding requests to process.
void	AddAsyncQuery ( const FAsyncPathFindingQuery& Quer... )	Adds given request to requests queue. it's to be called only on game thread only
void	AddDirtyArea ( const FBox& NewArea, int32 Flags )
void	AddDirtyAreas ( const TArray< FBox >& NewAreas, int32 Flags )
void	AddElementToNavOctree ( const FNavigationDirtyElement& Dir... )	Adds given element to NavOctree.
void	AddLevelCollisionToOctree ( ULevel* Level )	Add BSP collision data to navigation octree
void	AddLevelToOctree ( ULevel& Level )	Called during ConditionalPopulateNavOctree and gives subclassess a chance to influence what gets added
void	AddNavigationBounds ( const FNavigationBounds& NewBounds )	Adds data to RegisteredNavBounds
void	AddNavigationBoundsUpdateRequest ( const FNavigationBoundsUpdateReques... )	Adds navigation bounds update request to a pending list
void	AddNavigationBuildLock ( uint8 Flags )
void	AddNavigationUpdateLock ( uint8 Flags )
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	ApplySupportedAgentsFilter()
void	Build()	Building
void	CalcTimeSlicedUpdateData ( TArray< double >& OutCurrentTimeSl..., TArray< bool >& OutIsTimeSlicingAr..., bool& bOutAnyNonTimeSlicedGenerato..., int32& OutNumTimeSlicedRemainingBu... )
void	CancelBuild()	Cancels all currently running navigation builds
bool	CanRebuildDirtyNavigation()	Checks if dirty navigation data can rebuild itself
void	ClearNavOctreeAll ( AActor* Actor )	Removes all navoctree entries for actor and its components
bool	ConditionalPopulateNavOctree()	Called in places where we need to spawn the NavOctree, but is checking additional conditions if we really want to do that depending on navigation data setup among others
void	ConfigureAsStatic ( bool bEnableStatic )	Call with bEnableStatic == true to signal the NavigationSystem it doesn't need to store any navigation-generation-related data at game runtime, because nothing is going to use it anyway.
void	ConstructNavOctree()	Called to instantiate NavigationSystem's NavOctree instance
void	CreateCrowdManager()	Spawn new crowd manager
FSharedNavQu...	CreateDefaultQueryFilterCopy()
ANavigationD...	CreateNavigationDataInstanceInLevel ( const FNavDataConfig& NavConfig, ULevel* SpawnLevel )	Constructs a navigation data instance of specified NavDataClass, in passed Level for supplied NavConfig.
UNavigationS...	CreateNavigationSystem ( UWorld* WorldOwner )
void	CycleNavigationDataDrawn()	Debug
void	DemandLazyDataGathering ( FNavigationRelevantData& ElementDa... )
void	DescribeFilterFlags ( const TArray< FString >& FlagsDesc )	Prepare descriptions of navigation flags in UNavigationQueryFilter class: using array
void	DescribeFilterFlags ( UEnum* FlagsEnum )	Filters.
void	DestroyNavOctree()
void	DispatchAsyncQueriesResults ( const TArray< FAsyncPathFindingQuer... )	Broadcasts completion delegate for all completed async pathfinding requests.
bool	DoesPathIntersectBox ( const FNavigationPath* Path, const FBox& Box, const FVector& AgentLocation, uint32 StartingIndex, FVector* AgentExtent )
bool	DoesPathIntersectBox ( const FNavigationPath* Path, const FBox& Box, uint32 StartingIndex, FVector* AgentExtent )
void	DoInitialSetup()	Sets up SuportedAgents and NavigationDataCreators.
uint8	FillInstantiatedDataMask ( TBitArray<>& OutInstantiatedMask, ULevel* InLevel )	Fills a mask indicating which navigation data associated to the supported agent mask are already instantiated.
void	FindElementsInNavOctree ( const FBox& QueryBox, const FNavigationOctreeFilter& Fil..., TArray< FNavigationOctreeElement > ... )	Find all elements in navigation octree within given box (intersection)
uint32	FindPathAsync ( const FNavAgentProperties& AgentPr..., FPathFindingQuery Query, const FNavPathQueryDelegate& Resul..., EPathFindingMode::Type Mode )	Asynchronously looks for a path from to for agent with properties .
FPathFinding...	FindPathSync ( FPathFindingQuery Query, EPathFindingMode::Type Mode )	Does a simple path finding from to on specified NavData.
FPathFinding...	FindPathSync ( const FNavAgentProperties& AgentPr..., FPathFindingQuery Query, EPathFindingMode::Type Mode )	Synchronously looks for a path from to for agent with properties .
UNavigationP...	FindPathToActorSynchronously ( UObject* WorldContextObject, const FVector& PathStart, AActor* GoalActor, float TetherDistance, AActor* PathfindingContext, TSubclassOf< UNavigationQueryFilter... )	Finds path instantly, in a FindPath Synchronously.
UNavigationP...	FindPathToLocationSynchronously ( UObject* WorldContextObject, const FVector& PathStart, const FVector& PathEnd, AActor* PathfindingContext, TSubclassOf< UNavigationQueryFilter... )	Finds path instantly, in a FindPath Synchronously.
void	GatherNavigationBounds()	Searches for all valid navigation bounds in the world and stores them
ANavigationD...	GetAbstractNavData()
int32	GetAllAttachedActors ( const AActor& RootActor, TArray< AActor* >& OutAttache... )	A helper function that gathers all actors attached to RootActor and fetches them back.
UCrowdManage...	GetCrowdManager()
UNavigationS...	GetCurrent ( UObject* WorldContextObject )
UNavigationS...	GetCurrent ( UWorld* World )
INavLinkCust...	GetCustomLink ( uint32 UniqueLinkId )	Find custom link by unique ID
const FNavig...	GetDataForObject ( const UObject& Object )
ANavigationD...	GetDefaultNavDataInstance ( FNavigationSystem::ECreateIfMissing... )	Returns the world default navigation data instance. Creates one if it doesn't exist.
ANavigationD...	GetDefaultNavDataInstance()
const FNavDa...	GetDefaultSupportedAgent()
const FNavDa...	GetDefaultSupportedAgentConfig()
const TArray...	GetInvokerLocations()
bool	GetIsAutoUpdateEnabled()	Checks if auto-rebuilding navigation data is enabled.
FBox	GetLevelBounds ( ULevel* InLevel )
ANavigationD...	GetMainNavDataChecked()
FNavigationR...	GetMutableDataForObject ( const UObject& Object )
FNavigationO...	GetMutableNavOctree()
FNavRegenTim...	GetMutableNavRegenTimeSliceManager()
void	GetNavAgentPropertiesArray ( TArray< FNavAgentProperties >& Out... )	Fetch the array of all nav-agent properties.
INavigationD...	GetNavDataForActor ( const AActor& Actor )
ANavigationD...	GetNavDataForAgentName ( const FName AgentName )	Goes through all registered NavigationData instances and retrieves the one supporting agent named AgentName
ANavigationD...	GetNavDataForProps ( const FNavAgentProperties& AgentPr..., const FVector& AgentLocation, const FVector& Extent )	Looks up NavData appropriate for specified movement properties and returns it.
ANavigationD...	GetNavDataForProps ( const FNavAgentProperties& AgentPr... )	Looks for NavData generated for specified movement properties and returns it. NULL if not found;
const ANavig...	GetNavDataForProps ( const FNavAgentProperties& AgentPr... )	Looks for NavData generated for specified movement properties and returns it.
ANavigationD...	GetNavDataWithID ( const uint16 NavDataID )	It looks only through registered navigation data
const TSet< ...	GetNavigationBounds()
int	GetNavigationBoundsForNavData ( const ANavigationData& NavData, TArray< FBox >& OutBounds, ULevel* InLevel )
UNavigationS...	GetNavigationSystem ( UObject* WorldContextObject )	Blueprint functions.
const FNavig...	GetNavOctree()
bool	GetNavOctreeElementData ( const UObject& NodeOwner, int32& DirtyFlags, FBox& DirtyBounds )	Read element data from navigation octree
int32	GetNumDirtyAreas()
int32	GetNumRemainingBuildTasks()	Used to display "navigation building in progress" counter
int32	GetNumRunningBuildTasks()	Number of currently running tasks
const FOctre...	GetObjectsNavOctreeId ( const UObject& Object )
void	GetOnScreenMessages ( TMultiMap< FCoreDelegates::EOnScree... )
ENavigationQ...	GetPathCost ( UObject* WorldContextObject, const FVector& PathStart, const FVector& PathEnd, float& PathCost, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter... )	Potentially expensive.
ENavigationQ...	GetPathCost ( const FVector& PathStart, const FVector& PathEnd, float& PathCost, const ANavigationData* NavData, FSharedConstNavQueryFilter QueryFil... )	Calculates a path from PathStart to PathEnd and retrieves its cost.
ENavigationQ...	GetPathLength ( UObject* WorldContextObject, const FVector& PathStart, const FVector& PathEnd, float& PathLength, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter... )	Potentially expensive. Use with caution
ENavigationQ...	GetPathLength ( const FVector& PathStart, const FVector& PathEnd, float& PathLength, const ANavigationData* NavData, FSharedConstNavQueryFilter QueryFil... )	Calculates a path from PathStart to PathEnd and retrieves its overestimated length.
ENavigationQ...	GetPathLengthAndCost ( const FVector& PathStart, const FVector& PathEnd, float& PathLength, float& PathCost, const ANavigationData* NavData, FSharedConstNavQueryFilter QueryFil... )	Calculates a path from PathStart to PathEnd and retrieves its overestimated length and cost.
bool	GetRandomPoint ( FNavLocation& ResultLocation, ANavigationData* NavData, FSharedConstNavQueryFilter QueryFil... )	Finds random point in navigable space
bool	GetRandomPointInNavigableRadius ( const FVector& Origin, float Radius, FNavLocation& ResultLocation, ANavigationData* NavData, FSharedConstNavQueryFilter QueryFil... )	Finds random, point in navigable space restricted to Radius around Origin.
bool	GetRandomReachablePointInRadius ( const FVector& Origin, float Radius, FNavLocation& ResultLocation, ANavigationData* NavData, FSharedConstNavQueryFilter QueryFil... )	Finds random, reachable point in navigable space restricted to Radius around Origin
FNavigationS...	GetRunMode()
ERuntimeGene...	GetRuntimeGenerationType()	Return "Strongest" runtime generation type required by registered navigation data objects Depends on runtime generation settings of each navigation data, always ERuntimeGenerationType::Dynamic in the editor world
int32	GetSupportedAgentIndex ( const ANavigationData* NavData )	Find index in SupportedAgents array for given navigation data
int32	GetSupportedAgentIndex ( const FNavAgentProperties& NavAgen... )	Find index in SupportedAgents array for agent type
const TArray...	GetSupportedAgents()
FNavAgentSel...	GetSupportedAgentsMask()
UWorld *	GetWorld()
FBox	GetWorldBounds()
bool	HandleCountNavMemCommand()
bool	HandleCycleNavDrawnCommand ( const TCHAR* Cmd, FOutputDevice& Ar )	Exec command handlers
bool	HasDirtyAreasQueued()
uint32	HashObject ( const UObject& Object )
bool	HasPendingObjectNavOctreeId ( UObject* Object )
void	InitializeLevelCollisions()	Adds BSP collisions of currently streamed in levels to octree
bool	IsActiveTilesGenerationEnabled()
bool	IsInitialized()
bool	IsNavigationBeingBuilt ( UObject* WorldContextObject )
bool	IsNavigationBeingBuiltOrLocked ( UObject* WorldContextObject )
bool	IsNavigationBuildingLocked ( uint8 Flags )
bool	IsNavigationBuildingPermanentlyLocked()	Check if building is permanently locked to avoid showing navmesh building notify (due to queued dirty areas)
bool	IsNavigationBuildInProgress()	Determines whether any generator is performing navigation building actions at the moment, dirty areas are also checked
bool	IsNavigationDirty()	Checks if navigation/navmesh is dirty and needs to be rebuilt
bool	IsNavigationOctreeLocked()	Check if navigation octree updates are currently ignored
bool	IsNavigationRegisterLocked()
bool	IsNavigationRelevant ( const AActor* TestActor )
bool	IsNavigationSystemStatic()
bool	IsNavigationUnregisterLocked()
bool	IsNavigationUpdateLocked()
bool	IsSetUpForLazyGeometryExporting()
bool	IsThereAnywhereToBuildNavigation()
bool	K2_GetRandomLocationInNavigableRadius ( UObject* WorldContextObject, const FVector& Origin, FVector& RandomLocation, float Radius, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter... )	Generates a random location in navigable space within given radius of Origin.
bool	K2_GetRandomReachablePointInRadius ( UObject* WorldContextObject, const FVector& Origin, FVector& RandomLocation, float Radius, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter... )	Generates a random location reachable from given Origin location.
bool	K2_ProjectPointToNavigation ( UObject* WorldContextObject, const FVector& Point, FVector& ProjectedLocation, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter..., const FVector QueryExtent )	Project a point onto the NavigationData
bool	K2_ReplaceAreaInOctreeData ( const UObject* Object, TSubclassOf< UNavArea > OldArea, TSubclassOf< UNavArea > NewArea )
void	LogNavDataRegistrationResult ( ERegistrationResult )
bool	NavigationRaycast ( UObject* WorldContextObject, const FVector& RayStart, const FVector& RayEnd, FVector& HitLocation, TSubclassOf< UNavigationQueryFilter..., AController* Querier )	Performs navigation raycast on NavigationData appropriate for given Querier.
void	OnActorMoved ( AActor* Actor )	Delegate handler for ActorMoved events
void	OnActorRegistered ( AActor* Actor )
void	OnActorUnregistered ( AActor* Actor )
void	OnBeginTearingDown ( UWorld* World )	Called as part of UWorld::BeginTearingDown
void	OnComponentRegistered ( UActorComponent* Comp )	Navigation octree related functions
void	OnComponentUnregistered ( UActorComponent* Comp )
void	OnHotReload ( bool bWasTriggeredAutomatically )	Called to notify NavigaitonSystem about finished hot reload
void	OnLevelAddedToWorld ( ULevel* InLevel, UWorld* InWorld )	Handler for FWorldDelegates::LevelAddedToWorld event
void	OnLevelRemovedFromWorld ( ULevel* InLevel, UWorld* InWorld )	Handler for FWorldDelegates::LevelRemovedFromWorld event
void	OnNavigationAreaEvent ( UClass* AreaClass, ENavAreaEvent::Type Event )
void	OnNavigationBoundsAdded ( ANavMeshBoundsVolume* NavVolum... )
void	OnNavigationBoundsRemoved ( ANavMeshBoundsVolume* NavVolum... )
void	OnNavigationBoundsUpdated ( ANavMeshBoundsVolume* NavVolum... )
void	OnNavigationDirtied ( const FBox& Bounds )	Delegate handler called when navigation is dirtied
void	OnNavigationGenerationFinished ( ANavigationData& NavData )
void	OnPIEEnd()
void	OnPIEStart()
void	OnPostLoadMap ( UWorld* LoadedWorld )	Delegate handler for PostLoadMap event
void	OnWorldInitDone ( FNavigationSystemRunMode Mode )
void	OnWorldPostActorTick ( UWorld* World, ELevelTick TickType, float DeltaTime )	Handler for FWorldDelegates::OnWorldPostActorTick event
void	OverrideSupportedAgents ( const TArray< FNavDataConfig >& Ne... )
void	PerformAsyncQueries ( TArray< FAsyncPathFindingQuery > Pa... )	Processes pathfinding requests given in PathFindingQueries.
void	PerformNavigationBoundsUpdate ( const TArray< FNavigationBoundsUpda... )	Used to apply updates of nav volumes in navigation system's tick
void	PostponeAsyncQueries()	Requests the async pathfinding task to abort and waits for it to complete before resuming the main thread.
void	ProcessCustomLinkPendingRegistration()	Registers CustomLinks awaiting registration in PendingCustomLinkRegistration
void	ProcessRegistrationCandidates()	Processes registration of candidates queues via RequestRegistration and stored in NavDataRegistrationQueue
bool	ProjectPointToNavigation ( const FVector& Point, FNavLocation& OutLocation, const FVector& Extent, const FNavAgentProperties* Age..., FSharedConstNavQueryFilter QueryFil... )
bool	ProjectPointToNavigation ( const FVector& Point, FNavLocation& OutLocation, const FVector& Extent, const ANavigationData* NavData, FSharedConstNavQueryFilter QueryFil... )
void	RebuildAll ( bool bIsLoadTime )	Triggers navigation building on all eligible navigation data.
void	RebuildDirtyAreas ( float DeltaSeconds )
void	RegisterCustomLink ( INavLinkCustomInterface& CustomLin... )	Custom navigation links.
void	RegisterInvoker ( AActor& Invoker, float TileGenerationRadius, float TileRemovalRadius )	Active tiles.
void	RegisterNavAreaClass ( UClass* NavAreaClass )	Tries to register navigation area
ERegistratio...	RegisterNavData ( ANavigationData* NavData )	Registers given navigation data with this Navigation System.
void	RegisterNavigationDataInstances()	Processes all NavigationData instances in UWorld owning navigation system instance, and registers all previously unregistered
void	RegisterNavigationInvoker ( AActor& Invoker, float TileGenerationRadius, float TileRemovalRadius )
void	RegisterNavigationInvoker ( AActor* Invoker, float TileGenerationRadius, float TileRemovalRadius )	Registers given actor as a "navigation enforcer" which means navigation system will make sure navigation is being generated in specified radius around it.
FSetElementI...	RegisterNavOctreeElement ( UObject* ElementOwner, INavRelevantInterface* Element..., int32 UpdateFlags )
void	ReleaseInitialBuildingLock()
void	RemoveLevelCollisionFromOctree ( ULevel* Level )	Remove BSP collision data from navigation octree
void	RemoveNavigationBuildLock ( uint8 Flags, const ELockRemovalRebuildAction Reb... )
void	RemoveNavigationUpdateLock ( uint8 Flags )
void	RemoveNavOctreeElementId ( const FOctreeElementId2& ElementId, int32 UpdateFlags )
void	RemoveObjectsNavOctreeId ( const UObject& Object )
bool	ReplaceAreaInOctreeData ( const UObject& Object, TSubclassOf< UNavArea > OldArea, TSubclassOf< UNavArea > NewArea, bool bReplaceChildClasses )	Fetched Object's data from the octree and replaces occurences of OldArea with NewArea
void	RequestAreaRegistering ( UClass* NavAreaClass )	Areas.
void	RequestAreaUnregistering ( UClass* NavAreaClass )
void	RequestCustomLinkRegistering ( INavLinkCustomInterface& CustomLin..., UObject* OwnerOb )
void	RequestCustomLinkUnregistering ( INavLinkCustomInterface& CustomLin..., UObject* ObjectOb )
void	RequestRegistrationDeferred ( ANavigationData& NavData )	Adds NavData to registration candidates queue - NavDataRegistrationQueue
bool	RequiresNavOctree()	Whether Navigation system needs to populate nav octree.
void	ResetCachedFilter ( TSubclassOf< UNavigationQueryFilter... )	Removes cached filters from currently registered navigation data
void	ResetMaxSimultaneousTileGenerationJobsCount()	Brings limit of simultaneous navmesh tile generation jobs back to Project Setting's default value
void	SetCrowdManager ( UCrowdManagerBase* NewCrowdMan... )
void	SetGeometryGatheringMode ( ENavDataGatheringModeConfig NewMode )
void	SetMaxSimultaneousTileGenerationJobsCount ( int32 MaxNumberOfJobs )	Will limit the number of simultaneously running navmesh tile generation jobs to specified number.
void	SetNavigationAutoUpdateEnabled ( bool bNewEnable, UNavigationSystemBase* InNavig... )	Allow editor to toggle whether seamless navigation building is enabled
void	SetNavigationOctreeLock ( bool bLock )
void	SetSupportedAgentsMask ( const FNavAgentSelector& InSupport... )
void	SetSupportedAgentsNavigationClass ( int32 AgentIndex, TSubclassOf< ANavigationData > Navi... )	Used to properly set navigation class for indicated agent and propagate information to other places (like project settings) that may need this information
void	SetUpdateNavOctreeOnComponentChange ( bool bNewUpdateOnComponentChange )
bool	ShouldAllowClientSideNavigation()
bool	ShouldDiscardSubLevelNavData ( ANavigationData* NavData )
bool	ShouldGenerateNavigationEverywhere()
bool	ShouldGeneratorRun ( const FNavDataGenerator* Gener... )	Super-hacky safety feature for threaded navmesh building.
bool	ShouldLoadNavigationOnClient ( ANavigationData* NavData )
bool	ShouldUpdateNavOctreeOnComponentChange()
void	SpawnMissingNavigationData()
void	SpawnMissingNavigationDataInLevel ( const TBitArray<>& InInstantiatedM..., ULevel* InLevel )	Spawns missing navigation data.
bool	SupportsNavigationGeneration()
bool	TestPathSync ( FPathFindingQuery Query, EPathFindingMode::Type Mode, int32* NumVisitedNodes )	Synchronously check if path between two points exists Does not return path object, but will run faster (especially in hierarchical mode)
void	TriggerAsyncQueries ( TArray< FAsyncPathFindingQuery >& ... )	Spawns a non-game-thread task to process requests given in PathFindingQueries.
void	UnregisterCustomLink ( INavLinkCustomInterface& CustomLin... )
void	UnregisterInvoker ( AActor& Invoker )
void	UnregisterNavAreaClass ( UClass* NavAreaClass )	Tries to unregister navigation area
void	UnregisterNavData ( ANavigationData* NavData )	Bookkeeping.
void	UnregisterNavigationInvoker ( AActor* Invoker )	Removes given actor from the list of active navigation enforcers.
void	UnregisterNavigationInvoker ( AActor& Invoker )
void	UnregisterNavOctreeElement ( UObject* ElementOwner, INavRelevantInterface* Element..., int32 UpdateFlags )
void	UnregisterUnusedNavData()	Traverses SupportedAgents and for all agents not supported (i.e. filtered out by SupportedAgentsMask) checks if there's a currently registered NavigationData instance for that agent, and if so it unregisters that agent
void	UpdateAbstractNavData()	Find or create abstract nav data
void	UpdateActorAndComponentsInNavOctree ( AActor& Actor, bool bUpdateAttachedActors )	Update all navoctree entries for actor and its components
void	UpdateActorInNavOctree ( AActor& Actor )	Update navoctree entry for specified actor/component
void	UpdateAttachedActorsInNavOctree ( AActor& RootActor )	Updates navoctree information on actors attached to RootActor
void	UpdateComponentInNavOctree ( UActorComponent& Comp )
void	UpdateCustomLink ( const INavLinkCustomInterface*... )	Updates custom link for all active navigation data instances
void	UpdateLevelCollision ( ULevel* InLevel )
void	UpdateNavOctreeAfterMove ( USceneComponent* Comp )	Update all navoctree entries for actor and its non scene components after root movement
void	UpdateNavOctreeBounds ( AActor* Actor )	Updates bounds of all components implementing INavRelevantInterface
void	UpdateNavOctreeElement ( UObject* ElementOwner, INavRelevantInterface* Element..., int32 UpdateFlags )	Update single element in navoctree
bool	UpdateNavOctreeElementBounds ( UActorComponent* Comp, const FBox& NewBounds, const FBox& DirtyArea )	Update component bounds in navigation octree and mark only specified area as dirty, doesn't re-export component geometry
void	UpdateNavOctreeParentChain ( UObject* ElementOwner, bool bSkipElementOwnerUpdate )	Force updating parent node and all its children
void	VerifyNavigationRenderingComponents ( const bool bShow )	New stuff

Overridden from UNavigationSystemBase

	Name	Description
void	AppendConfig ( const UNavigationSystemConfig& New... )	Called when there's a need to extend current navigation system's config with information in NewConfig
void	ApplyWorldOffset ( const FVector& InOffset, bool bWorldShift )
void	CleanUp ( const FNavigationSystem::ECleanupMo... )	Called upon UWorld destruction to release what needs to be released
void	Configure ( const UNavigationSystemConfig& Con... )
INavigationD...	GetMainNavData()	Returns the world default navigation data instance.
void	InitializeForWorld ( UWorld& World, FNavigationSystemRunMode Mode )
bool	IsNavigationBuilt ( const AWorldSettings* Settings )
void	OnInitializeActors()	Called when owner-UWorld initializes actors
void	Tick ( float DeltaSeconds )

Overridden from UObject

	Name	Description
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Enums

	Name	Description
	ELockRemovalRebuildAction
	EOctreeUpdateMode	EOctreeUpdateMode is deprecated. Use FNavigationOctreeController::EOctreeUpdateMode instead.
	ERegistrationResult

Typedefs

Name	Description
FOnNavigationDirty	Delegate type for events that dirty the navigation data ( Params: const FBox& DirtyBounds )

Constants

Name	Description
bIsPIEActive
bNavigationAutoUpdateEnabled	Whether seamless navigation building is enabled
bStaticRuntimeNavigation
bUpdateNavOctreeOnComponentChange
CustomLinkRegistrationSection
ExecHandler	Self-registering exec command to handle nav sys console commands
NavigationDirtyEvent	Called after navigation influencing event takes place
PendingCustomLinkRegistration

Deprecated Variables

	Name	Description
uint8: 1	bCanAccumulateDirtyAreas	This member is deprecated and no longer used. Please access DirtyAreasController instead
uint8: 1	bDirtyAreasReportedWhileAccumulationLocked	This member is deprecated and no longer used. Please access DirtyAreasController instead
uint8: 1	bNavOctreeLock	This member is deprecated and no longer used. Please access OctreeController instead
TArray< FNaviga...	DirtyAreas	This member is deprecated and no longer used. Please access DirtyAreasController instead
float	DirtyAreasUpdateFreq	This member is deprecated and no longer used. Please access DirtyAreasController instead
float	DirtyAreasUpdateTime	This member is deprecated and no longer used. Please access DirtyAreasController instead
TSharedPtr< FNa...	NavOctree	This member is deprecated and no longer used. Please access OctreeController instead
TMap< uint32, F...	ObjectToOctreeId	This member is deprecated and no longer used. Please access OctreeController instead
TMultiMap< UObj...	OctreeChildNodesMap	This member is deprecated and no longer used. Please access OctreeController instead
TSet< FNavigati...	PendingOctreeUpdates	This member is deprecated and no longer used. Please access OctreeController instead

Deprecated Functions

	Name	Description
ANavigationD...	CreateNavigationDataInstance ( const FNavDataConfig& NavConfig )	This function is deprecated. Please use CreateNavigationDataInstanceInLevel instead
TSubclassOf<...	GetDefaultObstacleArea()	UNavigationSystemV1::GetDefaultObstacleArea is deprecated. Use FNavigationSystem::GetDefaultObstacleArea instead
TSubclassOf<...	GetDefaultWalkableArea()	UNavigationSystemV1::GetDefaultWalkableArea is deprecated. Use FNavigationSystem::GetDefaultWalkableArea instead
FVector	GetRandomPointInNavigableRadius ( UObject* WorldContextObject, const FVector& Origin, float Radius, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter... )	This version of GetRandomPointInNavigableRadius is deprecated. Please use the new version
FVector	GetRandomReachablePointInRadius ( UObject* WorldContextObject, const FVector& Origin, float Radius, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter... )	This version of GetRandomReachablePointInRadius is deprecated. Please use the new version
bool	IsNavigationBuildInProgress ( bool bCheckDirtyToo )	This function is deprecated. Please use IsNavigationBuildInProgress
bool	K2_GetRandomPointInNavigableRadius ( UObject* WorldContextObject, const FVector& Origin, FVector& RandomLocation, float Radius, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter... )	This version is deprecated. Please use GetRandomLocationInNavigableRadius instead
FVector	ProjectPointToNavigation ( UObject* WorldContextObject, const FVector& Point, ANavigationData* NavData, TSubclassOf< UNavigationQueryFilter..., const FVector QueryExtent )	This version of ProjectPointToNavigation is deprecated. Please use the new version
void	RemoveNavigationBuildLock ( uint8 Flags, bool bSkipRebuildInEditor )	This version of RemoveNavigationBuildLock is deprecated. Please use the new version
void	RequestRegistration ( ANavigationData* NavData, bool bTriggerRegistrationProcessing )	This version of RequestRegistration is deprecated. Please use the RequestRegistrationDeferred as the registration request is always queued now.
void	SetObjectsNavOctreeId ( const UObject& Object, FOctreeElementId2 Id )	This function is deprecated and no longer used. NavigationSystem is no longer involved in storing navoctree element IDs. See FNavigationOctree for more details.
void	SimpleMoveToActor ( AController* Controller, const AActor* Goal )	SimpleMoveToActor is deprecated. Use UAIBlueprintHelperLibrary::SimpleMoveToActor instead
void	SimpleMoveToLocation ( AController* Controller, const FVector& Goal )	SimpleMoveToLocation is deprecated. Use UAIBlueprintHelperLibrary::SimpleMoveToLocation instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss