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 > AIModule > EnvironmentQuery > UEnvQueryManager

Light Theme

Dark Theme

UEnvQueryManager

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAISubsystem

UEnvQueryManager

References

Module	AIModule
Header	/Engine/Source/Runtime/AIModule/Classes/EnvironmentQuery/EnvQueryManager.h
Include	#include "EnvironmentQuery/EnvQueryManager.h"

Syntax

class UEnvQueryManager :
public UAISubsystem,
public FSelfRegisteringExec

Variables

	Name	Description
bool	bTestQueriesUsingBreadth	Whether we update EQS queries based on: running a test on one query and move to the next (breadth) - default behavior, or test an entire query before moving to the next one (depth).
FEQSDebugger	EQSDebugger
TMap< int32, TW...	ExternalQueries	Queries run independently from manager, mapped here for data providers
TArray< UEnvQue...	GCShieldedWrappers
TArray< FEnvQue...	InstanceCache	Cache of instances
TMap< FName, UE...	LocalContextMap	Local contexts mapped by class names
TArray< UEnvQue...	LocalContexts	Local cache of context objects for managing BP based objects
float	MaxAllowedTestingTime	How long are we allowed to test per update, in seconds.
int32	NextQueryID	Next ID for running query
int32	NumRunningQueriesAbortedSinceLastUpdate	Count of queries aborted since last update, to be removed.
double	QueryCountWarningInterval	How often (in seconds) we will warn about the number of queries (allows us to catch multiple occurrences in a session)
int32	QueryCountWarningThreshold	If greater than zero, we will warn once when the number of queries is greater than or equal to this number, and log the queries out
TArray< TShared...	RunningQueries	Currently running queries
friend	UEnvQueryInstanceBlueprintWrapper

Constructors

	Name	Description
	UEnvQueryManager ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	AbortQuery ( int32 RequestID )	Aborts specific query
TSharedPtr< ...	CreateQueryInstance ( const UEnvQuery* Template, EEnvQueryRunMode::Type RunMode )	Create new instance, using cached data is possible
float	FindNamedParam ( int32 QueryId, FName ParamName )	Find value of named param stored with active query
TSharedPtr< ...	FindQueryInstance ( const int32 QueryID )
UEnvQuery &#...	FindQueryTemplate ( const FString& QueryName )	Finds UEnvQuery matching QueryName by first looking at instantiated queries (from InstanceCache) falling back to looking up all UEnvQuery and testing their name
UEnvQueryMan...	GetCurrent ( const UObject* WorldContextObj... )
UEnvQueryMan...	GetCurrent ( UWorld* World )
FEQSDebugger...	GetDebugger()
void	NotifyAssetUpdate ( UEnvQuery* Query )
void	OnWorldCleanup()	Fail all running queries on cleaning the world
UEnvQueryCon...	PrepareLocalContext ( TSubclassOf< UEnvQueryContext > Con... )	Creates local context object
TSharedPtr< ...	PrepareQueryInstance ( const FEnvQueryRequest& Request, EEnvQueryRunMode::Type RunMode )	Creates a query instance configured for execution
void	PrintActiveQueryInfo()	Outputs active queries to log
void	RegisterActiveWrapper ( UEnvQueryInstanceBlueprintWrapper&... )
void	RegisterExternalQuery ( const TSharedPtr< FEnvQueryInstance... )	Add information for data providers about query instance run independently
void	RemoveAllQueriesByQuerier ( const UObject& Querier, bool bExecuteFinishDelegate )
UEnvQueryIns...	RunEQSQuery ( UObject* WorldContextObject, UEnvQuery* QueryTemplate, UObject* Querier, TEnumAsByte< EEnvQueryRunMode::Type..., TSubclassOf< UEnvQueryInstanceBluep... )
void	RunInstantQuery ( const TSharedPtr< FEnvQueryInstance... )	Alternative way to run queries.
TSharedPtr< ...	RunInstantQuery ( const FEnvQueryRequest& Request, EEnvQueryRunMode::Type RunMode )	Alternative way to run queries.
int32	RunQuery ( const TSharedPtr< FEnvQueryInstance..., FQueryFinishedSignature const& Fin... )	Execute query
int32	RunQuery ( const FEnvQueryRequest& Request, EEnvQueryRunMode::Type RunMode, FQueryFinishedSignature const& Fin... )	Execute query
void	SetAllowTimeSlicing ( bool bAllowTimeSlicing )
void	SilentlyRemoveAllQueriesByQuerier ( const UObject& Querier )	Removed all active queries asked by Querier.
void	UnregisterActiveWrapper ( UEnvQueryInstanceBlueprintWrapper&... )
void	UnregisterExternalQuery ( const TSharedPtr< FEnvQueryInstance... )	Clear information about query instance run independently

Overridden from UObject

	Name	Description
void	FinishDestroy()	Cleanup hooks for map loading
bool	IsDestructionThreadSafe()	Called during garbage collection to determine if an object can have its destructor called on a worker thread.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Makes sure we don't have any UEnvQueryManager instances serialized in.

Overridden from FTickableObjectBase

		Name	Description
	TStatId	GetStatId()	Return the stat id to use for this tickable
	void	Tick ( float DeltaTime )	FTickableGameObject begin.

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Constants

Name	Description
bAllowEQSTimeSlicing
DebuggerStats
RegisteredItemTypes	List of all known item types

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

Take our survey

Dismiss