1. Epic GamesDeveloper
  3. ARecastNavMesh

ARecastNavMesh

API > API/Runtime > API/Runtime/NavigationSystem > API/Runtime/NavigationSystem/NavMesh

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Engine, defaultconfig,  
       HideCategories=(Input, Rendering, Tags, Transformation, Actor, Layers, Replication),  
       NotPlaceable, MinimalAPI)  
class ARecastNavMesh : public ANavigationData

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta Config float AgentHeight Size of the tallest agent that will path with this navmesh.
Public variable UProperty Category, EditAnywhere, Meta Config float AgentMaxSlope The maximum slope (angle) that the agent can move on.
Public variable UProperty Category, EditAnywhere, Meta Config float AgentRadius Radius of smallest agent to traverse this navmesh
Public variable UProperty Config uint32: 1 bAllowNavLinkAsPathEnd If set, paths can end at navlink poly (not the ground one!)
Protected variable UProperty uint32: 1 bAllowWorldPartitionedNavMesh World partitioned navmesh are only allowed in partitioned worlds.
Public variable UProperty Config uint32: 1 bDistinctlyDrawTilesBeingBuilt If true, show currently rebuilding tiles differently when visualizing
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bDoFullyAsyncNavDataGathering If set, navmesh data gathering will never happen on the game thread and will only be done on background threads
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawClusters Draw navmesh's clusters and cluster links. (Requires WITH_NAVMESH_CLUSTER_LINKS=1)
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bDrawDefaultPolygonCost Draw a label for every poly that indicates its default and fixed costs
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bDrawFailedNavLinks Draw failed links and valid links.
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawFilledPolys If disabled skips filling drawn navmesh polygons
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawLabelsOnPathNodes  
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawMarkedForbiddenPolys  
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawNavLinks Draw valid links (both ends are valid).
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawNavMeshEdges Draw border-edges
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawOctree Draw octree used to store navigation relevant actors
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bDrawOctreeDetails Draw octree used to store navigation relevant actors with the elements bounds
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawPathCollidingGeometry Draw input geometry passed to the navmesh generator.
Public variable UProperty Category, EditAnywhere Config uint32: 1 bDrawPolyEdges Draw edges of every poly (i.e. not only border-edges)
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawPolygonFlags Draw a label for every poly that indicates its poly and area flags
Public variable UProperty Category, EditAnywhere, Meta uint32: 1 bDrawPolygonLabels Draw a label for every poly that indicates its poly and tile indices
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawTileBounds Draw the tile boundaries
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawTileBuildTimes  
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawTileBuildTimesHeatMap  
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawTileLabels  
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawTileResolutions Draw the tile resolutions
Public variable UProperty Category, EditAnywhere uint32: 1 bDrawTriangleEdges Draw edges of every navmesh's triangle
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bFilterLowSpanFromTileCache If set, only low height spans with corresponding area modifier will be stored in tile cache (reduces memory, can't modify without full tile rebuild)
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bFilterLowSpanSequences If set, only single low height span will be allowed under valid one
Public variable UProperty Category, EditAnywhere Config uint32: 1 bFixedTilePoolSize NavMesh generation parameters.
Public variable UProperty Category, EditAnywhere Config uint32: 1 bGenerateNavLinks Experimental: if set, navlinks will be automatically generated.
Public variable UProperty Category, EditAnywhere, Meta Config uint32: 1 bIsWorldPartitioned In a world partitioned map, is this navmesh using world partitioning
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bMarkLowHeightAreas Mark areas with insufficient free height above instead of cutting them out (accessible only for area modifiers using replace mode)
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bPerformVoxelFiltering Controls whether voxel filtering will be applied (via FRecastTileGenerator::ApplyVoxelFilter).
Public variable UProperty Category, EditAnywhere Config uint32: 1 bSortNavigationAreasByCost Controls whether Navigation Areas will be sorted by cost before application to navmesh during navmesh generation.
Public variable UProperty Config uint32: 1 bStoreEmptyTileLayers If set, tiles generated without any navmesh data will be marked to distinguish them from not generated / streamed out ones.
Public variable UProperty Config uint32: 1 bUseBetterOffsetsFromCorners TODO: switch to disable new code from OffsetFromCorners if necessary - remove it later
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32: 1 bUseExtraTopCellWhenMarkingAreas Expand the top of the area nav modifier's bounds by one cell height when applying to the navmesh.
Public variable UProperty Config uint32: 1 bUseVirtualFilters Indicates whether default navigation filters will use virtual functions. Defaults to true.
Public variable UProperty Config uint32: 1 bUseVirtualGeometryFilteringAndDirtying Indicates whether to use the virtual methods to check if an object should generate geometry or if we should call the normal method directly (i.e. FNavigationOctreeElement::ShouldUseGeometry).
Public variable UProperty Config float DefaultDrawDistance Navmesh draw distance in game (always visible in editor)
Public variable UProperty Config float DefaultMaxHierarchicalSearchNodes Specifies default limit to A* nodes used when performing hierarchical navigation queries.
Public variable UProperty Config float DefaultMaxSearchNodes Specifies default limit to A* nodes used when performing navigation queries.
Public variable UProperty Category, EditAnywhere Config float DrawOffset Vertical offset added to navmesh's debug representation for better readability
Public variable UProperty Category, EditAnywhere, Meta Config float HeuristicScale Recast runtime params.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint32 InvokerTilePriorityBumpDistanceThresholdInTileUnits If >= 1, when sorting pending tiles by priority, tiles near invokers (within the distance threshold) will have their priority increased.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config uint8 InvokerTilePriorityBumpIncrease Priority increase steps for tiles that are withing near distance.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config int32 LayerChunkSplits Number of chunk splits (along single axis) used for layer's partitioning: ChunkyMonotone
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config TEnumAsByte< ERecastPartitioning::Type > LayerPartitioning Partitioning method for creating tile layers
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config ENavigationLedgeSlopeFilterMode LedgeSlopeFilterMode Filtering methode used for filtering ledge slopes
Public variable UProperty Category, EditAnywhere, Meta Config float MaxSimplificationError How much navigable shapes can get simplified - the higher the value the more freedom
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config int32 MaxSimultaneousTileGenerationJobsCount Sets the limit for number of asynchronous tile generators running at one time, also used for some synchronous tasks
Public variable UProperty Config int MaxVerticalMergeError Maximum vertical deviation between raw contour points to allowing merging (in voxel).
Public variable UProperty Category, EditAnywhere, Meta Config float MergeRegionSize The size limit of regions to be merged with bigger regions (watershed partitioning only)
Public variable UProperty Category, EditAnywhere, Meta Config float MinRegionArea The minimum dimension of area. Areas smaller than this will be discarded
Protected variable UProperty Category, EditAnywhere Config FNavLinkGenerationJumpDownConfig NavLinkJumpDownConfig Experimental configuration to generate vertical links.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay FVector NavMeshOriginOffset Use this if you don't want your tiles to start at (0,0,0)
Public variable UProperty Category, EditAnywhere Config FNavMeshResolutionParam[(uint8) ENavigationDataResolution::MAX] NavMeshResolutionParams Resolution params If using multiple resolutions, it's recommended to chose the highest resolution first and set it according to the highest desired precision and then the other resolutions.
Public variable FOnNavMeshUpdate OnNavMeshUpdate Broadcast for navmesh updates
Public variable UProperty Category, AdvancedDisplay visibleanywhere int32 PolyRefNavPolyBits  
Public variable UProperty Category, AdvancedDisplay visibleanywhere int32 PolyRefSaltBits  
Public variable UProperty Category, AdvancedDisplay visibleanywhere int32 PolyRefTileBits  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config int32 RegionChunkSplits Number of chunk splits (along single axis) used for region's partitioning: ChunkyMonotone
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config TEnumAsByte< ERecastPartitioning::Type > RegionPartitioning Partitioning method for creating navmesh polys
Public variable UProperty Category, EditAnywhere, Meta Config float SimplificationElevationRatio When simplifying contours, how much is the vertical error taken into account when comparing with MaxSimplificationError.
Public variable UProperty Category, EditAnywhere FRecastNavMeshTileGenerationDebug TileGenerationDebug  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config int32 TileNumberHardLimit Absolute hard limit to number of navmesh tiles.
Public variable UProperty Category, EditAnywhere, Meta Config int32 TilePoolSize Maximum number of tiles NavMesh can hold
Public variable UProperty Category, EditAnywhere, Meta Config float TileSizeUU Size of single tile, expressed in uu
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta Config int32 TimeSliceFilterLedgeSpansMaxYProcess The maximum number of y coords to process when time slicing filter ledge spans during navmesh regeneration.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay Config double TimeSliceLongDurationDebug If a single time sliced section of navmesh regen code exceeds this duration then it will trigger debug logging
Public variable UProperty Category, EditAnywhere, Meta Config float VerticalDeviationFromGroundCompensation Value added to each search height to compensate for error between navmesh polys and walkable geometry

Constructors

  Type Name Description
Public function  

ARecastNavMesh ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual   Dtor

Functions

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Public function Static FVector::FReal  
Public function Static float  
Public function Const bool  
Public function Virtual Const bool

IsNodeRefValid ( NavNodeRef NodeRef
)

  
Public function UFunction BlueprintCallable, Category, Meta bool

K2_ReplaceAreaInTileBounds ( FBox Bounds,
TSubclassOf< UNavArea > OldArea,
TSubclassOf< UNavArea > NewArea,
bool ReplaceLinks
)

 Blueprint functions.
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function Static void

SetDrawDistance ( FVector::FReal NewDistance
)

  
Public function Static void  

Overridden from ANavigationData

  Type Name Description
Public function Virtual Const void

BatchProjectPoints ( TArray< FNavigationProjectionWork >& Workload,
const FVector& Extent,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Batches ProjectPoint's work for efficiency
Public function Virtual Const void

BatchProjectPoints ( TArray< FNavigationProjectionWork >& Workload,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Project batch of points using shared search filter.
Public function Virtual Const void

BatchRaycast ( TArray< FNavigationRaycastWork >& Workload,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Raycasts batched for efficiency
Public function Virtual Const ENavigationQueryResult::Type

CalcPathCost ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& OutPathCost,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Calculates path from PathStart to PathEnd and retrieves its cost.
Public function Virtual Const ENavigationQueryResult::Type

CalcPathLength ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& OutPathLength,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Calculates path from PathStart to PathEnd and retrieves its length.
Public function Virtual Const ENavigationQueryResult::Type

CalcPathLengthAndCost ( const FVector& PathStart,
const FVector& PathEnd,
FVector::FReal& OutPathLength,
FVector::FReal& OutPathCost,
FSharedConstNavQueryFilter QueryFilter,
const UObject* Querier
)

 Calculates path from PathStart to PathEnd and retrieves its length.
Public function Virtual Const bool

DoesNodeContainLocation ( NavNodeRef NodeRef,
const FVector& WorldSpaceLocation
)

 Checks if specified navigation node contains given location
Public function Virtual Const 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.
Public function Virtual Const bool

FindOverlappingEdges ( const FNavLocation& StartLocation,
TConstArrayView< FVector > ConvexPolygon,
TArray< FVector >& OutEdges,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Returns the navmesh edges that touch the convex polygon. The edges are not clipped by the polygon.
Public function Virtual Const FBox Returns bounding box for the navmesh.
Public function Virtual Const bool

GetPathSegmentBoundaryEdges ( const FNavigationPath& Path,
const FNavPathPoint& StartPoint,
const FNavPathPoint& EndPoint,
const TConstArrayView< FVector > SearchArea,
TArray< FVector >& OutEdges,
const float MaxAreaEnterCost,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Searches navmesh edges between the two path points, search up to the convex polygon described in SearchArea.
Public function Virtual Const FNavLocation

GetRandomPoint ( FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

  
Public function Virtual Const bool

GetRandomPointInNavigableRadius ( const FVector& Origin,
float Radius,
FNavLocation& OutResult,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Finds a random location in navigable space, in given Radius
Public function Virtual Const bool

GetRandomReachablePointInRadius ( const FVector& Origin,
float Radius,
FNavLocation& OutResult,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
)

 Finds a random location in Radius, reachable from Origin
Public function Virtual Const 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.

Classes

  Type Name Description
Public struct FRaycastResult    

Typedefs

Name Description
FNavPolyFlags  

Constants

Name Description
DrawDistanceSq Squared draw distance
MinimumSizeForChaosNavMeshInfluenceSq MinimumSizeForChaosNavMeshInfluence
NavLinkFlag Contains last available dtPoly's flag bit set (8th bit at the moment of writing)

Deprecated Functions

  Type Name Description
Public function  

UE_DEPRECATED ( all,
"Use NavMeshResolutionParams to set CellHeight for the different resolutions instead"
)

  
Public function  

UE_DEPRECATED ( all,
"Use NavMeshResolutionParams to set CellSize for the different resolutions instead"
)

 Note that we are not using _DEPRECATED on the following deprecated properties since it prevents the property from being serialized back which can break the process of duplicating the navmesh for PIE
Public function  

UE_DEPRECATED ( all,
"Use NavMeshResolutionParams to set AgentMaxStepHeight for the different resolutions instead"
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page