1. Epic GamesDeveloper
  3. UNavigationSystemV1

UNavigationSystemV1

API > API/Runtime > API/Runtime/NavigationSystem

Inheritance Hierarchy

  • UNavigationSystemBase
  • UNavigationSystemV1

References

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

Syntax

UCLASS (Within=World, Config=Engine, defaultconfig, MinimalAPI)  
class UNavigationSystemV1 : public UNavigationSystemBase

Variables

  Type Name Description
Public variable UProperty Transient TObjectPtr< ANavigationData > AbstractNavData Special navigation data for managing direct paths, not part of NavDataSet!
Protected variable UProperty Category, EditAnywhere, Meta Config float ActiveTilesUpdateInterval Minimal time, in seconds, between active tiles set update
Protected variable TMap< FNavAgentProperties, TWeakObjectPtr< ANavigationData > > AgentToNavDataMap  
Protected variable TArray< FAsyncPathFindingQuery > AsyncPathFindingCompletedQueries Queued async pathfinding results computed by the dedicated task in the last frame and ready to dispatch in the next update.
Protected variable TArray< FAsyncPathFindingQuery > AsyncPathFindingQueries Queued async pathfinding queries to process in the next update.
Protected variable FGraphEventRef AsyncPathFindingTask Graph event that the main thread will wait for to synchronize with the async pathfinding task, if any.
Protected variable TAtomic< bool > bAbortAsyncQueriesRequested Flag used by main thread to ask the async pathfinding task to stop and postpone remaining queries, if any.
Protected variable UProperty Category, EditAnywhere Config uint32: 1 bAllowClientSideNavigation If false, will not create nav collision when connecting as a client
Protected variable uint8: 1 bAsyncBuildPaused  
Protected variable UProperty Category, EditAnywhere Config uint32: 1 bAutoCreateNavigationData Should navigation system spawn default Navigation Data when there's none and there are navigation bounds present?
Protected variable uint8: 1 bCleanUpDone Set when the NavSys instance has been cleaned up. This is an irreversible state
Protected variable UProperty Category, EditDefaultsOnly Config 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.
Public variable UProperty Category, EditAnywhere Config uint32: 1 bInitialBuildingLocked If set to true will result navigation system not rebuild navigation until a call to ReleaseInitialBuildingLock() is called.
Protected variable uint8: 1 bInitialLevelsAdded  
Protected variable uint8: 1 bInitialSetupHasBeenPerformed  
Protected variable UProperty Category, EditAnywhere Config uint32: 1 bShouldDiscardSubLevelNavData If true, games should ignore navigation data inside loaded sublevels
Public variable UProperty Category, EditAnywhere Config 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
Protected variable UProperty Category, EditAnywhere Config 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
Protected variable UProperty 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.
Protected variable UProperty Category, EditAnywhere Config uint32: 1 bTickWhilePaused If true, will update navigation even when the game is paused
Public variable UProperty Transient FBox BuildBounds Bounds of tiles to be built
Public variable uint32: 1 bWholeWorldNavigable If set to true (default) navigation will be generated only within special navigation bounds volumes (like ANavMeshBoundsVolume).
Protected variable uint8: 1 bWorldInitDone  
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly Config TSoftClassPtr< UCrowdManagerBase > CrowdManagerClass  
Protected variable int32 CurrentlyDrawnNavDataIndex Indicates which of multiple navigation data instances to draw
Protected variable TMap< uint32, FNavigationSystem::FCustomLinkOwnerInfo > CustomLinksMap Map of all custom navigation links, that are relevant for path following
Protected variable TMap< FNavLinkId, FNavigationSystem::FCustomLinkOwnerInfo > CustomNavLinksMap  
Protected variable UProperty Category, EditDefaultsOnly Config ENavDataGatheringModeConfig DataGatheringMode Sets how navigation data should be gathered when building collision information
Protected variable UProperty Category, EditAnywhere BlueprintReadOnly Config FName DefaultAgentName If not None indicates which of navigation datas and supported agents are going to be used as the default ones.
Protected variable FNavigationDirtyAreasController DefaultDirtyAreasController  
Protected variable FNavigationOctreeController DefaultOctreeController  
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config 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
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config float GatheringNavModifiersWarningLimitTime -1.0f by default, if set to a positive value, all calls to GetNavigationData will be timed and compared to it.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config int32 GeometryExportTriangleCountWarningThreshold Warnings are logged if exporting the navigation collision for an object exceed this triangle count.
Protected variable uint8 InitialNavBuildingLockFlags Set of locking flags applied on startup of navigation system
Protected variable UProperty Category, EditAnywhere, Meta Config double InvokersMaximumDistanceFromSeed When in use, invokers farther away from any invoker seed will be ignored (set to -1 to disable).
Public variable UProperty Transient TObjectPtr< ANavigationData > MainNavData  
Protected variable TSet< TObjectPtr< const UClass > > NavAreaClasses  
Protected variable uint8 NavBuildingLockFlags  
Protected variable FCriticalSection NavDataRegistration  
Public variable UProperty Transient TArray< TObjectPtr< ANavigationData > > NavDataRegistrationQueue  
Protected variable FCriticalSection NavDataRegistrationSection Async queries
Public variable UProperty Transient TArray< TObjectPtr< ANavigationData > > NavDataSet  
Protected variable FBox NavigableWorldBounds Cached navigable world bounding box
Protected variable FNavRegenTimeSliceManager NavRegenTimeSliceManager  
Protected variable uint8 NavUpdateLockFlags  
Public variable UProperty Transient FOnNavDataGenericEvent OnNavDataRegisteredEvent  
Public variable UProperty Meta BlueprintAssignable Transient FOnNavDataGenericEvent OnNavigationGenerationFinishedDelegate  
Public variable FOnNavigationInitDone OnNavigationInitDone  
Protected variable UProperty FNavigationSystemRunMode OperationMode  
Public variable TArray< FNavigationBoundsUpdateRequest > PendingNavBoundsUpdates List of pending navigation bounds update requests (add, remove, update size)
Protected variable TSet< FNavigationBounds > RegisteredNavBounds All areas where we build/have navigation
Protected variable FDelegateHandle ReloadCompleteDelegateHandle  
Protected variable UProperty Transient TObjectPtr< UNavigationObjectRepository > Repository  
Protected variable UProperty Category, EditAnywhere Config TArray< FNavDataConfig > SupportedAgents List of agents types supported by this navigation system
Protected variable UProperty Category, EditAnywhere Config FNavAgentSelector 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

  Type Name Description
Public function  

UNavigationSystemV1 ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AbortAsyncFindPathRequest ( uint32 AsynPathQueryID
)

 Removes query indicated by given ID from queue of path finding requests to process.
Protected function void Adds given request to requests queue. Note it's to be called only on game thread only
Public function void

AddDirtyArea ( const FBox& NewArea,
ENavigationDirtyFlag Flags,
const TFunction< const TSharedPtr< const FNavigationElement >()>& ElementProviderFunc,
const FName& DebugReason
)

  
Public function void

AddDirtyArea ( const FBox& NewArea,
int32 Flags,
const TFunction< UObject*()>& ObjectProviderFunc,
const FName& DebugReason
)

  
Public function void

AddDirtyArea ( const FBox& NewArea,
int32 Flags,
const FName& DebugReason
)

  
Public function void

AddDirtyArea ( const FBox& NewArea,
ENavigationDirtyFlag Flags,
const FName& DebugReason
)

  
Public function void

AddDirtyAreas ( const TArray< FBox >& NewAreas,
ENavigationDirtyFlag Flags,
const FName& DebugReason
)

  
Public function void

AddDirtyAreas ( const TArray< FBox >& NewAreas,
int32 Flags,
const FName& DebugReason
)

  
Protected function void

AddElementToNavOctree ( const FNavigationDirtyElement& DirtyElement
)

 Adds given element to NavOctree.
Protected function void

AddLevelCollisionToOctree ( ULevel* Level
)

 Add BSP collision data to navigation octree
Protected function Virtual void

AddLevelToOctree ( ULevel& Level
)

 Called during ConditionalPopulateNavOctree and gives subclassess a chance to influence what gets added
Protected function void

AddNavigationBounds ( const FNavigationBounds& NewBounds
)

 Adds data to RegisteredNavBounds
Protected function void

AddNavigationBoundsUpdateRequest ( const FNavigationBoundsUpdateRequest& UpdateRequest
)

 Adds navigation bounds update request to a pending list
Public function void

AddNavigationBuildLock ( uint8 Flags
)

  
Public function Virtual void

AddNavigationDataChunk ( ANavigationDataChunkActor& DataChunkActor
)

  
Public function Static FNavigationElementHandle

AddNavigationElement ( UWorld* World,
FNavigationElement&& Element
)

 Navigation octree related functions
Public function void

AddNavigationUpdateLock ( uint8 Flags
)

  
Public function Static void

AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

  
Public function Virtual void

AppendConfig ( const UNavigationSystemConfig& NewConfig
)

  
Protected function void  
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

  
Public function Virtual void

Build ()

 Building
Protected function void

CalcTimeSlicedUpdateData ( TArray< double >& OutCurrentTimeSlicedBuildTaskDurations,
TArray< bool >& OutIsTimeSlicingArray,
bool& bOutAnyNonTimeSlicedGenerators,
TArray< int32, TInlineAllocator< 8 > >& OutNumTimeSlicedRemainingBuildTasksArray
)

  
Public function Virtual void Cancels all currently running navigation builds
Public function Const bool Checks if dirty navigation data can rebuild itself
Public function Virtual void

CleanUp ( const FNavigationSystem::ECleanupMode Mode
)

 Called upon UWorld destruction to release what needs to be released
Public function Static void

ClearNavOctreeAll ( AActor* Actor
)

 Removes all navoctree entries for actor and its components
Public function Static FBox Return a Bounding Box containing the navlink points
Public function Virtual Const FBox  
Protected function Virtual bool 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
Public function Virtual void

Configure ( const UNavigationSystemConfig& Config
)

  
Public function Static 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.
Protected function Virtual void Called to instantiate NavigationSystem's NavOctree instance
Public function Virtual Const bool

ContainsNavData ( const FBox& Bounds
)

  
Protected function Virtual void Spawn new crowd manager
Public function Const FSharedNavQueryFilter  
Public function Virtual ANavigationData *

CreateNavigationDataInstanceInLevel ( const FNavDataConfig& NavConfig,
ULevel* SpawnLevel
)

 Constructs a navigation data instance of specified NavDataClass, in passed Level for supplied NavConfig.
Public function Static UNavigationSystemV1 *

CreateNavigationSystem ( UWorld* WorldOwner
)

  
Public function void Debug
Public function void

DemandLazyDataGathering ( FNavigationRelevantData& ElementData
)

  
Public function Const void

DescribeFilterFlags ( UEnum* FlagsEnum
)

 Filters.
Public function Const void

DescribeFilterFlags ( const TArray< FString >& FlagsDesc
)

 Prepare descriptions of navigation flags in UNavigationQueryFilter class: using array
Protected function Virtual void  
Protected function Const void

DispatchAsyncQueriesResults ( const TArray< FAsyncPathFindingQuery >& PathFindingQueries
)

 Broadcasts completion delegate for all completed async pathfinding requests.
Public function Static bool

DoesPathIntersectBox ( const FNavigationPath* Path,
const FBox& Box,
uint32 StartingIndex,
FVector* AgentExtent
)

  
Public function Static bool

DoesPathIntersectBox ( const FNavigationPath* Path,
const FBox& Box,
const FVector& AgentLocation,
uint32 StartingIndex,
FVector* AgentExtent
)

  
Protected function Virtual void Sets up SuportedAgents and NavigationDataCreators.
Protected function uint8

FillInstantiatedDataMask ( TBitArray<>& OutInstantiatedMask,
ULevel* InLevel
)

 Fills a mask indicating which navigation data associated to the supported agent mask are already instantiated.
Public function Virtual void

FillNavigationDataChunkActor ( const FBox& QueryBounds,
ANavigationDataChunkActor& DataChunkActor,
FBox& OutTilesBounds
)

  
Public function void

FindElementsInNavOctree ( const FBox& QueryBox,
const FNavigationOctreeFilter& Filter,
TArray< FNavigationOctreeElement >& Elements
)

 Find all elements in navigation octree within given box (intersection)
Public function uint32

FindPathAsync ( const FNavAgentProperties& AgentProperties,
FPathFindingQuery Query,
const FNavPathQueryDelegate& ResultDelegate,
EPathFindingMode::Type Mode
)

 Asynchronously looks for a path from @StartLocation to @EndLocation for agent with properties @AgentProperties.
Public function FPathFindingResult Does a simple path finding from @StartLocation to @EndLocation on specified NavData.
Public function FPathFindingResult

FindPathSync ( const FNavAgentProperties& AgentProperties,
FPathFindingQuery Query,
EPathFindingMode::Type Mode
)

 Synchronously looks for a path from @fLocation to @EndLocation for agent with properties @AgentProperties.
Public function Static UFunction BlueprintCallable, Category, Meta UNavigationPath *

FindPathToActorSynchronously ( UObject* WorldContextObject,
const FVector& PathStart,
AActor* GoalActor,
float TetherDistance,
AActor* PathfindingContext,
TSubclassOf< UNavigationQueryFilter > FilterClass
)

 Finds path instantly, in a FindPath Synchronously.
Public function Static UFunction BlueprintCallable, Category, Meta UNavigationPath *

FindPathToLocationSynchronously ( UObject* WorldContextObject,
const FVector& PathStart,
const FVector& PathEnd,
AActor* PathfindingContext,
TSubclassOf< UNavigationQueryFilter > FilterClass
)

 Finds path instantly, in a FindPath Synchronously.
Public function Const void

GatherDebugLabels ( TArray< FString >& InOutDebugLabels
)

  
Protected function Virtual void Searches for all valid navigation bounds in the world and stores them
Public function Const ANavigationData *  
Protected function Static int32

GetAllAttachedActors ( const AActor& RootActor,
TArray< AActor* >& OutAttachedActors
)

 A helper function that gathers all actors attached to RootActor and fetches them back.
Public function Static const FNavDataConfig &

GetBiggestSupportedAgent ( const UWorld* World
)

  
Public function Const UCrowdManagerBase *  
Public function Static UNavigationSystemV1 *

GetCurrent ( UObject* WorldContextObject
)

  
Public function Static UNavigationSystemV1 *

GetCurrent ( UWorld* World
)

  
Public function Const INavLinkCustomInterface *

GetCustomLink ( FNavLinkId UniqueLinkId
)

 Find custom link by unique ID
Public function Const INavLinkCustomInterface *

GetCustomLink ( uint32 UniqueLinkId
)

  
Public function Const const FNavigationRelevantData *

GetDataForElement ( FNavigationElementHandle Element
)

  
Public function Const const FNavigationRelevantData *

GetDataForObject ( const UObject& Object
)

  
Public function ANavigationData * Returns the world default navigation data instance. Creates one if it doesn't exist.
Public function Const ANavigationData *  
Public function Static const FNavDataConfig &  
Public function Const const FNavDataConfig &  
Public function Const float  
Public function Const const TArray< FNavigationInvokerRaw > &  
Protected function Virtual void

GetInvokerSeedLocations ( const UWorld& InWorld,
TArray< FVector, TInlineAllocator< 32 > >& OutSeedLocations
)

 Get seed locations for invokers,
Protected function Virtual void

GetInvokerSeedLocations ( const UWorld& InWorld,
TArray< FVector2D, TInlineAllocator< 32 > >& OutSeedLocations
)

  
Public function Const const TArray< FBox > &  
Public function Virtual Const bool Checks if auto-rebuilding navigation data is enabled.
Public function Const FBox

GetLevelBounds ( ULevel* InLevel
)

  
Public function Virtual Const INavigationDataInterface * Returns the world default navigation data instance.
Public function Const ANavigationData &  
Public function FNavigationRelevantData *

GetMutableDataForElement ( FNavigationElementHandle Element
)

  
Public function FNavigationRelevantData *

GetMutableDataForObject ( const UObject& Object
)

  
Public function FNavigationOctree *  
Public function FNavRegenTimeSliceManager &  
Public function Const void

GetNavAgentPropertiesArray ( TArray< FNavAgentProperties >& OutNavAgentProperties
)

 Fetch the array of all nav-agent properties.
Public function Static INavigationDataInterface *

GetNavDataForActor ( const AActor& Actor
)

  
Public function Virtual Const ANavigationData *

GetNavDataForAgentName ( const FName AgentName
)

 Goes through all registered NavigationData instances and retrieves the one supporting agent named AgentName
Public function Virtual ANavigationData *

GetNavDataForProps ( const FNavAgentProperties& AgentProperties
)

 Looks for NavData generated for specified movement properties and returns it. NULL if not found;
Public function Virtual Const ANavigationData *

GetNavDataForProps ( const FNavAgentProperties& AgentProperties,
const FVector& AgentLocation,
const FVector& Extent
)

 Looks up NavData appropriate for specified movement properties and returns it.
Public function Virtual Const const ANavigationData *

GetNavDataForProps ( const FNavAgentProperties& AgentProperties
)

 Looks for NavData generated for specified movement properties and returns it.
Protected function Const ANavigationData *

GetNavDataWithID ( const uint16 NavDataID
)

  
Public function Virtual Const FBox  
Public function Const const TSet< FNavigationBounds > &  
Public function Virtual Const int

GetNavigationBoundsForNavData ( const ANavigationData& NavData,
TArray< FBox >& OutBounds,
ULevel* InLevel
)

  
Protected function Const TSharedPtr< const FNavigationElement >

GetNavigationElementForUObject ( const UObject*
)

  
Protected function Const FNavigationElementHandle  
Public function Static UFunction BlueprintPure, Category, Meta UNavigationSystemV1 *

GetNavigationSystem ( UObject* WorldContextObject
)

 Blueprint functions.
Public function Const const FNavigationOctree *  
Protected function bool

GetNavOctreeElementData ( FNavigationElementHandle Element,
ENavigationDirtyFlag& OutDirtyFlags,
FBox& OutDirtyBounds
)

 Read element data from navigation octree
Protected function bool

GetNavOctreeElementData ( const UObject& NodeOwner,
int32& DirtyFlags,
FBox& DirtyBounds
)

  
Public function Const const FOctreeElementId2 *

GetNavOctreeIdForElement ( FNavigationElementHandle Element
)

  
Public function Const int32  
Public function Const int32  
Public function Const int32 Used to display "navigation building in progress" counter
Public function Const int32 Number of currently running tasks
Public function Const const FOctreeElementId2 *

GetObjectsNavOctreeId ( const UObject& Object
)

  
Public function void

GetOnScreenMessages ( TMultiMap< FCoreDelegates::EOnScreenMessageSeverity, FText >& OutMessages
)

  
Public function Const FNavigationSystemRunMode  
Public function Const ENavigationQueryResult::Type

GetPathCost ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& PathCost,
const ANavigationData* NavData,
FSharedConstNavQueryFilter QueryFilter
)

 Calculates a path from PathStart to PathEnd and retrieves its cost.
Public function Static UFunction BlueprintPure, Category, Meta ENavigationQueryResult::Type

GetPathCost ( UObject* WorldContextObject,
const FVector& PathStart,
const FVector& PathEnd,
double& PathCost,
ANavigationData* NavData,
TSubclassOf< UNavigationQueryFilter > FilterClass
)

 Potentially expensive.
Public function Const ENavigationQueryResult::Type

GetPathLength ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& PathLength,
const ANavigationData* NavData,
FSharedConstNavQueryFilter QueryFilter
)

 Calculates a path from PathStart to PathEnd and retrieves its overestimated length.
Public function Static UFunction BlueprintPure, Category, Meta ENavigationQueryResult::Type

GetPathLength ( UObject* WorldContextObject,
const FVector& PathStart,
const FVector& PathEnd,
double& PathLength,
ANavigationData* NavData,
TSubclassOf< UNavigationQueryFilter > FilterClass
)

 Potentially expensive. Use with caution
Public function Const ENavigationQueryResult::Type

GetPathLengthAndCost ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& PathLength,
FVector::FReal& PathCost,
const ANavigationData* NavData,
FSharedConstNavQueryFilter QueryFilter
)

 Calculates a path from PathStart to PathEnd and retrieves its overestimated length and cost.
Public function bool

GetRandomPoint ( FNavLocation& ResultLocation,
ANavigationData* NavData,
FSharedConstNavQueryFilter QueryFilter
)

 Finds random point in navigable space
Public function Const bool

GetRandomPointInNavigableRadius ( const FVector& Origin,
float Radius,
FNavLocation& ResultLocation,
ANavigationData* NavData,
FSharedConstNavQueryFilter QueryFilter
)

 Finds random, point in navigable space restricted to Radius around Origin.
Public function Const bool

GetRandomReachablePointInRadius ( const FVector& Origin,
float Radius,
FNavLocation& ResultLocation,
ANavigationData* NavData,
FSharedConstNavQueryFilter QueryFilter
)

 Finds random, reachable point in navigable space restricted to Radius around Origin
Public function Const FNavigationSystemRunMode  
Protected function Const ERuntimeGenerationType 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
Public function Const int32 Find index in SupportedAgents array for given navigation data
Public function Const int32

GetSupportedAgentIndex ( const FNavAgentProperties& NavAgent
)

 Find index in SupportedAgents array for agent type
Public function Const const TArray< FNavDataConfig > &  
Public function Const FNavAgentSelector  
Public function Const UWorld *  
Public function Const FBox  
Public function Static double  
Public function bool  
Public function bool

HandleCycleNavDrawnCommand ( const TCHAR* Cmd,
FOutputDevice& Ar
)

 Exec command handlers
Public function Const bool  
Public function Static uint32

HashObject ( const UObject& Object
)

  
Public function Const bool

HasPendingObjectNavOctreeId ( UObject* Object
)

  
Public function Const bool

HasPendingUpdateForElement ( FNavigationElementHandle Element
)

  
Public function Virtual void

InitializeForWorld ( UWorld& World,
FNavigationSystemRunMode Mode
)

  
Public function void Adds BSP collisions of currently streamed in levels to octree
Public function Const bool  
Protected function Const bool Whether Navigation System is allowed to rebuild the navmesh Depends on runtime generation settings of each navigation data, always true in the editor
Public function Const bool  
Public function Static UFunction BlueprintPure, Category, Meta bool

IsNavigationBeingBuilt ( UObject* WorldContextObject
)

  
Public function Static UFunction BlueprintPure, Category, Meta bool

IsNavigationBeingBuiltOrLocked ( UObject* WorldContextObject
)

  
Public function Const bool

IsNavigationBuildingLocked ( uint8 Flags
)

  
Public function Const bool Check if building is permanently locked to avoid showing navmesh building notify (due to queued dirty areas)
Public function bool Determines whether any generator is performing navigation building actions at the moment, dirty areas are also checked
Public function Virtual Const bool

IsNavigationBuilt ( const AWorldSettings* Settings
)

  
Public function Const bool Checks if navigation/navmesh is dirty and needs to be rebuilt
Public function Const bool Check if navigation octree updates are currently ignored
Public function Const bool  
Public function Const bool

IsNavigationRelevant ( const AActor* TestActor
)

  
Public function Static bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool Returns true if world has been initialized.
Public function Static UFunction BlueprintCallable, Category, Meta bool

K2_GetRandomLocationInNavigableRadius ( UObject* WorldContextObject,
const FVector& Origin,
FVector& RandomLocation,
float Radius,
ANavigationData* NavData,
TSubclassOf< UNavigationQueryFilter > FilterClass
)

 Generates a random location in navigable space within given radius of Origin.
Public function Static UFunction BlueprintPure, Category, Meta bool

K2_GetRandomPointInNavigableRadius ( UObject* WorldContextObject,
const FVector& Origin,
FVector& RandomLocation,
float Radius,
ANavigationData* NavData,
TSubclassOf< UNavigationQueryFilter > FilterClass
)

 DEPRECATED.
Public function Static UFunction BlueprintPure, Category, Meta bool

K2_GetRandomReachablePointInRadius ( UObject* WorldContextObject,
const FVector& Origin,
FVector& RandomLocation,
float Radius,
ANavigationData* NavData,
TSubclassOf< UNavigationQueryFilter > FilterClass
)

 Generates a random location reachable from given Origin location.
Public function Static UFunction BlueprintPure, Category, Meta bool

K2_ProjectPointToNavigation ( UObject* WorldContextObject,
const FVector& Point,
FVector& ProjectedLocation,
ANavigationData* NavData,
TSubclassOf< UNavigationQueryFilter > FilterClass,
const FVector QueryExtent
)

 Project a point onto the NavigationData
Public function UFunction BlueprintCallable, Category, Meta bool

K2_ReplaceAreaInOctreeData ( const UObject* Object,
TSubclassOf< UNavArea > OldArea,
TSubclassOf< UNavArea > NewArea
)

  
Protected function void  
Public function Static UFunction BlueprintCallable, Category, Meta bool

NavigationRaycast ( UObject* WorldContextObject,
const FVector& RayStart,
const FVector& RayEnd,
FVector& HitLocation,
TSubclassOf< UNavigationQueryFilter > FilterClass,
AController* Querier
)

 Performs navigation raycast on NavigationData appropriate for given Querier.
Public function Static bool

NavigationRaycastWithAdditionalResults ( UObject* WorldContextObject,
const FVector& RayStart,
const FVector& RayEnd,
FVector& HitLocation,
FNavigationRaycastAdditionalResults* AdditionalResults,
TSubclassOf< UNavigationQueryFilter > FilterClass,
AController* Querier
)

 Performs navigation raycast on NavigationData appropriate for given Querier.
Protected function void

OnActorMoved ( AActor* Actor
)

 Delegate handler for ActorMoved events
Public function Static void

OnActorRegistered ( AActor* Actor
)

  
Public function Static void

OnActorUnregistered ( AActor* Actor
)

  
Protected function Virtual void

OnBeginTearingDown ( UWorld* World
)

 Called as part of UWorld::BeginTearingDown
Public function Static void

OnComponentRegistered ( UActorComponent* Comp
)

  
Public function Static void

OnComponentUnregistered ( UActorComponent* Comp
)

  
Protected function void Handle forwarding the information where needed when the setting is changed
Public function Virtual void Called when owner-UWorld initializes actors
Protected function void

OnLevelAddedToWorld ( ULevel* InLevel,
UWorld* InWorld
)

 Handler for FWorldDelegates::LevelAddedToWorld event
Protected function void

OnLevelRemovedFromWorld ( ULevel* InLevel,
UWorld* InWorld
)

 Handler for FWorldDelegates::LevelRemovedFromWorld event
Protected function void

OnNavigationAreaEvent ( UClass* AreaClass,
ENavAreaEvent::Type Event
)

  
Public function Virtual UFunction BlueprintCallable, Category void  
Public function Virtual void  
Public function UFunction BlueprintCallable, Category void  
Protected function void

OnNavigationDirtied ( const FBox& Bounds
)

 Delegate handler called when navigation is dirtied
Public function Static void

OnNavigationElementUpdated ( UWorld* World,
FNavigationElementHandle ElementHandle,
FNavigationElement&& Element
)

  
Public function Virtual void  
Public function Static void

OnNavRelevantObjectRegistered ( UObject& Object
)

  
Public function Static void

OnNavRelevantObjectUnregistered ( UObject& Object
)

  
Public function void  
Public function void  
Protected function void

OnPostLoadMap ( UWorld* LoadedWorld
)

 Delegate handler for PostLoadMap event
Protected function Virtual void

OnReloadComplete ( EReloadCompleteReason Reason
)

 Called to notify NavigationSystem about finished reload
Public function Virtual void

OnWorldInitDone ( FNavigationSystemRunMode Mode
)

  
Protected function void

OnWorldPostActorTick ( UWorld* World,
ELevelTick TickType,
float DeltaTime
)

 Handler for FWorldDelegates::OnWorldPostActorTick event
Public function void

OverrideSupportedAgents ( const TArray< FNavDataConfig >& NewSupportedAgents
)

  
Protected function void

PerformAsyncQueries ( TArray< FAsyncPathFindingQuery > PathFindingQueries
)

 Processes pathfinding requests given in PathFindingQueries.
Protected function Virtual void

PerformNavigationBoundsUpdate ( const TArray< FNavigationBoundsUpdateRequest >& UpdateRequests
)

 Used to apply updates of nav volumes in navigation system's tick
Public function Virtual void

PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void  
Protected function void Requests the async pathfinding task to abort and waits for it to complete before resuming the main thread.
Protected function void Registers custom navigation links awaiting registration in the navigation object repository
Protected function Virtual void Processes registration of candidates queues via RequestRegistration and stored in NavDataRegistrationQueue
Public function Const bool

ProjectPointToNavigation ( const FVector& Point,
FNavLocation& OutLocation,
const FVector& Extent,
const ANavigationData* NavData,
FSharedConstNavQueryFilter QueryFilter
)

  
Public function bool

ProjectPointToNavigation ( const FVector& Point,
FNavLocation& OutLocation,
const FVector& Extent,
const FNavAgentProperties* AgentProperties,
FSharedConstNavQueryFilter QueryFilter
)

  
Protected function Virtual void

RebuildAll ( bool bIsLoadTime
)

 Triggers navigation building on all eligible navigation data.
Protected function Virtual void

RebuildDirtyAreas ( float DeltaSeconds
)

  
Public function Static void

RegisterComponent ( UActorComponent* Comp
)

  
Protected function Static void

RegisterComponentToNavOctree ( UActorComponent* Comp
)

  
Public function Virtual void Custom navigation links.
Public function Virtual void

RegisterInvoker ( const TWeakInterfacePtr< INavigationInvokerInterface >& Invoker,
float TileGenerationRadius,
float TileRemovalRadius,
const FNavAgentSelector& Agents,
ENavigationInvokerPriority InPriority
)

  
Public function Virtual void

RegisterInvoker ( AActor& Invoker,
float TileGenerationRadius,
float TileRemovalRadius,
const FNavAgentSelector& Agents,
ENavigationInvokerPriority InPriority
)

 Active tiles.
Protected function void

RegisterNavAreaClass ( UClass* NavAreaClass
)

 Tries to register navigation area
Protected function Virtual ERegistrationResult Registers given navigation data with this Navigation System.
Protected function void Processes all NavigationData instances in UWorld owning navigation system instance, and registers all previously unregistered
Protected function FSetElementId

RegisterNavigationElementWithNavOctree ( const TSharedRef< const FNavigationElement >& Element,
int32 UpdateFlags
)

  
Public function UFunction BlueprintCallable, Category 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.
Public function Static void

RegisterNavigationInvoker ( AActor& Invoker,
float TileGenerationRadius,
float TileRemovalRadius,
const FNavAgentSelector& Agents,
ENavigationInvokerPriority Priority
)

  
Protected function FSetElementId

RegisterNavOctreeElement ( UObject* ElementOwner,
INavRelevantInterface* ElementInterface,
int32 UpdateFlags
)

  
Protected function void

RegisterNavRelevantObjectInternal ( const INavRelevantInterface& NavRelevantObject,
const UObject& Object
)

 Similar to UnregisterNavRelevantObjectStatic but uses the cached repository.
Protected function Static void

RegisterNavRelevantObjectStatic ( const INavRelevantInterface& NavRelevantObject,
const UObject& Object
)

 Fetches the repository from the provided object and registers the object with it.
Public function Virtual void  
Protected function void

RemoveFromNavOctree ( const FOctreeElementId2& ElementId,
int32 UpdateFlags
)

  
Protected function void

RemoveLevelCollisionFromOctree ( ULevel* Level
)

 Remove BSP collision data from navigation octree
Public function void

RemoveNavigationBuildLock ( uint8 Flags,
const ELockRemovalRebuildAction RebuildAction
)

  
Public function Virtual void

RemoveNavigationDataChunk ( ANavigationDataChunkActor& DataChunkActor
)

  
Public function Static void

RemoveNavigationElement ( UWorld* World,
FNavigationElementHandle ElementHandle
)

  
Public function void

RemoveNavigationUpdateLock ( uint8 Flags
)

  
Public function void

RemoveNavOctreeElementId ( const FOctreeElementId2& ElementId,
int32 UpdateFlags
)

  
Public function void

RemoveObjectsNavOctreeId ( const UObject& Object
)

  
Public function bool

ReplaceAreaInOctreeData ( FNavigationElementHandle Handle,
TSubclassOf< UNavArea > OldArea,
TSubclassOf< UNavArea > NewArea,
bool bReplaceChildClasses
)

 Fetched element's data from the octree and replaces occurrences of OldArea with NewArea
Public function bool

ReplaceAreaInOctreeData ( const UObject& Object,
TSubclassOf< UNavArea > OldArea,
TSubclassOf< UNavArea > NewArea,
bool bReplaceChildClasses
)

  
Public function Static void

RequestAreaRegistering ( UClass* NavAreaClass
)

 Areas.
Public function Static void

RequestAreaUnregistering ( UClass* NavAreaClass
)

  
Public function Static void

RequestCustomLinkRegistering ( INavLinkCustomInterface& CustomLink,
UObject* OwnerOb
)

  
Public function Static void

RequestCustomLinkUnregistering ( INavLinkCustomInterface& CustomLink,
UObject* ObjectOb
)

  
Public function Virtual void Adds NavData to registration candidates queue - NavDataRegistrationQueue
Protected function Const bool Whether Navigation system needs to populate nav octree.
Public function void

ResetCachedFilter ( TSubclassOf< UNavigationQueryFilter > FilterClass
)

 Removes cached filters from currently registered navigation data
Public function UFunction BlueprintCallable, Category void Brings limit of simultaneous navmesh tile generation jobs back to Project Setting's default value
Public function Virtual void

SetBuildBounds ( const FBox& Bounds
)

 Set limiting bounds to be used when building navigation data.
Protected function void

SetCrowdManager ( UCrowdManagerBase* NewCrowdManager
)

  
Public function UFunction BlueprintCallable, Category void

SetGeometryGatheringMode ( ENavDataGatheringModeConfig NewMode
)

  
Public function UFunction BlueprintCallable, Category void

SetMaxSimultaneousTileGenerationJobsCount ( int32 MaxNumberOfJobs
)

 Will limit the number of simultaneously running navmesh tile generation jobs to specified number.
Public function Static void

SetNavigationAutoUpdateEnabled ( bool bNewEnable,
UNavigationSystemBase* InNavigationSystem
)

 Allow editor to toggle whether seamless navigation building is enabled
Public function void

SetNavigationOctreeLock ( bool bLock
)

  
Public function void

SetSupportedAgentsMask ( const FNavAgentSelector& InSupportedAgentsMask
)

  
Protected function void

SetSupportedAgentsNavigationClass ( int32 AgentIndex,
TSubclassOf< ANavigationData > NavigationDataClass
)

 Used to properly set navigation class for indicated agent and propagate information to other places (like project settings) that may need this information
Public function Static void

SetUpdateNavOctreeOnComponentChange ( bool bNewUpdateOnComponentChange
)

  
Public function Const bool  
Public function Virtual Const bool

ShouldCreateNavigationSystemInstance ( const UWorld* World
)

 Indicates whether navigation is allowed for a given world.
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool

ShouldGeneratorRun ( const FNavDataGenerator* Generator
)

 Super-hacky safety feature for threaded navmesh building.
Public function Virtual Const bool  
Public function Static bool  
Protected function Virtual void  
Protected function void

SpawnMissingNavigationDataInLevel ( const TBitArray<>& InInstantiatedMask,
ULevel* InLevel
)

 Spawns missing navigation data.
Public function Const bool  
Public function Const 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)
Public function Virtual void

Tick ( float DeltaSeconds
)

  
Protected function void

TriggerAsyncQueries ( TArray< FAsyncPathFindingQuery >& PathFindingQueries
)

 Spawns a non-game-thread task to process requests given in PathFindingQueries.
Public function Static void

UnregisterComponent ( UActorComponent* Comp
)

  
Protected function Static void

UnregisterComponentToNavOctree ( UActorComponent* Comp
)

  
Public function void  
Public function Virtual void

UnregisterInvoker ( const TWeakInterfacePtr< INavigationInvokerInterface >& Invoker
)

  
Public function Virtual void

UnregisterInvoker ( AActor& Invoker
)

  
Protected function void

UnregisterNavAreaClass ( UClass* NavAreaClass
)

 Tries to unregister navigation area
Public function Virtual void Bookkeeping.
Protected function void

UnregisterNavigationElementWithOctree ( const TSharedRef< const FNavigationElement >& Element,
int32 UpdateFlags
)

  
Public function UFunction BlueprintCallable, Category void

UnregisterNavigationInvoker ( AActor* Invoker
)

 Removes given actor from the list of active navigation enforcers.
Public function Static void

UnregisterNavigationInvoker ( AActor& Invoker
)

  
Protected function void

UnregisterNavOctreeElement ( UObject* ElementOwner,
INavRelevantInterface* ElementInterface,
int32 UpdateFlags
)

  
Protected function void

UnregisterNavRelevantObjectInternal ( const UObject& Object
)

 Similar to UnregisterNavRelevantObjectStatic but uses the cached repository.
Protected function Static void

UnregisterNavRelevantObjectStatic ( const UObject& Object
)

 Fetches the repository from the provided object and unregisters the object with it.
Public function Virtual void 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
Protected function Virtual void Find or create abstract nav data
Public function Static void

UpdateActorAndComponentsInNavOctree ( AActor& Actor,
bool bUpdateAttachedActors
)

 Update all navoctree entries for actor and its components
Public function Static void

UpdateActorInNavOctree ( AActor& Actor
)

 Update navoctree entry for specified actor/component
Protected function Static void

UpdateAttachedActorsInNavOctree ( AActor& RootActor
)

 Updates navoctree information on actors attached to RootActor
Public function Static void

UpdateComponentInNavOctree ( UActorComponent& Comp
)

  
Public function void Updates custom link for all active navigation data instances
Public function void

UpdateLevelCollision ( ULevel* InLevel
)

  
Protected function Virtual void  
Public function Static void

UpdateNavOctreeAfterMove ( USceneComponent* Comp
)

 Update all navoctree entries for actor and its non scene components after root movement
Public function Static void

UpdateNavOctreeBounds ( AActor* Actor
)

 Updates bounds of all components implementing INavRelevantInterface
Public function void

UpdateNavOctreeElement ( FNavigationElementHandle Handle,
const TSharedRef< const FNavigationElement >& Element,
int32 UpdateFlags
)

 Update single element in navoctree
Public function void

UpdateNavOctreeElement ( UObject* ElementOwner,
INavRelevantInterface* ElementInterface,
int32 UpdateFlags
)

  
Public function bool

UpdateNavOctreeElementBounds ( FNavigationElementHandle Handle,
const FBox& NewBounds,
TConstArrayView< FBox > DirtyAreas
)

 Update element's bounds in navigation octree and mark only specified area as dirty, doesn't re-export geometry
Public function 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
Public function bool

UpdateNavOctreeElementBounds ( UObject& Object,
const FBox& NewBounds,
TConstArrayView< FBox > DirtyAreas
)

  
Public function void

UpdateNavOctreeParentChain ( UObject* ElementOwner,
bool bSkipElementOwnerUpdate
)

  
Public function Static void  
Protected function Static void

UpdateNavRelevantObjectInNavOctreeStatic ( const INavRelevantInterface& InNavRelevantObject,
const UObject& InObject,
UNavigationSystemV1* InNavigationSystem,
TFunctionRef< void(UNavigationSystemV1&, const TSharedRef< const FNavigationElement >&)> InCallbac...
)

 In actor/component code paths it is possible that updates get called without a previous call to register (wasn't relevant at that time).
Public function void New stuff

Enums

  Type Name Description
Public enum ELockRemovalRebuildAction    
Public enum EOctreeUpdateMode EOctreeUpdateMode is deprecated. Use FNavigationOctreeController::EOctreeUpdateMode instead.  
Public enum 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  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page