1. Epic GamesDeveloper
  3. UEnvQueryTest

UEnvQueryTest

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

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

  Type Name Description
Public variable bool bDefineReferenceValue When set to true enables usage of ReferenceValue. It's false by default
Public variable FAIDataProviderBoolValue BoolValue Desired boolean value of the test for scoring to occur or filtering test to pass.
Public variable TEnumAsByte< EEnvQueryTestClamping::Type > 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< EEnvQueryTestClamping::Type > 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< EEnvTestCost::Type > Cost Cost of test
Public variable TEnumAsByte< EEnvTestFilterType::Type > 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 FAIDataProviderFloatValue FloatValueMax Maximum limit (inclusive) of valid values for the raw test value.
Public variable FAIDataProviderFloatValue FloatValueMin Minimum limit (inclusive) of valid values for the raw test value.
Public variable TEnumAsByte< EEnvTestFilterOperator::Type > MultipleContextFilterOp Determines filtering operator when context returns multiple items
Public variable TEnumAsByte< EEnvTestScoreOperator::Type > MultipleContextScoreOp Determines scoring operator when context returns multiple items
Public variable EEQSNormalizationType NormalizationType Specifies how to determine value span used to normalize scores
Public variable FEnvQueryTestScoringPreview PreviewData Samples of scoring function to show on graph in editor
Public variable FAIDataProviderFloatValue 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 FAIDataProviderFloatValue ScoreClampMax Maximum value to use to normalize the raw test value before applying scoring formula.
Public variable FAIDataProviderFloatValue ScoreClampMin Minimum value to use to normalize the raw test value before applying scoring formula.
Public variable TEnumAsByte< EEnvTestScoreEquation::Type > ScoringEquation The shape of the curve equation to apply to the normalized score before multiplying by factor.
Public variable FAIDataProviderFloatValue 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< EEnvTestPurpose::Type > TestPurpose The purpose of this test. Should it be used for filtering possible results, scoring them, or both?
Public variable TSubclassOf< UEnvQueryItemType > ValidItemType Validation: item type that can be used with this test

Constructors

  Type Name Description
Public function  

UEnvQueryTest ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool  
Public function Const FText

DescribeBoolTestParams ( const FString& ConditionDesc
)

  
Public function Const FText  
Public function Const AActor *

GetItemActor ( FEnvQueryInstance& QueryInstance,
const FEnvQueryInstance::ItemIterator& Iterator
)

 Helper: get actor from item
Public function Const AActor *

GetItemActor ( FEnvQueryInstance& QueryInstance,
int32 ItemIndex
)

 Helper: get actor from item
Public function Const FVector 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 Helper: get location of item
Public function Const bool  
Public function Const bool Check if context needs to be updated for every item
Public function Const bool  
Public function Const bool  
Public function Const bool Check if test supports item type
Public function void 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 Update preview list

Overridden from UEnvQueryNode

  Type Name Description
Public function Virtual void Update to latest version after spawning

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page