UEnvQueryTest

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AIModule

Header

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

Include

#include "EnvironmentQuery/EnvQueryTest.h"

Syntax

class UEnvQueryTest : public UEnvQueryNode

Variables

Name Description

Public variable

bool

 

bDefineReferenceValue

When set to true enables usage of ReferenceValue. It's false by default

Public variable

FAIDataProvider...

 

BoolValue

Desired boolean value of the test for scoring to occur or filtering test to pass.

Public variable

TEnumAsByte< EE...

 

ClampMaxType

How should the upper bound for normalization of the raw test value before applying the scoring formula be determined? Should it use the highest value found (tested), the upper threshold for filtering, or a separate specified normalization maximum?

Public variable

TEnumAsByte< EE...

 

ClampMinType

How should the lower bound for normalization of the raw test value before applying the scoring formula be determined? Should it use the lowest value found (tested), the lower threshold for filtering, or a separate specified normalization minimum?

Public variable

TEnumAsByte< EE...

 

Cost

Cost of test

Public variable

TEnumAsByte< EE...

 

FilterType

Does this test filter out results that are below a lower limit, above an upper limit, or both? Or does it just look for a matching value?

Public variable

FAIDataProvider...

 

FloatValueMax

Maximum limit (inclusive) of valid values for the raw test value.

Public variable

FAIDataProvider...

 

FloatValueMin

Minimum limit (inclusive) of valid values for the raw test value.

Public variable

TEnumAsByte< EE...

 

MultipleContextFilterOp

Determines filtering operator when context returns multiple items

Public variable

TEnumAsByte< EE...

 

MultipleContextScoreOp

Determines scoring operator when context returns multiple items

Public variable

EEQSNormalizati...

 

NormalizationType

Specifies how to determine value span used to normalize scores

Public variable

FEnvQueryTestSc...

 

PreviewData

Samples of scoring function to show on graph in editor

Public variable

FAIDataProvider...

 

ReferenceValue

When specified gets used to normalize test's results in such a way that the closer a value is to ReferenceValue the higher normalized result it will produce.

Public variable

FAIDataProvider...

 

ScoreClampMax

Maximum value to use to normalize the raw test value before applying scoring formula.

Public variable

FAIDataProvider...

 

ScoreClampMin

Minimum value to use to normalize the raw test value before applying scoring formula.

Public variable

TEnumAsByte< EE...

 

ScoringEquation

The shape of the curve equation to apply to the normalized score before multiplying by factor.

Public variable

FAIDataProvider...

 

ScoringFactor

The weight (factor) by which to multiply the normalized score after the scoring equation is applied.

Public variable

FString

 

TestComment

Optional comment or explanation about what this test is for.

Public variable

int32

 

TestOrder

Number of test as defined in data asset

Public variable

TEnumAsByte< EE...

 

TestPurpose

The purpose of this test. Should it be used for filtering possible results, scoring them, or both?

Public variable

TSubclassOf< UE...

 

ValidItemType

Validation: item type that can be used with this test

Constructors

Name Description

Public function

UEnvQueryTest

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

bool

 

CanRunAsFinalCondition()

Public function Const

FText

 

DescribeBoolTestParams

(
    const FString& ConditionDesc
)

Public function Const

FText

 

DescribeFloatTestParams()

Public function Const

AActor *

 

GetItemActor

(
    FEnvQueryInstance& QueryInstance,
    const FEnvQueryInstance::ItemIterat...
)

Helper: get actor from item

Public function Const

AActor *

 

GetItemActor

(
    FEnvQueryInstance& QueryInstance,
    int32 ItemIndex
)

Helper: get actor from item

Public function Const

FVector

 

GetItemLocation

(
    FEnvQueryInstance& QueryInstance,
    const FEnvQueryInstance::ItemIterat...
)

Helper: get location of item

Public function Const

FVector

 

GetItemLocation

(
    FEnvQueryInstance& QueryInstance,
    int32 ItemIndex
)

Helper: get location of item

Public function Const

FRotator

 

GetItemRotation

(
    FEnvQueryInstance& QueryInstance,
    int32 ItemIndex
)

Helper: get location of item

Public function Const

FRotator

 

GetItemRotation

(
    FEnvQueryInstance& QueryInstance,
    const FEnvQueryInstance::ItemIterat...
)

Helper: get location of item

Public function Const

bool

 

GetWorkOnFloatValues()

Public function Const

bool

 

IsContextPerItem

(
    TSubclassOf< UEnvQueryContext > Che...
)

Check if context needs to be updated for every item

Public function Const

bool

 

IsFiltering()

Public function Const

bool

 

IsScoring()

Public function Const

bool

 

IsSupportedItem

(
    TSubclassOf< UEnvQueryItemType > It...
)

Check if test supports item type

Public function

void

 

NormalizeItemScores

(
    FEnvQueryInstance& QueryInstance
)

Normalize scores in range

Public function Virtual Const

void

 

RunTest

(
    FEnvQueryInstance& QueryInstance
)

Function that does the actual work

Public function

void

 

SetWorkOnFloatValues

(
    bool bWorkOnFloats
)

Public function

void

 

UpdatePreviewData()

Update preview list

Overridden from UEnvQueryNode

Name Description

Public function Virtual

void

 

UpdateNodeVersion()

Update to latest version after spawning

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.