1. Epic GamesDeveloper
  3. FEnvQueryInstance

FEnvQueryInstance

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

Inheritance Hierarchy

References

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

Syntax

struct FEnvQueryInstance : public FEnvQueryResult

Variables

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

Constructors

  Type Name Description
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

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

 AddItemData specialization for arrays if values
Public function void

AddItemData ( typename TypeItem::FValueType ItemValue
)

  
Public function void

AddItemData ( FVector ItemValue
)

 A specialization to support saving locations with navigation data already gathered
Public function void

AddItemData ( FVector ItemValue
)

  
Public function void

AddItemData ( TypeValue ItemValue
)

  
Public function void

AddItemData ( TArray< TypeValue >& ItemCollection
)

  
Public function Const bool Check if current test can batch its calculations
Public function void  
Public function void

ExecuteOneStep ( double TimeLimit
)

 Execute single step of query
Protected function void Prepare item data after generator has finished
Protected function void Final pass on items of finished query
Protected function void Update costs and flags after test has finished
Public function Const uint32  
Public function Const FBox  
Public function Const uint32  
Public function Const FString Describe for logging purposes what the query spent time on
Public function void  
Public function Const bool  
Public function Const void

Log ( const FString Msg
)

  
Protected function void Normalize total score in range 0..1
Protected function void

PickRandomItemOfScoreAtLeast ( float MinScore
)

 Pick one of items with score equal or higher than specified
Protected function void

PickSingleItem ( int32 ItemIndex
)

 Discard all items but one
Public function bool

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

 Update context cache
Public function bool

PrepareContext ( UClass* Context,
FEnvQueryContextData& ContextData
)

 Update context cache
Public function bool Helpers for reading spatial data from context
Public function bool

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

 Update context cache
Public function bool

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

 Helpers for reading actor data from context
Public function void

ReserveItemData ( int32 NumAdditionalItems
)

 Raw data operations
Protected function void Sort all scores, from highest to lowest
Public function void Removes all runtime data that can be used for debugging (not a part of actual query result)

Classes

  Type Name Description
Public struct FConstItemIterator Note that this iterator is for read-only purposes.  
Public struct FItemIterator    

Typedefs

Name Description
FNamedParamValueType  
ItemIterator  

Constants

Name Description
bDebuggingInfoEnabled  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page