Overview

Neighbor queries find k neighbors of each entity. The image below shows a SteeringSystemAsset with one group of neighbor behaviors. The selected neighbor query here is KDTreeKNNJobWrapper. It finds at most MaxNumNeighbors of neighbors which are less than MaxNeighborDistance units away. MaxFOV can be used to specify the field of view of each entity. In this case, the query only considers entities with _6_SampleBehaviorsTagComponent, here it's the same tag as the Main Tag, but generally they can be different. It is also possible to add more tags. In that case a potential neighbor must have at least one of these tags.

Image of a SteeringSystemAsset from the flocking sample. KDTreeKNNJobWrapper is selected as implementation of neighbor query which will search among entities tagged with _6_SampleBehaviorsTagComponent.

Video showing a neighbor query visualized. The connections show neighbor relationships. The radii show the maximum distance to consider a neighbor.

tip

DebugNeighborsJobWrapper can help to visualize a neighbor query, as in the video.