1. Epic GamesDeveloper
  3. FEnvQueryInstance

FEnvQueryInstance

API > API/Runtime > API/Runtime/AIModule

   
Name FEnvQueryInstance
Type struct
Header File /Engine/Source/Runtime/AIModule/Classes/EnvironmentQuery/EnvQueryTypes.h
Include Path #include "EnvironmentQuery/EnvQueryTypes.h"

Syntax

USTRUCT ()  
struct FEnvQueryInstance : public FEnvQueryResult

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  EnvironmentQuery/EnvQueryTypes.h  
  EnvironmentQuery/EnvQueryTypes.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FEnvQueryInstance()

   EnvironmentQuery/EnvQueryTypes.h  

Structs

Name Remarks
FConstItemIterator Note that this iterator is for read-only purposes.
FItemIterator  

Typedefs

Name Type Remarks Include Path
FNamedParamValueType float   EnvironmentQuery/EnvQueryTypes.h
ItemIterator FItemIterator   EnvironmentQuery/EnvQueryTypes.h

Constants

Name Type Remarks Include Path
bDebuggingInfoEnabled bool   EnvironmentQuery/EnvQueryTypes.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bFoundSingleResult uint8 Used to breaking from item iterator loops EnvironmentQuery/EnvQueryTypes.h  
bHasLoggedTimeLimitWarning uint8 True if this query has logged a warning that it overran the time limit EnvironmentQuery/EnvQueryTypes.h  
bIsCurrentlyRunningAsync uint8 True if current Generator or Test is running asynchronously EnvironmentQuery/EnvQueryTypes.h  
bPassOnSingleResult uint8 Set when testing final condition of an option EnvironmentQuery/EnvQueryTypes.h  
bStoreDebugInfo uint8 Set to true to store additional debug info EnvironmentQuery/EnvQueryTypes.h  
ContextCache TArray< FEnvQueryInstanceContextCacheItem > Contexts in use EnvironmentQuery/EnvQueryTypes.h
  • Transient
CurrentStepTimeLimit double If > 0 then it's how much time query has for performing current step EnvironmentQuery/EnvQueryTypes.h  
CurrentTest int32 Currently processed test (-1 = generator) EnvironmentQuery/EnvQueryTypes.h  
CurrentTestStartingItem int32 Non-zero if test run last step has been stopped mid-process. EnvironmentQuery/EnvQueryTypes.h  
DebugData FEnvQueryDebugData   EnvironmentQuery/EnvQueryTypes.h  
FinishDelegate FQueryFinishedSignature Observer's delegate EnvironmentQuery/EnvQueryTypes.h  
GenerationTimeWarningSeconds double Maximum EQS Generator duration (in seconds) before a warning is reported in non-shipping build. EnvironmentQuery/EnvQueryTypes.h  
ItemDetails TArray< FEnvQueryItemDetails > List of item details EnvironmentQuery/EnvQueryTypes.h  
ItemTypeActorCDO TObjectPtr< UEnvQueryItemType_ActorBase > Item type's CDO for actor tests EnvironmentQuery/EnvQueryTypes.h
  • Transient
ItemTypeVectorCDO TObjectPtr< UEnvQueryItemType_VectorBase > Item type's CDO for location tests EnvironmentQuery/EnvQueryTypes.h
  • Transient
Mode EEnvQueryRunMode::Type Run mode EnvironmentQuery/EnvQueryTypes.h  
NamedParams TMap< FName, FNamedParamValueType > Execution params EnvironmentQuery/EnvQueryTypes.h  
NumProcessedItems int32 Number of items processed in current step EnvironmentQuery/EnvQueryTypes.h  
NumValidItems int32 Number of valid items on list EnvironmentQuery/EnvQueryTypes.h  
Options TArray< FEnvQueryOptionInstance > List of options EnvironmentQuery/EnvQueryTypes.h
  • Transient
QueryName FString Short name of query template - friendly name for debugging EnvironmentQuery/EnvQueryTypes.h  
StartTime double Timestamp of creating query instance EnvironmentQuery/EnvQueryTypes.h  
TotalExecutionTime double Time spent executing this query EnvironmentQuery/EnvQueryTypes.h  
UniqueName FName Unique name of query template - object name EnvironmentQuery/EnvQueryTypes.h  
ValueSize uint16 Size of current value EnvironmentQuery/EnvQueryTypes.h  
World TObjectPtr< UWorld > World owning this query instance EnvironmentQuery/EnvQueryTypes.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddItemData ( typename TypeItem::FValueType ItemValue
)

   EnvironmentQuery/EnvQueryTypes.h  

void AddItemData ( TArray< TypeValue >& ItemCollection
)

   EnvironmentQuery/EnvQueryTypes.h  

void AddItemData ( FVector ItemValue
)

      

void AddItemData ( FVector ItemValue
)

 A specialization to support saving locations with navigation data already gathered EnvironmentQuery/Items/EnvQueryItemType_Point.h  

void AddItemData ( TArray< typename TypeItem::FValueType >& ItemCollection
)

 AddItemData specialization for arrays if values EnvironmentQuery/EnvQueryTypes.h  

void AddItemData ( TypeValue ItemValue
)

   EnvironmentQuery/EnvQueryTypes.h  

bool CanBatchTest()

 Check if current test can batch its calculations EnvironmentQuery/EnvQueryTypes.h  

void DecStats()

   EnvironmentQuery/EnvQueryTypes.h  

void ExecuteOneStep ( double TimeLimit
)

 Execute single step of query EnvironmentQuery/EnvQueryTypes.h  

uint32 GetAllocatedSize()

   EnvironmentQuery/EnvQueryTypes.h  

FBox GetBoundingBox()

   EnvironmentQuery/EnvQueryTypes.h  

uint32 GetContextAllocatedSize()

   EnvironmentQuery/EnvQueryTypes.h  

FString GetExecutionTimeDescription()

 Describe for logging purposes what the query spent time on EnvironmentQuery/EnvQueryTypes.h  

void IncStats()

   EnvironmentQuery/EnvQueryTypes.h  

bool IsCurrentlyRunningAsync()

   EnvironmentQuery/EnvQueryTypes.h  

bool IsInSingleItemFinalSearch()

   EnvironmentQuery/EnvQueryTypes.h  

void Log ( const FString Msg
) const

   EnvironmentQuery/EnvQueryTypes.h  

bool PrepareContext ( UClass* Context,
TArray< FRotator >& Data
)

   EnvironmentQuery/EnvQueryTypes.h  

bool PrepareContext ( UClass* Context,
FEnvQueryContextData& ContextData
)

 Update context cache EnvironmentQuery/EnvQueryTypes.h  

bool PrepareContext ( UClass* Context,
TArray< FEnvQuerySpatialData >& Data
)

 Helpers for reading spatial data from context EnvironmentQuery/EnvQueryTypes.h  

bool PrepareContext ( UClass* Context,
TArray< FVector >& Data
)

   EnvironmentQuery/EnvQueryTypes.h  

bool PrepareContext ( UClass* Context,
TArray< AActor* >& Data
)

 Helpers for reading actor data from context EnvironmentQuery/EnvQueryTypes.h  

void ReserveItemData ( int32 NumAdditionalItems
)

 Raw data operations EnvironmentQuery/EnvQueryTypes.h  

void StripRedundantData()

 Removes all runtime data that can be used for debugging (not a part of actual query result) EnvironmentQuery/EnvQueryTypes.h  

Protected

Name Remarks Include Path Unreal Specifiers

void FinalizeGeneration()

 Prepare item data after generator has finished EnvironmentQuery/EnvQueryTypes.h  

void FinalizeQuery()

 Final pass on items of finished query EnvironmentQuery/EnvQueryTypes.h  

void FinalizeTest()

 Update costs and flags after test has finished EnvironmentQuery/EnvQueryTypes.h  

void NormalizeScores()

 Normalize total score in range 0..1 EnvironmentQuery/EnvQueryTypes.h  

void PickRandomItemOfScoreAtLeast ( float MinScore
)

 Pick one of items with score equal or higher than specified EnvironmentQuery/EnvQueryTypes.h  

void PickSingleItem ( int32 ItemIndex
)

 Discard all items but one EnvironmentQuery/EnvQueryTypes.h  

void SortScores()

 Sort all scores, from highest to lowest EnvironmentQuery/EnvQueryTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page