UNavigationQueryFilter

Class containing definition of a navigation query filter

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NavigationSystem

Header

/Engine/Source/Runtime/NavigationSystem/Public/NavFilters/NavigationQueryFilter.h

Include

#include "NavFilters/NavigationQueryFilter.h"

Syntax

class UNavigationQueryFilter : public UObject

Remarks

Class containing definition of a navigation query filter

Variables

Name Description

Public variable

TArray< FNaviga...

 

Areas

List of overrides for navigation areas

Protected variable

uint32: 1

 

bInstantiateForQuerier

If set, filter will not be cached by navigation data and can be configured per Querier

Protected variable

uint32: 1

 

bIsMetaFilter

If set to true GetSimpleFilterForAgent will be called when determining the actual filter class to be used

Public variable

FNavigationFilt...

 

ExcludeFlags

Forbidden flags of navigation nodes

Public variable

FNavigationFilt...

 

IncludeFlags

Required flags of navigation nodes

Constructors

Name Description

Public function

UNavigationQueryFilter

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

AddEnteringCostOverride

(
    TSubclassOf< UNavArea > AreaClass,
    float EnteringCost
)

Protected function

void

 

AddExcludedArea

(
    TSubclassOf< UNavArea > AreaClass
)

Protected function

void

 

AddTravelCostOverride

(
    TSubclassOf< UNavArea > AreaClass,
    float TravelCost
)

Helper functions for adding area overrides

Protected function Const

int32

 

FindAreaOverride

(
    TSubclassOf< UNavArea > AreaClass
)

Find index of area data

Public function Const

FSharedConst...

 

GetQueryFilter

(
    const ANavigationData& NavData,
    const UObject* Querier
)

Get filter for given navigation data and initialize on first access

Public function Static

FSharedConst...

 

GetQueryFilter

(
    const ANavigationData& NavData,
    TSubclassOf< UNavigationQueryFilter...
)

Helper functions for accessing filter

Public function Static

FSharedConst...

 

GetQueryFilter

(
    const ANavigationData& NavData,
    TSubclassOf< UNavigationQueryFilter...
)

Public function Static

FSharedConst...

 

GetQueryFilter

(
    const ANavigationData& NavData,
    const UObject* Querier,
    TSubclassOf< UNavigationQueryFilter...
)

Get filter for given navigation data and initialize on first access

Protected function Virtual Const

TSubclassOf<...

 

GetSimpleFilterForAgent

(
    const UObject& Querier
)

Protected function Virtual Const

void

 

InitializeFilter

(
    const ANavigationData& NavData,
    const UObject* Querier,
    FNavigationQueryFilter& Filter
)

Setup filter for given navigation data, use to create custom filters

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

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