1. Epic GamesDeveloper
  3. NavigationSystem

NavigationSystem

API > API/Runtime

   
Name NavigationSystem
Type Runtime
Location /Engine/Source/Runtime/NavigationSystem/
Module Build Rules NavigationSystem.Build.cs

Classes

Name Remarks
AAbstractNavData  
ANavigationData Represents abstract Navigation Data (sub-classed as NavMesh, NavGraph, etc) Used as a common interface for all navigation types handled by NavigationSystem
ANavigationGraph Currently abstract since it's not full implemented
ANavigationGraphNode  
ANavigationTestingActor  
ANavMeshBoundsVolume This volume only blocks the path builder - it has no gameplay collision
ANavModifierVolume Allows applying selected AreaClass to navmesh, using Volume's shape
ANavSystemConfigOverride  
ARecastNavMesh  
FAbstractQueryFilter  
FNavigationOctree  
FNavLinkRenderingProxy  
FNavMeshSceneProxy Exported to API for GameplayDebugger module
FNavRegenTimeSliceManager  
FNavRegenTimeSlicer  
FOnNavDataGenericEvent Delegate to let interested parties know that Nav Data has been registered
FOnNavigationPathUpdated  
UBaseGeneratedNavLinksProxy Experimental Base class used to create generated navlinks proxy.
UCrowdManagerBase Base class for Crowd Managers.
UNavArea Class containing definition of a navigation area
UNavArea_Default Regular navigation area, applied to entire navigation data by default
UNavArea_LowHeight Special area that can be generated in spaces with insufficient free height above.
UNavArea_Null In general represents an empty area, that cannot be traversed by anyone. Ever.
UNavArea_Obstacle In general represents a high cost area, that shouldn't be traversed by anyone unless no other path exist.
UNavAreaMeta A convenience class for an area that has IsMetaArea() == true.
UNavAreaMeta_SwitchByAgent Class containing definition of a navigation area
UNavCollision  
UNavigationGraphNodeComponent  
UNavigationInvokerComponent  
UNavigationPath UObject wrapper for FNavigationPath
UNavigationPathGenerator  
UNavigationQueryFilter Class containing definition of a navigation query filter
UNavigationSystemModuleConfig UNavigationSystemModuleConfig.
UNavigationSystemV1  
UNavLinkComponent  
UNavLinkCustomComponent Encapsulates NavLinkCustomInterface interface, can be used with Actors not relevant for navigation
UNavLinkCustomInterface Interface for custom navigation links
UNavLinkHostInterface  
UNavLinkRenderingComponent  
UNavLinkTrivial  
UNavMeshRenderingComponent  
UNavModifierComponent  
UNavNodeInterface  
UNavRelevantComponent  
UNavTestRenderingComponent  
URecastFilter_UseDefaultArea Regular navigation area, applied to entire navigation data by default
URecastNavMeshDataChunk  
USplineNavModifierComponent Used to assign a chosen NavArea to the nav mesh in the vicinity of a chosen spline.

Structs

Name Remarks
FAbstractNavigationPath  
FAsyncPathFindingQuery  
FCustomLinkOwnerInfo  
FDetourTileLayout  
FDetourTileSizeInfo  
FMoveRequestCustomData Custom path following data** Custom data passed to movement requests. */
FNavCollisionBox  
FNavCollisionCylinder  
FNavGraphEdge  
FNavGraphNode  
FNavigationDataHandler  
FNavigationDirtyAreasController  
FNavigationDirtyElementKeyFunctions  
FNavigationFilterArea  
FNavigationFilterFlags Use UNavigationSystemV1.DescribeFilterFlags() to setup user friendly names of flags
FNavigationInvoker  
FNavigationInvokerRaw Active tiles.
FNavigationOctreeController  
FNavigationOctreeElement  
FNavigationOctreeSemantics  
FNavigationPath  
FNavigationRaycastAdditionalResults  
FNavigationSystemExec  
FNavLinkCustomInstanceData Used to store navlink data during RerunConstructionScripts
FNavLinkGenerationJumpConfig Experimental configuration to generate vertical links.
FNavLinkOwnerData  
FNavMeshDirtyTileElement Used to list tiles that needs rebuilding.
FNavMeshNodeFlags Helper to translate FNavPathPoint.Flags.
FNavMeshPath  
FNavMeshResolutionParam  
FNavMeshSceneProxyData Exported to API for GameplayDebugger module
FNavMeshTileData Structure to handle nav mesh tile's raw data persistence and releasing
FNavPathRecalculationRequest  
FNavTestTickHelper  
FPathFindingQuery  
FPathFindingQueryData  
FPathFindingResult  
FRecastNamedFiltersCreator  
FRecastNavMeshTileGenerationDebug  
FRecastTileData  
FSupportedAreaData  
FTileHistoryData  

Interfaces

Name Remarks
INavigationPathGenerator  
INavLinkCustomInterface  
INavLinkHostInterface  
INavNodeInterface  
INavSysModule The public interface to this module

Typedefs

Name Type Remarks Include Path
FCustomMoveSharedPtr TSharedPtr< FMoveRequestCustomData, ESPMode::ThreadSafe >   NavigationSystemTypes.h
FCustomMoveWeakPtr TWeakPtr< FMoveRequestCustomData, ESPMode::ThreadSafe >   NavigationSystemTypes.h
FNavDebugMeshData FDebugRenderSceneProxy::FMesh   NavDebugTypes.h
FNavigationOctreeFilter FNavigationRelevantDataFilter   NavigationOctree.h
FNavLinkProcessorDataDelegate TBaseDelegate_ThreeParams< void, FCompositeNavModifier *, const FNavLinkOwnerData &, const TArray< FNavigationLink > & >   NavigationSystemTypes.h
FNavLinkProcessorDelegate TBaseDelegate_ThreeParams< void, FCompositeNavModifier *, const AActor *, const TArray< FNavigationLink > & >   NavigationSystemTypes.h
FNavLinkSegmentProcessorDataDelegate TBaseDelegate_ThreeParams< void, FCompositeNavModifier *, const FNavLinkOwnerData &, const TArray< FNavigationSegmentLink > & >   NavigationSystemTypes.h
FNavLinkSegmentProcessorDelegate TBaseDelegate_ThreeParams< void, FCompositeNavModifier *, const AActor *, const TArray< FNavigationSegmentLink > & >   NavigationSystemTypes.h
FNavPathSharedPtr TSharedPtr< struct FNavigationPath, ESPMode::ThreadSafe >   NavigationSystemTypes.h
FOnNavAreaChanged TMulticastDelegate_OneParam< void, const UClass * > Delegate to let interested parties know that new nav area class has been registered NavigationSystem.h
FOnNavigationInitDone TMulticastDelegate_NoParams< void >   NavigationSystem.h
FOnNavMeshUpdate TMulticastDelegate_NoParams< void >   NavMesh/RecastNavMesh.h
FSharedConstNavQueryFilter TSharedPtr< const FNavigationQueryFilter, ESPMode::ThreadSafe >   NavigationSystemTypes.h

Enums

Public

Name Remarks
EGatherTilesCopyMode  
EHeightFieldRenderMode  
ELinkGenerationDebugFlags  
ENavCostDisplay::Type  
ENavigationBuildLock::Type  
ENavigationLedgeSlopeFilterMode  
ENavLinkBuilderFlags  
ENavMeshDetailFlags  
ENavSystemOverridePolicy  
EPathFindingMode::Type  
ERecastPartitioning::Type  
ERuntimeGenerationType Supported options for runtime navigation data generation
ESubdivisionLOD  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AreaClass_DEPRECATED TSubclassOf< UNavAreaBase > Area class for links generated by this configuration. NavMesh/LinkGenerationConfig.h
  • Config
  • Meta=(DeprecatedProperty, DeprecationMessage="Use DownDirectionAreaClass and UpDirectionAreaClass instead.")
bEnabled bool Should this config be used to generate links. NavMesh/LinkGenerationConfig.h
  • Config
bLinkProxyRegistered bool Is the link proxy registered to the navigation system CustomNavLinksMap. NavMesh/LinkGenerationConfig.h
  • Transient
DownDirectionAreaClass TSubclassOf< UNavAreaBase > Area class for downward traversal of links generated by this configuration. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
FilterDistanceThreshold float When filtering similar links, it's the distance used to compare between segment endpoints to match similar links. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(UIMin=0, ClampMin=0)
FirstAvailableFlag const uint8 Make your game-specific flags start at this index NavMesh/RecastNavMesh.h  
GenerateCorridor const int32 If set, path will contain navigation corridor. NavMesh/RecastNavMesh.h  
JumpDistanceFromEdge float How far from the navmesh edge is the jump started. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(UIMin=0, ClampMin=0)
JumpEndsHeightTolerance float Tolerance at both ends of the jump to find ground. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(UIMin=0, ClampMin=0)
JumpHeight float Peak height relative to the height of the starting point. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(UIMin=0, ClampMin=0)
JumpLength float Horizontal length of the jump. How far from the starting point we will look for ground. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(UIMin=0, ClampMin=0)
JumpMaxDepth float How far below the starting height we want to look for landing ground. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(UIMin=0, ClampMin=0)
LinkBuilderFlags uint16 Flags used to indicate how links will be added. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(Bitmask, BitmaskEnum="/Script/NavigationSystem.ENavLinkBuilderFlags")
LinkProxy TObjectPtr< UBaseGeneratedNavLinksProxy > Current proxy. NavMesh/LinkGenerationConfig.h
  • Transient
LinkProxyClass TSubclassOf< UBaseGeneratedNavLinksProxy > Class used to handle links made with this configuration. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Category=Settings
LinkProxyId FNavLinkId Identifier used identify the current proxy handler. NavMesh/LinkGenerationConfig.h  
PathNodeBoxExtent const FVector   NavigationSystem.h  
SamplingSeparationFactor float Value multiplied by CellSize to find the distance between sampling trajectories. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings
  • Meta=(UIMin=1, ClampMin=1)
SkipStringPulling const int32 If set, path won't be post processed. NavMesh/RecastNavMesh.h  
UpDirectionAreaClass TSubclassOf< UNavAreaBase > Area class for upward traversal of links generated by this configuration. NavMesh/LinkGenerationConfig.h
  • EditAnywhere
  • Config
  • Category=Settings

Functions

Public

Name Remarks Include Path Unreal Specifiers

~FNavLinkGenerationJumpDownConfig()

 Note: We need to explicitly disable warnings on these constructors/operators for clang to be happy with deprecated variables. NavMesh/LinkGenerationConfig.h  

ENUM_CLASS_FLAGS ( ELinkGenerationDebugFlags
)

   NavMesh/LinkGenerationDebugFlags.h  

FNavLinkGenerationJumpDownConfig ( const FNavLinkGenerationJumpDownConfig&
)

   NavMesh/LinkGenerationConfig.h  

FNavLinkGenerationJumpDownConfig ( FNavLinkGenerationJumpDownConfig&&
)

   NavMesh/LinkGenerationConfig.h  

void NavigationHelper::GatherCollision ( UBodySetup* RigidBody,
TNavStatArray< FVector >& OutVertexBuffer,
TNavStatArray< int32 >& OutIndexBuffer,
const FTransform& ComponentToWorld
)

   NavigationSystemTypes.h  

bool operator! ( ENavLinkBuilderFlags E
)

   NavMesh/LinkGenerationConfig.h  
  NavMesh/LinkGenerationConfig.h  
  NavMesh/LinkGenerationConfig.h  
  NavMesh/LinkGenerationConfig.h  
  NavMesh/LinkGenerationConfig.h  
  NavMesh/LinkGenerationConfig.h  
  NavMesh/LinkGenerationConfig.h  
  NavMesh/LinkGenerationConfig.h  

FNavLinkGenerationJumpDownConfig & operator= ( const FNavLinkGenerationJumpDownConfig&
)

   NavMesh/LinkGenerationConfig.h  

FNavLinkGenerationJumpDownConfig & operator= ( FNavLinkGenerationJumpDownConfig&&
)

   NavMesh/LinkGenerationConfig.h  

FBox Recast2UnrealBox ( const FBox& RecastBox
)

   NavMesh/RecastHelpers.h  

FBox Recast2UnrealBox ( const FVector::FReal* RecastMin,
const FVector::FReal* RecastMax
)

   NavMesh/RecastHelpers.h  

FColor Recast2UnrealColor ( const unsigned int RecastColor
)

   NavMesh/RecastHelpers.h  

FMatrix Recast2UnrealMatrix()

   NavMesh/RecastHelpers.h  

FVector Recast2UnrealPoint ( const FVector::FReal* RecastPoint
)

   NavMesh/RecastHelpers.h  

FVector Recast2UnrealPoint ( const FVector& RecastPoint
)

   NavMesh/RecastHelpers.h  

bool Serialize ( FArchive& Ar
)

 Implemented for deprecated property cleanup purposes. NavMesh/LinkGenerationConfig.h  

FBox Unreal2RecastBox ( const FBox& UnrealBox
)

   NavMesh/RecastHelpers.h  

FMatrix Unreal2RecastMatrix()

   NavMesh/RecastHelpers.h  

FVector Unreal2RecastPoint ( const FVector::FReal* UnrealPoint
)

 Coord system utilities NavMesh/RecastHelpers.h  

FVector Unreal2RecastPoint ( const FVector& UnrealPoint
)

   NavMesh/RecastHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page