1. Epic GamesDeveloper
  3. UEnvQueryManager

UEnvQueryManager

API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/EnvironmentQuery

Inheritance Hierarchy

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

  Type Name Description
Protected variable 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).
Protected variable FEQSDebugger EQSDebugger  
Protected variable double ExecutionTimeWarningSeconds Maximum EQS execution duration (in seconds) before a warning is reported.
Protected variable TMap< int32, TWeakPtr< FEnvQueryInstance > > ExternalQueries Queries run independently from manager, mapped here for data providers
Protected variable TArray< TObjectPtr< UEnvQueryInstanceBlueprintWrapper > > GCShieldedWrappers  
Protected variable double GenerationTimeWarningSeconds Maximum EQS Generator duration (in seconds) before a warning is reported.
Protected variable double HandlingResultTimeWarningSeconds Maximum EQS Query FinishDelegate duration (in seconds) before a warning is reported.
Protected variable TArray< FEnvQueryInstanceCache > InstanceCache Cache of instances
Protected variable TMap< FName, UEnvQueryContext * > LocalContextMap Local contexts mapped by class names
Protected variable TArray< TObjectPtr< UEnvQueryContext > > LocalContexts Local cache of context objects for managing BP based objects
Protected variable float MaxAllowedTestingTime How long are we allowed to test per update, in seconds.
Protected variable int32 NextQueryID Next ID for running query
Protected variable int32 NumRunningQueriesAbortedSinceLastUpdate Count of queries aborted since last update, to be removed.
Protected variable double QueryCountWarningInterval How often (in seconds) we will warn about the number of queries (allows us to catch multiple occurrences in a session)
Protected variable 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
Protected variable TArray< TSharedPtr< FEnvQueryInstance > > RunningQueries Currently running queries
Protected variable friend UEnvQueryInstanceBlueprintWrapper  

Constructors

  Type Name Description
Public function  

UEnvQueryManager ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool

AbortQuery ( int32 RequestID
)

 Aborts specific query
Public function void

Configure ( const FEnvQueryManagerConfig& NewConfig
)

 Configure config variables during runtime
Protected function TSharedPtr< FEnvQueryInstance > Create new instance, using cached data is possible
Public function Const float

FindNamedParam ( int32 QueryId,
FName ParamName
)

 Find value of named param stored with active query
Protected function TSharedPtr< FEnvQueryInstance >

FindQueryInstance ( const int32 QueryID
)

  
Public function Const 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
Public function Static UEnvQueryManager *

GetCurrent ( UWorld* World
)

  
Public function Static UEnvQueryManager *

GetCurrent ( const UObject* WorldContextObject
)

  
Public function FEQSDebugger &  
Public function Static void  
Public function Virtual void Fail all running queries on cleaning the world
Public function UEnvQueryContext * Creates local context object
Public function TSharedPtr< FEnvQueryInstance > Creates a query instance configured for execution
Public function Const void Outputs active queries to log
Public function void  
Public function void

RegisterExternalQuery ( const TSharedPtr< FEnvQueryInstance >& QueryInstance
)

 Add information for data providers about query instance run independently
Public function void

RemoveAllQueriesByQuerier ( const UObject& Querier,
bool bExecuteFinishDelegate
)

  
Public function Static UEnvQueryInstanceBlueprintWrapper *

RunEQSQuery ( UObject* WorldContextObject,
UEnvQuery* QueryTemplate,
UObject* Querier,
TEnumAsByte< EEnvQueryRunMode::Type > RunMode,
TSubclassOf< UEnvQueryInstanceBlueprintWrapper > WrapperClass
)

  
Public function void

RunInstantQuery ( const TSharedPtr< FEnvQueryInstance >& QueryInstance
)

 Alternative way to run queries.
Public function TSharedPtr< FEnvQueryResult > Alternative way to run queries.
Public function int32

RunQuery ( const TSharedPtr< FEnvQueryInstance >& QueryInstance,
FQueryFinishedSignature const& FinishDelegate
)

 Execute query
Public function int32

RunQuery ( const FEnvQueryRequest& Request,
EEnvQueryRunMode::Type RunMode,
FQueryFinishedSignature const& FinishDelegate
)

 Execute query
Public function Static void

SetAllowTimeSlicing ( bool bAllowTimeSlicing
)

  
Public function void Removed all active queries asked by Querier.
Public function void  
Public function void Clear information about query instance run independently

Overridden from UObject

  Type Name Description
Public function Virtual void Cleanup hooks for map loading
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Makes sure we don't have any UEnvQueryManager instances serialized in.

Overridden from FTickableGameObject

  Type Name Description
Public function Virtual Const bool Used to determine whether the object should be ticked in the editor.

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual void

Tick ( float DeltaTime
)

 FTickableGameObject begin.

Overridden from FExec

  Type Name Description
Protected function Virtual bool

Exec_Dev ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 Implementation of Exec that is only called in non-shipping targets

Constants

Name Description
bAllowEQSTimeSlicing  
DebuggerStats  
RegisteredItemTypes List of all known item types

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page