Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AIModule > EnvironmentQuery > UEnvQueryTest

Light Theme

Dark Theme

UEnvQueryTest

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEnvQueryNode

UEnvQueryTest

UEnvQueryTest_Distance

UEnvQueryTest_Dot

UEnvQueryTest_GameplayTags

UEnvQueryTest_Overlap

UEnvQueryTest_Pathfinding

UEnvQueryTest_PathfindingBatch

UEnvQueryTest_Project

UEnvQueryTest_Random

UEnvQueryTest_Trace

UEnvQueryTest_Volume

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
bool	bDefineReferenceValue	When set to true enables usage of ReferenceValue. It's false by default
FAIDataProvider...	BoolValue	Desired boolean value of the test for scoring to occur or filtering test to pass.
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?
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?
TEnumAsByte< EE...	Cost	Cost of test
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?
FAIDataProvider...	FloatValueMax	Maximum limit (inclusive) of valid values for the raw test value.
FAIDataProvider...	FloatValueMin	Minimum limit (inclusive) of valid values for the raw test value.
TEnumAsByte< EE...	MultipleContextFilterOp	Determines filtering operator when context returns multiple items
TEnumAsByte< EE...	MultipleContextScoreOp	Determines scoring operator when context returns multiple items
EEQSNormalizati...	NormalizationType	Specifies how to determine value span used to normalize scores
FEnvQueryTestSc...	PreviewData	Samples of scoring function to show on graph in editor
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.
FAIDataProvider...	ScoreClampMax	Maximum value to use to normalize the raw test value before applying scoring formula.
FAIDataProvider...	ScoreClampMin	Minimum value to use to normalize the raw test value before applying scoring formula.
TEnumAsByte< EE...	ScoringEquation	The shape of the curve equation to apply to the normalized score before multiplying by factor.
FAIDataProvider...	ScoringFactor	The weight (factor) by which to multiply the normalized score after the scoring equation is applied.
FString	TestComment	Optional comment or explanation about what this test is for.
int32	TestOrder	Number of test as defined in data asset
TEnumAsByte< EE...	TestPurpose	The purpose of this test. Should it be used for filtering possible results, scoring them, or both?
TSubclassOf< UE...	ValidItemType	Validation: item type that can be used with this test

Constructors

	Name	Description
	UEnvQueryTest ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	CanRunAsFinalCondition()
FText	DescribeBoolTestParams ( const FString& ConditionDesc )
FText	DescribeFloatTestParams()
AActor *	GetItemActor ( FEnvQueryInstance& QueryInstance, const FEnvQueryInstance::ItemIterat... )	Helper: get actor from item
AActor *	GetItemActor ( FEnvQueryInstance& QueryInstance, int32 ItemIndex )	Helper: get actor from item
FVector	GetItemLocation ( FEnvQueryInstance& QueryInstance, const FEnvQueryInstance::ItemIterat... )	Helper: get location of item
FVector	GetItemLocation ( FEnvQueryInstance& QueryInstance, int32 ItemIndex )	Helper: get location of item
FRotator	GetItemRotation ( FEnvQueryInstance& QueryInstance, int32 ItemIndex )	Helper: get location of item
FRotator	GetItemRotation ( FEnvQueryInstance& QueryInstance, const FEnvQueryInstance::ItemIterat... )	Helper: get location of item
bool	GetWorkOnFloatValues()
bool	IsContextPerItem ( TSubclassOf< UEnvQueryContext > Che... )	Check if context needs to be updated for every item
bool	IsFiltering()
bool	IsScoring()
bool	IsSupportedItem ( TSubclassOf< UEnvQueryItemType > It... )	Check if test supports item type
void	NormalizeItemScores ( FEnvQueryInstance& QueryInstance )	Normalize scores in range
void	RunTest ( FEnvQueryInstance& QueryInstance )	Function that does the actual work
void	SetWorkOnFloatValues ( bool bWorkOnFloats )
void	UpdatePreviewData()	Update preview list

Overridden from UEnvQueryNode

		Name	Description
	void	UpdateNodeVersion()	Update to latest version after spawning

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss