FEnvQueryInstance

Windows
MacOS
Linux

Inheritance Hierarchy

FEnvQueryResult

FEnvQueryInstance

References

Module

AIModule

Header

/Engine/Source/Runtime/AIModule/Classes/EnvironmentQuery/EnvQueryTypes.h

Include

#include "EnvironmentQuery/EnvQueryTypes.h"

Syntax

struct FEnvQueryInstance : public FEnvQueryResult

Variables

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 &#...

 

ContextCache

Contexts in use

Public variable

float

 

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

FEnvQueryDebugD...

 

DebugData

Public variable

FQueryFinishedS...

 

FinishDelegate

Observer's delegate

Public variable

TArray< FEnvQue...

 

ItemDetails

List of item details

Public variable

UEnvQueryItemTy...

 

ItemTypeActorCDO

Item type's CDO for actor tests

Public variable

UEnvQueryItemTy...

 

ItemTypeVectorCDO

Item type's CDO for location tests

Public variable

EEnvQueryRunMod...

 

Mode

Run mode

Public variable

TMap< FName, FN...

 

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< FEnvQue...

 

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

float

 

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

Name Description

Public function

FEnvQueryInstance()

Public function

FEnvQueryInstance

(
    const FEnvQueryInstance& Other
)

Destructors

Name Description

Public function

~FEnvQueryInstance()

Functions

Name Description

Public function

void

 

AddItemData

(
    TArray< typename TypeItem::FValueTy...
)

AddItemData specialization for arrays if values

Public function

void

 

AddItemData

(
    typename TypeItem::FValueType ItemV...
)

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 >& ItemCollectio...
)

Public function Const

bool

 

CanBatchTest()

Check if current test can batch its calculations

Public function

void

 

DecStats()

Public function

void

 

ExecuteOneStep

(
    float TimeLimit
)

Execute single step of query

Protected function

void

 

FinalizeGeneration()

Prepare item data after generator has finished

Protected function

void

 

FinalizeQuery()

Final pass on items of finished query

Protected function

void

 

FinalizeTest()

Update costs and flags after test has finished

Public function Const

uint32

 

GetAllocatedSize()

Public function Const

FBox

 

GetBoundingBox()

Public function Const

uint32

 

GetContextAllocatedSize()

Public function Const

FString

 

GetExecutionTimeDescription()

Describe for logging purposes what the query spent time on

Public function

void

 

IncStats()

Public function Const

bool

 

IsInSingleItemFinalSearch()

Public function Const

void

 

Log

(
    const FString Msg
)

Protected function

void

 

NormalizeScores()

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

 

PrepareContext

(
    UClass* Context,
    TArray< FEnvQuerySpatialData >& Da...
)

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

 

SortScores()

Sort all scores, from highest to lowest

Public function

void

 

StripRedundantData()

Removes all runtime data that can be used for debugging (not a part of actual query result)

Classes

Name

Description

Public struct

FConstItemIterator

Note that this iterator is for read-only purposes.

Public struct

FItemIterator

Typedefs

Constants

Name

Description

bDebuggingInfoEnabled

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback