1. Epic GamesDeveloper
  3. UEnvQueryTest

UEnvQueryTest

API > API/Runtime > API/Runtime/AIModule

   
Name UEnvQueryTest
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/EnvironmentQuery/EnvQueryTest.h
Include Path #include "EnvironmentQuery/EnvQueryTest.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UEnvQueryTest : public UEnvQueryNode

Inheritance Hierarchy

Derived Classes

UEnvQueryTest derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UEnvQueryTest ( const FObjectInitializer& ObjectInitializer
)

   EnvironmentQuery/EnvQueryTest.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDefineReferenceValue bool When set to true enables usage of ReferenceValue. It's false by default EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
  • Meta=(InlineEditConditionToggle)
BoolValue FAIDataProviderBoolValue Desired boolean value of the test for scoring to occur or filtering test to pass. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Filter
ClampMaxType TEnumAsByte< EEnvQueryTestClamping::Type > 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? EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
ClampMinType TEnumAsByte< EEnvQueryTestClamping::Type > 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? EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
Cost TEnumAsByte< EEnvTestCost::Type > Cost of test EnvironmentQuery/EnvQueryTest.h  
FilterType TEnumAsByte< EEnvTestFilterType::Type > 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? EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Filter
FloatValueMax FAIDataProviderFloatValue Maximum limit (inclusive) of valid values for the raw test value. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Filter
FloatValueMin FAIDataProviderFloatValue Minimum limit (inclusive) of valid values for the raw test value. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Filter
MultipleContextFilterOp TEnumAsByte< EEnvTestFilterOperator::Type > Determines filtering operator when context returns multiple items EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Filter
  • AdvancedDisplay
MultipleContextScoreOp TEnumAsByte< EEnvTestScoreOperator::Type > Determines scoring operator when context returns multiple items EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
  • AdvancedDisplay
NormalizationType EEQSNormalizationType Specifies how to determine value span used to normalize scores EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
PreviewData FEnvQueryTestScoringPreview Samples of scoring function to show on graph in editor EnvironmentQuery/EnvQueryTest.h  
ReferenceValue FAIDataProviderFloatValue 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. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
  • Meta=(EditCondition="bDefineReferenceValue")
ScoreClampMax FAIDataProviderFloatValue Maximum value to use to normalize the raw test value before applying scoring formula. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
ScoreClampMin FAIDataProviderFloatValue Minimum value to use to normalize the raw test value before applying scoring formula. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
ScoringEquation TEnumAsByte< EEnvTestScoreEquation::Type > The shape of the curve equation to apply to the normalized score before multiplying by factor. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
ScoringFactor FAIDataProviderFloatValue The weight (factor) by which to multiply the normalized score after the scoring equation is applied. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Score
  • Meta=(ClampMin="0.001", UIMin="0.001")
TestComment FString Optional comment or explanation about what this test is for. EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Test
TestOrder int32 Number of test as defined in data asset EnvironmentQuery/EnvQueryTest.h  
TestPurpose TEnumAsByte< EEnvTestPurpose::Type > The purpose of this test. Should it be used for filtering possible results, scoring them, or both? EnvironmentQuery/EnvQueryTest.h
  • EditDefaultsOnly
  • Category=Test
ValidItemType TSubclassOf< UEnvQueryItemType > Validation: item type that can be used with this test EnvironmentQuery/EnvQueryTest.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bWorkOnFloatValues uint32 When set, test operates on float values (e.g. distance, with AtLeast, UpTo conditions), otherwise it will accept bool values (e.g. visibility, with Equals condition) EnvironmentQuery/EnvQueryTest.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanRunAsFinalCondition()

   EnvironmentQuery/EnvQueryTest.h  

FText DescribeBoolTestParams ( const FString& ConditionDesc
) const

   EnvironmentQuery/EnvQueryTest.h  

FText DescribeFloatTestParams()

   EnvironmentQuery/EnvQueryTest.h  

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

 Helper: get actor from item EnvironmentQuery/EnvQueryTest.h  

AActor * GetItemActor ( FEnvQueryInstance& QueryInstance,
int32 ItemIndex
) const

 Helper: get actor from item EnvironmentQuery/EnvQueryTest.h  

FVector GetItemLocation ( FEnvQueryInstance& QueryInstance,
const FEnvQueryInstance::ItemIterator& Iterator
) const

 Helper: get location of item EnvironmentQuery/EnvQueryTest.h  

FVector GetItemLocation ( FEnvQueryInstance& QueryInstance,
int32 ItemIndex
) const

 Helper: get location of item EnvironmentQuery/EnvQueryTest.h  

FRotator GetItemRotation ( FEnvQueryInstance& QueryInstance,
int32 ItemIndex
) const

 Helper: get location of item EnvironmentQuery/EnvQueryTest.h  

FRotator GetItemRotation ( FEnvQueryInstance& QueryInstance,
const FEnvQueryInstance::ItemIterator& Iterator
) const

 Helper: get location of item EnvironmentQuery/EnvQueryTest.h  

bool GetWorkOnFloatValues()

   EnvironmentQuery/EnvQueryTest.h  

bool IsContextPerItem ( TSubclassOf< UEnvQueryContext > CheckContext
) const

 Check if context needs to be updated for every item EnvironmentQuery/EnvQueryTest.h  

bool IsFiltering()

   EnvironmentQuery/EnvQueryTest.h  

bool IsScoring()

   EnvironmentQuery/EnvQueryTest.h  

bool IsSupportedItem ( TSubclassOf< UEnvQueryItemType > ItemType
) const

 Check if test supports item type EnvironmentQuery/EnvQueryTest.h  

void NormalizeItemScores ( FEnvQueryInstance& QueryInstance
)

 Normalize scores in range EnvironmentQuery/EnvQueryTest.h  

virtual void RunTest ( FEnvQueryInstance& QueryInstance
) const

 Function that does the actual work EnvironmentQuery/EnvQueryTest.h  

void SetWorkOnFloatValues ( bool bWorkOnFloats
)

   EnvironmentQuery/EnvQueryTest.h  

void UpdatePreviewData()

 Update preview list EnvironmentQuery/EnvQueryTest.h  

Overridden from UEnvQueryNode

Name Remarks Include Path Unreal Specifiers

virtual void UpdateNodeVersion()

 Update to latest version after spawning EnvironmentQuery/EnvQueryTest.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   EnvironmentQuery/EnvQueryTest.h  

virtual void PostLoad()

   EnvironmentQuery/EnvQueryTest.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page