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 > Core > Misc > FTextFilterExpressionEvaluator

Light Theme

Dark Theme

FTextFilterExpressionEvaluator

Defines an expression evaluator that can be used to perform complex text filter queries

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/TextFilterExpressionEvaluator.h
Include	#include "Misc/TextFilterExpressionEvaluator.h"

Syntax

class FTextFilterExpressionEvaluator

Remarks

Defines an expression evaluator that can be used to perform complex text filter queries

Variables

	Name	Description
TOptional< Expr...	CompiledFilter	The compiled filter created from the current filter text (compiled from FilterText)
TOptional< Text...	CompiledFilterSingleBasicStringTextToken	If there is only one token that is basic string it will be stored here to avoid recompile per item compared.
ETextFilterExpr...	ExpressionEvaluatorMode	Defines whether or not the expression parser can evaluate complex expressions
TArray< FExpres...	ExpressionTokens	The filter expression tokens created from the current filter text (lexed from FilterText)
FText	FilterErrorText	The last error returned from lexing or compiling the current filter text
FText	FilterText	The the filter terms that we're currently using (compiled into CompiledFilter)
ETextFilterExpr...	FilterType	The cached complexity of the current filter terms
FExpressionGram...	Grammar
TOperatorJumpTa...	JumpTable
FTokenDefinitio...	TokenDefinitions	Expression parser
TMap< FString, ...	TokenFunctionHandlers	Mapping of function names to their callbacks

Constructors

	Name	Description
	FTextFilterExpressionEvaluator ( const ETextFilterExpressionEvaluato... )	Construction and assignment
	FTextFilterExpressionEvaluator ( const FTextFilterExpressionEvaluato... )

Destructors

	Name	Description
	~FTextFilterExpressionEvaluator()

Functions

	Name	Description
void	AddFunctionTokenCallback ( FString InFunctionName, FTokenFunctionHandler InCallback )	Helper function to add callbacks for function tokens
void	ConstructExpressionParser()	Common function to construct the expression parser
bool	EvaluateCompiledExpression ( const ExpressionParser::CompileResu..., const ITextFilterExpressionContext ..., FText* OutErrorText )	Evaluate the given compiled result, and optionally populate OutErrorText with any error information
FText	GetFilterErrorText()	Get the last error returned from lexing or compiling the current filter text
const TArray...	GetFilterExpressionTokens()	Get the filter expression tokens created from the current filter text
FText	GetFilterText()	Get the filter terms that we're currently using
ETextFilterE...	GetFilterType()	Get the complexity of the current filter terms
bool	SetFilterText ( const FText& InFilterText )	Set the filter terms to be compiled for evaluation later.
void	SetupGrammar()	Sets up grammar used for evaluation
bool	TestTextFilter ( const ITextFilterExpressionContext ... )	Test our compiled filter using the given context

Operators

		Name	Description
	FTextFilterE...	operator= ( const FTextFilterExpressionEvaluato... )

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

Take our survey

Dismiss