1. Epic GamesDeveloper
  3. ARecastNavMesh

ARecastNavMesh

API > API/Runtime > API/Runtime/NavigationSystem

   
Name ARecastNavMesh
Type class
Header File /Engine/Source/Runtime/NavigationSystem/Public/NavMesh/RecastNavMesh.h
Include Path #include "NavMesh/RecastNavMesh.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ARecastNavMesh ( const FObjectInitializer& ObjectInitializer
)

   NavMesh/RecastNavMesh.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ARecastNavMesh()

 Dtor NavMesh/RecastNavMesh.h  

Structs

Name Remarks
FRaycastResult  

Typedefs

Name Type Remarks Include Path
FNavPolyFlags uint16   NavMesh/RecastNavMesh.h

Constants

Name Type Remarks Include Path
DrawDistanceSq FVector::FReal Squared draw distance NavMesh/RecastNavMesh.h
MinimumSizeForChaosNavMeshInfluenceSq float MinimumSizeForChaosNavMeshInfluence NavMesh/RecastNavMesh.h
NavLinkFlag FNavPolyFlags Contains last available dtPoly's flag bit set (8th bit at the moment of writing) NavMesh/RecastNavMesh.h

Variables

Public

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

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasNoTileData bool   NavMesh/RecastNavMesh.h  
bUseVoxelCache uint32 Cache rasterized voxels instead of just collision vertices/indices in navigation octree NavMesh/RecastNavMesh.h
  • Config
TileSetUpdateInterval float Indicates how often we will sort navigation tiles to mach players position NavMesh/RecastNavMesh.h
  • Config

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool HasValidNavmesh()

   NavMesh/RecastNavMesh.h  

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

 Blueprint functions. NavMesh/RecastNavMesh.h
  • BlueprintCallable
  • Category=NavMesh
  • Meta=(DisplayName="ReplaceAreaInTileBounds")

Overridden from ANavigationData

Name Remarks Include Path Unreal Specifiers

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

 Project batch of points using shared search filter. NavMesh/RecastNavMesh.h  

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

 Batches ProjectPoint's work for efficiency NavMesh/RecastNavMesh.h  

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

 Raycasts batched for efficiency NavMesh/RecastNavMesh.h  

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

 Calculates path from PathStart to PathEnd and retrieves its cost. NavMesh/RecastNavMesh.h  

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

 Calculates path from PathStart to PathEnd and retrieves its length. NavMesh/RecastNavMesh.h  

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

 Calculates path from PathStart to PathEnd and retrieves its length. NavMesh/RecastNavMesh.h  

virtual bool DoesNodeContainLocation ( NavNodeRef NodeRef,
const FVector& WorldSpaceLocation
) const

 Checks if specified navigation node contains given location NavMesh/RecastNavMesh.h  

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

 Returns the navmesh edges that touch the convex polygon. The edges are not clipped by the polygon. NavMesh/RecastNavMesh.h  

virtual FBox GetBounds()

 Returns bounding box for the navmesh. NavMesh/RecastNavMesh.h  

virtual 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
) const

 Searches navmesh edges between the two path points, search up to the convex polygon described in SearchArea. NavMesh/RecastNavMesh.h  

virtual FNavLocation GetRandomPoint ( FSharedConstNavQueryFilter Filter,
const UObject* Querier
) const

   NavMesh/RecastNavMesh.h  

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

 Finds a random location in navigable space, in given Radius NavMesh/RecastNavMesh.h  

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

 Finds a random location in Radius, reachable from Origin NavMesh/RecastNavMesh.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   NavMesh/RecastNavMesh.h  

virtual void Serialize ( FArchive& Ar
)

   NavMesh/RecastNavMesh.h  

Overridden from INavigationDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool FindMoveAlongSurface ( const FNavLocation& StartLocation,
const FVector& TargetPosition,
FNavLocation& OutLocation,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
) const

 Tries to move current nav location towards target constrained to navigable area. NavMesh/RecastNavMesh.h  

virtual bool IsNodeRefValid ( NavNodeRef NodeRef
) const

   NavMesh/RecastNavMesh.h  

virtual bool ProjectPoint ( const FVector& Point,
FNavLocation& OutLocation,
const FVector& Extent,
FSharedConstNavQueryFilter Filter,
const UObject* Querier
) const

 Tries to project given Point to this navigation type, within given Extent. NavMesh/RecastNavMesh.h  

Static

Name Remarks Include Path Unreal Specifiers

static FVector::FReal GetDrawDistanceSq()

   NavMesh/RecastNavMesh.h  

static float GetMinimumSizeForChaosNavMeshInfluenceSq()

   NavMesh/RecastNavMesh.h  

static void SetDrawDistance ( FVector::FReal NewDistance
)

   NavMesh/RecastNavMesh.h  

static void SetMinimumSizeForChaosNavMeshInfluence ( float NewSize
)

   NavMesh/RecastNavMesh.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page