Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Navmesh > Detour > dtNavMeshQuery > dtNavMeshQuery::queryPolygons

Light Theme

Dark Theme

dtNavMeshQuery::queryPolygons

Finds polygons that overlap the search box.

Windows

MacOS

Linux

References

Module	Navmesh
Header	/Engine/Source/Runtime/Navmesh/Public/Detour/DetourNavMeshQuery.h
Include	#include "Detour/DetourNavMeshQuery.h"
Source	/Engine/Source/Runtime/Navmesh/Private/Detour/DetourNavMeshQuery.cpp

Syntax

dtStatus queryPolygons
(
    const float * center,
    const float * extents,
    const dtQueryFilter * filter,
    dtPolyRef * polys,
    int * polyCount,
    const int maxPolys
) const

Remarks

Finds polygons that overlap the search box.

If no polygons are found, the function will return #DT_SUCCESS with a `polyCount_ of zero.

If `polys_ is too small to hold the entire result set, then the array will be filled to capacity. The method of choosing which polygons from the full set are included in the partial result set is undefined.

Returns

The status flags for the query.

Parameters

Parameter	Description
center	The center of the search box. [(x, y, z)]
extents	The search distance along each axis. [(x, y, z)]
filter	The polygon filter to apply to the query.
polys	The reference ids of the polygons that overlap the query box.
polyCount	The number of polygons in the search result.
maxPolys	The maximum number of polygons the search result can hold.

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

Take our survey

Dismiss